olmcatalog

Documentation

Index

• Constants
• func NewBundle(cfg gen.Config, csvVersion, fromVersion string, updateCRDs, makeManifests bool) gen.Generator
• func NewPackageManifest(cfg gen.Config, csvVersion, channel string, isDefault bool) gen.Generator

Constants

const (
	OLMCatalogChildDir = "olm-catalog"
	// OLMCatalogDir is the default location for OLM catalog directory.
	OLMCatalogDir = scaffold.DeployDir + string(filepath.Separator) + OLMCatalogChildDir

	// DeployDirKey is for the location of the operator manifests directory e.g "deploy/production"
	// The Deployment and RBAC manifests from this directory will be used to populate the CSV
	// install strategy: spec.install
	DeployDirKey = "deploy"
	// APIsDirKey is for the location of the API types directory e.g "pkg/apis"
	// The CSV annotation comments will be parsed from the types under this path.
	APIsDirKey = "apis"
	// CRDsDirKey is for the location of the CRD manifests directory e.g "deploy/crds"
	// Both the CRD and CR manifests from this path will be used to populate CSV fields
	// metadata.annotations.alm-examples for CR examples
	// and spec.customresourcedefinitions.owned for owned CRDs
	CRDsDirKey = "crds"
)

Functions

func NewBundle

func NewBundle(cfg gen.Config, csvVersion, fromVersion string, updateCRDs, makeManifests bool) gen.Generator

NewBundle creates a new bundle generator.

func NewPackageManifest

func NewPackageManifest(cfg gen.Config, csvVersion, channel string, isDefault bool) gen.Generator