clusterserviceversion

Documentation

Index

• Constants
• func ApplyTo(c *collector.Manifests, csv *operatorsv1alpha1.ClusterServiceVersion) error
• type Generator
  • func (g *Generator) Generate(cfg *config.Config, opts ...Option) (err error)
  • func (g *Generator) GenerateLegacy(opts ...LegacyOption) (err error)
• type LegacyOption
  • func WithBundleBase(inputDir, apisDir string, ilvl projutil.InteractiveLevel) LegacyOption
  • func WithPackageBase(inputDir, apisDir string, ilvl projutil.InteractiveLevel) LegacyOption
• type Option
  • func WithBase(inputDir, apisDir string, ilvl projutil.InteractiveLevel) Option
  • func WithBaseWriter(dir string) Option
  • func WithBundleWriter(dir string) Option
  • func WithPackageWriter(dir string) Option
  • func WithWriter(w io.Writer) Option

Constants

const (
	// WatchNamespaceEnv is a constant for internal use.
	WatchNamespaceEnv = "WATCH_NAMESPACE"
	// TargetNamespacesRef references the target namespaces a CSV is installed in.
	// This is required by legacy project Deployments.
	TargetNamespacesRef = "metadata.annotations['olm.targetNamespaces']"
)

Functions

func ApplyTo

func ApplyTo(c *collector.Manifests, csv *operatorsv1alpha1.ClusterServiceVersion) error

ApplyTo applies relevant manifests in c to csv, sorts the applied updates, and validates the result.

Types

type Generator

type Generator struct {
	// OperatorName is the operator's name, ex. app-operator.
	OperatorName string
	// OperatorType determines what code API types are written in for getBase.
	OperatorType projutil.OperatorType
	// Version is the CSV current version.
	Version string
	// FromVersion is the version of a previous CSV to upgrade from.
	FromVersion string
	// Collector holds all manifests relevant to the Generator.
	Collector *collector.Manifests
	// contains filtered or unexported fields
}

ClusterServiceVersion configures ClusterServiceVersion manifest generation.

func (*Generator) Generate

func (g *Generator) Generate(cfg *config.Config, opts ...Option) (err error)

Generate configures the generator with cfg and opts then runs it.

func (*Generator) GenerateLegacy

func (g *Generator) GenerateLegacy(opts ...LegacyOption) (err error)

GenerateLegacy configures the generator with opts then runs it. Used for generating files for legacy project layouts.

type LegacyOption

type LegacyOption Option

LegacyOption is a function that modifies a Generator for legacy project layouts.

func WithBundleBase

func WithBundleBase(inputDir, apisDir string, ilvl projutil.InteractiveLevel) LegacyOption

WithBundleBase sets a Generator's base CSV to a legacy-style bundle base.

func WithPackageBase

func WithPackageBase(inputDir, apisDir string, ilvl projutil.InteractiveLevel) LegacyOption

WithPackageBase sets a Generator's base CSV to a legacy-style package base.

type Option

type Option func(*Generator) error

Option is a function that modifies a Generator.

func WithBase

func WithBase(inputDir, apisDir string, ilvl projutil.InteractiveLevel) Option

WithBase sets a Generator's base CSV to a kustomize-style base.

func WithBaseWriter

func WithBaseWriter(dir string) Option

WithBaseWriter sets a Generator's writer to a kustomize-style base file under <dir>/bases.

func WithBundleWriter

func WithBundleWriter(dir string) Option

WithBundleWriter sets a Generator's writer to a bundle CSV file under <dir>/manifests.

func WithPackageWriter

func WithPackageWriter(dir string) Option

WithPackageWriter sets a Generator's writer to a package CSV file under <dir>/<version>.

func WithWriter

func WithWriter(w io.Writer) Option

WithWriter sets a Generator's writer to w.