olmcatalog

Documentation

Index

• Constants
• type BundleGenerator
  • func (g BundleGenerator) Generate() error
• type PkgGenerator
  • func (g PkgGenerator) Generate() error

Constants

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

Types

type BundleGenerator

type BundleGenerator struct {
	// OperatorName is the operator's name, ex. app-operator
	OperatorName string
	OutputDir    string
	FromVersion  string
	// csvVersion is the CSV current version.
	CSVVersion string
	// These directories specify where to retrieve manifests from.
	DeployDir, ApisDir, CRDsDir string
	// InteractivePreference refers to the user preference to enable/disable
	// interactive prompts.
	InteractivePreference projutil.InteractiveLevel
	// updateCRDs directs the generator to also add CustomResourceDefinition
	// manifests to the bundle.
	UpdateCRDs bool
	// makeManifests directs the generator to use 'manifests' as the bundle
	// dir name.
	MakeManifests bool
	// contains filtered or unexported fields
}

func (BundleGenerator) Generate

func (g BundleGenerator) Generate() error

Generate allows a CSV to be written by marshalling olmapiv1alpha1.ClusterServiceVersion instead of writing to a template.

type PkgGenerator

type PkgGenerator struct {
	OperatorName string
	OutputDir    string
	// csvVersion is the version of the CSV being updated.
	CSVVersion string
	// channel is csvVersion's package manifest channel. If a new package
	// manifest is generated, this channel will be the manifest default.
	Channel string
	// If channelIsDefault is true, channel will be the package manifests'
	// default channel.
	ChannelIsDefault bool
	// contains filtered or unexported fields
}

func (PkgGenerator) Generate

func (g PkgGenerator) Generate() error