bundleutil

Documentation

Index

• type BundleMetaData
  • func (meta *BundleMetaData) BuildBundleImage(tag string) error
  • func (meta *BundleMetaData) CopyOperatorManifests() error
  • func (meta *BundleMetaData) GenerateMetadata() error
  • func (meta *BundleMetaData) WriteScorecardConfig(inputConfigPath string) error

Types

type BundleMetaData

type BundleMetaData struct {
	// BundleDir refers to the directory where generated bundles are to be written.
	BundleDir string

	// The PackageName of the operator bundle.
	PackageName string

	// Channels and DefaultChannel the operator should be subscribed to.
	Channels       string
	DefaultChannel string

	// BaseImage name to build bundle image.
	BaseImage string

	// BuildCommand to run while building image.
	BuildCommand string

	// PackageManifestPath where the input manifests are present.
	PkgmanifestPath string

	// IsScoreConfigPresent when set to true includes scorecard config annotations
	// in bundle metadata.
	IsScoreConfigPresent bool

	// Other labels to be added in CSV.
	OtherLabels map[string]string
}

BundleMetaData contains the required metadata to build bundles and images.

func (*BundleMetaData) BuildBundleImage

func (meta *BundleMetaData) BuildBundleImage(tag string) error

BuildBundleImage builds the bundle image with the provided command or using docker build command.

func (*BundleMetaData) CopyOperatorManifests

func (meta *BundleMetaData) CopyOperatorManifests() error

CopyOperatorManifests copies packagemanifestsDir/manifests to bundleDir/manifests.

func (*BundleMetaData) GenerateMetadata

func (meta *BundleMetaData) GenerateMetadata() error

GenerateMetadata scaffolds annotations.yaml and bundle.Dockerfile with the provided annotation values.

func (*BundleMetaData) WriteScorecardConfig

func (meta *BundleMetaData) WriteScorecardConfig(inputConfigPath string) error

WriteScorecardConfig creates the scorecard directory in the bundle and copies the configuration yaml to bundle.