operator

Documentation

Index

• func NewCertifiedImagesCheck(imageFinder imageFinder) *certifiedImagesCheck
• func NewSecurityContextConstraintsCheck() *securityContextConstraintsInCSV
• type DeployableByOlmCheck
  • func NewDeployableByOlmCheck(indexImage, dockerConfig, channel string) *DeployableByOlmCheck
  • func (p *DeployableByOlmCheck) Help() certification.HelpText
  • func (p *DeployableByOlmCheck) Metadata() certification.Metadata
  • func (p *DeployableByOlmCheck) Name() string
  • func (p *DeployableByOlmCheck) Validate(ctx context.Context, bundleRef certification.ImageReference) (bool, error)
• type RelatedImagesCheck
  • func (p *RelatedImagesCheck) Help() certification.HelpText
  • func (p *RelatedImagesCheck) Metadata() certification.Metadata
  • func (p *RelatedImagesCheck) Name() string
  • func (p *RelatedImagesCheck) Validate(ctx context.Context, imgRef certification.ImageReference) (bool, error)
• type ScorecardBasicSpecCheck
  • func NewScorecardBasicSpecCheck(operatorSdk operatorSdk, ns, sa, kubeconfig, waittime string) *ScorecardBasicSpecCheck
  • func (p *ScorecardBasicSpecCheck) Help() certification.HelpText
  • func (p *ScorecardBasicSpecCheck) Metadata() certification.Metadata
  • func (p *ScorecardBasicSpecCheck) Name() string
  • func (p *ScorecardBasicSpecCheck) Validate(ctx context.Context, bundleRef certification.ImageReference) (bool, error)
• type ScorecardOlmSuiteCheck
  • func NewScorecardOlmSuiteCheck(operatorSdk operatorSdk, ns, sa, kubeconfig, waittime string) *ScorecardOlmSuiteCheck
  • func (p *ScorecardOlmSuiteCheck) Help() certification.HelpText
  • func (p *ScorecardOlmSuiteCheck) Metadata() certification.Metadata
  • func (p *ScorecardOlmSuiteCheck) Name() string
  • func (p *ScorecardOlmSuiteCheck) Validate(ctx context.Context, bundleRef certification.ImageReference) (bool, error)
• type ValidateOperatorBundleCheck
  • func NewValidateOperatorBundleCheck() *ValidateOperatorBundleCheck
  • func (p *ValidateOperatorBundleCheck) Help() certification.HelpText
  • func (p *ValidateOperatorBundleCheck) Metadata() certification.Metadata
  • func (p *ValidateOperatorBundleCheck) Name() string
  • func (p *ValidateOperatorBundleCheck) Validate(ctx context.Context, bundleRef certification.ImageReference) (bool, error)

Functions

func NewCertifiedImagesCheck

func NewCertifiedImagesCheck(imageFinder imageFinder) *certifiedImagesCheck

NewCertifiedImagesCheck returns a *certifiedImagesCheck that will scan the CSV and validate that all referenced images are certified.

func NewSecurityContextConstraintsCheck

func NewSecurityContextConstraintsCheck() *securityContextConstraintsInCSV

Types

type DeployableByOlmCheck

type DeployableByOlmCheck struct {
	// contains filtered or unexported fields
}

func NewDeployableByOlmCheck

func NewDeployableByOlmCheck(
	indexImage,
	dockerConfig,
	channel string,
) *DeployableByOlmCheck

NewDeployableByOlmCheck will return a check that validates if an operator is deployable by OLM. An empty dockerConfig value implies that the images in scope are public. An empty channel value implies that the check should introspect the channel from the bundle. indexImage is required.

func (*DeployableByOlmCheck) Help

func (p *DeployableByOlmCheck) Help() certification.HelpText

func (*DeployableByOlmCheck) Metadata

func (p *DeployableByOlmCheck) Metadata() certification.Metadata

func (*DeployableByOlmCheck) Name

func (p *DeployableByOlmCheck) Name() string

func (*DeployableByOlmCheck) Validate

func (p *DeployableByOlmCheck) Validate(ctx context.Context, bundleRef certification.ImageReference) (bool, error)

type RelatedImagesCheck

type RelatedImagesCheck struct{}

func (*RelatedImagesCheck) Help

func (p *RelatedImagesCheck) Help() certification.HelpText

func (*RelatedImagesCheck) Metadata

func (p *RelatedImagesCheck) Metadata() certification.Metadata

func (*RelatedImagesCheck) Name

func (p *RelatedImagesCheck) Name() string

func (*RelatedImagesCheck) Validate

func (p *RelatedImagesCheck) Validate(ctx context.Context, imgRef certification.ImageReference) (bool, error)

type ScorecardBasicSpecCheck

type ScorecardBasicSpecCheck struct {
	// contains filtered or unexported fields
}

ScorecardBasicSpecCheck evaluates the image to ensure it passes the operator-sdk scorecard check with the basic-check-spec-test suite selected.

func NewScorecardBasicSpecCheck

func NewScorecardBasicSpecCheck(operatorSdk operatorSdk, ns, sa, kubeconfig, waittime string) *ScorecardBasicSpecCheck

func (*ScorecardBasicSpecCheck) Help

func (p *ScorecardBasicSpecCheck) Help() certification.HelpText

func (*ScorecardBasicSpecCheck) Metadata

func (p *ScorecardBasicSpecCheck) Metadata() certification.Metadata

func (*ScorecardBasicSpecCheck) Name

func (p *ScorecardBasicSpecCheck) Name() string

func (*ScorecardBasicSpecCheck) Validate

func (p *ScorecardBasicSpecCheck) Validate(ctx context.Context, bundleRef certification.ImageReference) (bool, error)

type ScorecardOlmSuiteCheck

type ScorecardOlmSuiteCheck struct {
	// contains filtered or unexported fields
}

ScorecardOlmSuiteCheck evaluates the image to ensure it passes the operator-sdk scorecard check with the olm suite selected.

func NewScorecardOlmSuiteCheck

func NewScorecardOlmSuiteCheck(operatorSdk operatorSdk, ns, sa, kubeconfig, waittime string) *ScorecardOlmSuiteCheck

func (*ScorecardOlmSuiteCheck) Help

func (p *ScorecardOlmSuiteCheck) Help() certification.HelpText

func (*ScorecardOlmSuiteCheck) Metadata

func (p *ScorecardOlmSuiteCheck) Metadata() certification.Metadata

func (*ScorecardOlmSuiteCheck) Name

func (p *ScorecardOlmSuiteCheck) Name() string

func (*ScorecardOlmSuiteCheck) Validate

func (p *ScorecardOlmSuiteCheck) Validate(ctx context.Context, bundleRef certification.ImageReference) (bool, error)

type ValidateOperatorBundleCheck

type ValidateOperatorBundleCheck struct{}

ValidateOperatorBundleCheck evaluates the image and ensures that it passes bundle validation as executed by `operator-sdk bundle validate`

func NewValidateOperatorBundleCheck

func NewValidateOperatorBundleCheck() *ValidateOperatorBundleCheck

func (*ValidateOperatorBundleCheck) Help

func (p *ValidateOperatorBundleCheck) Help() certification.HelpText

func (*ValidateOperatorBundleCheck) Metadata

func (p *ValidateOperatorBundleCheck) Metadata() certification.Metadata

func (*ValidateOperatorBundleCheck) Name

func (p *ValidateOperatorBundleCheck) Name() string

func (*ValidateOperatorBundleCheck) Validate

func (p *ValidateOperatorBundleCheck) Validate(ctx context.Context, bundleRef certification.ImageReference) (bool, error)