olm

Documentation

Index

• type OLMCmd
  • func (c *OLMCmd) AddToFlagSet(fs *pflag.FlagSet)
  • func (c *OLMCmd) Cleanup() (err error)
  • func (c *OLMCmd) Run() error
• Bugs

Types

type OLMCmd

type OLMCmd struct {
	// ManifestsDir is a directory containing 1..N bundle directories and either
	// a package manifest or metadata/annotations.yaml. OperatorVersion can be
	// set to the version of the desired operator bundle and Run()/Cleanup() will
	// deploy that operator version.
	ManifestsDir string
	// OperatorVersion is the version of the operator to deploy. It must be
	// a semantic version, ex. 0.0.1.
	OperatorVersion string
	// IncludePaths are path to manifests of Kubernetes resources that either
	// supplement or override defaults generated by methods of OLMCmd. These
	// manifests can be but are not limited to: RBAC, Subscriptions,
	// CatalogSources, OperatorGroups.
	//
	// Kinds that are overridden if supplied:
	// - CatalogSource
	// - Subscription
	// - OperatorGroup
	IncludePaths []string
	// InstallMode specifies which supported installMode should be used to
	// create an OperatorGroup. The format for this field is as follows:
	//
	// "InstallModeType=[ns1,ns2[, ...]]"
	//
	// The InstallModeType string passed must be marked as "supported" in the
	// CSV being installed. The namespaces passed must exist or be created by
	// passing a Namespace manifest to IncludePaths. An empty set of namespaces
	// can be used for AllNamespaces.
	// The default mode is OwnNamespace, which uses OperatorNamespace or the
	// kubeconfig default.
	InstallMode string

	// KubeconfigPath is the local path to a kubeconfig. This uses well-defined
	// default loading rules to load the config if empty.
	KubeconfigPath string
	// OperatorNamespace is the cluster namespace in which operator resources
	// are created.
	// OperatorNamespace must already exist in the cluster or be defined in
	// a manifest passed to IncludePaths.
	OperatorNamespace string
	// OLMNamespace is the namespace in which OLM is installed.
	OLMNamespace string
	// Timeout dictates how long to wait for a REST call to complete. A call
	// exceeding Timeout will generate an error.
	Timeout time.Duration
	// ForceRegistry forces deletion of registry resources.
	ForceRegistry bool
	// contains filtered or unexported fields
}

OLMCmd configures deployment and teardown of an operator via an OLM installation existing on a cluster.

func (*OLMCmd) AddToFlagSet

func (c *OLMCmd) AddToFlagSet(fs *pflag.FlagSet)

func (*OLMCmd) Cleanup

func (c *OLMCmd) Cleanup() (err error)

func (*OLMCmd) Run

func (c *OLMCmd) Run() error

Notes

Bugs

• if m.namespace is not contained in m.installModeNamespaces, DoCSVWait will fail.