operator

Documentation

Index

• func NewCheck(image, indeximage string, kubeconfig []byte, opts ...Option) *operatorCheck
• type Option
  • func WithCSVTimeout(csvTimeout time.Duration) Option
  • func WithDockerConfigJSONFromFile(path string) Option
  • func WithInsecureConnection() Option
  • func WithOperatorChannel(ch string) Option
  • func WithScorecardImage(image string) Option
  • func WithScorecardNamespace(ns string) Option
  • func WithScorecardServiceAccount(sa string) Option
  • func WithScorecardWaitTime(seconds string) Option
  • func WithSubscriptionTimeout(subscriptionTimeout time.Duration) Option

Functions

func NewCheck

func NewCheck(image, indeximage string, kubeconfig []byte, opts ...Option) *operatorCheck

NewCheck is a check runner that executes the Operator Policy.

Types

type Option

type Option = func(*operatorCheck)

func WithCSVTimeout

func WithCSVTimeout(csvTimeout time.Duration) Option

WithCSVTimeout customizes how long to wait for a ClusterServiceVersion to become healthy.

func WithDockerConfigJSONFromFile

func WithDockerConfigJSONFromFile(path string) Option

WithDockerConfigJSONFromFile is a path to credentials necessary to pull the image under tests.

func WithInsecureConnection

func WithInsecureConnection() Option

WithInsecureConnection allows for preflight to connect to an insecure registry to pull images.

func WithOperatorChannel

func WithOperatorChannel(ch string) Option

WithOperatorChannel configures the operator value to use when attempting to deploy the operator under test.

func WithScorecardImage

func WithScorecardImage(image string) Option

WithScorecardImage overrides the Operator-SDK Scorecard image value. This option should ONLY be used in disconnected environments to overcome image accessibility restrictions.

Most users should omit this option.

func WithScorecardNamespace

func WithScorecardNamespace(ns string) Option

WithScorecardNamespace configures the namespace value to use for OperatorSDK Scorecard checks.

func WithScorecardServiceAccount

func WithScorecardServiceAccount(sa string) Option

WithScorecardServiceAccount adjusts the service account used for OperatorSDK Scorecard-based checks.

func WithScorecardWaitTime

func WithScorecardWaitTime(seconds string) Option

WithScorecardWaitTime overrides the wait time passed to OperatorSDK Scorecard-based checks The seconds value should be a string representation of a number of seconds without a suffix.

func WithSubscriptionTimeout

func WithSubscriptionTimeout(subscriptionTimeout time.Duration) Option

WithSubscriptionTimeout customizes how long to wait for a subscription to become healthy.