Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type OperatorCmd ¶ added in v0.18.0
type OperatorCmd struct {
// 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
// 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.
InstallMode 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
}
OperatorCmd configures deployment and teardown of an operator via OLM. Intended to be used by an exported struct, as it lackas a Run method.
func (*OperatorCmd) AddToFlagSet ¶ added in v0.18.0
func (c *OperatorCmd) AddToFlagSet(fs *pflag.FlagSet)
type PackageManifestsCmd ¶ added in v0.18.0
type PackageManifestsCmd struct {
OperatorCmd
// ManifestsDir is a directory containing 1..N package directories and
// a package manifest.
// OperatorVersion can be set to the version of the desired operator package
// 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 PackageManifestsCmd. These
// manifests can be but are not limited to: RBAC, Subscriptions,
// CatalogSources, OperatorGroups.
//
// Kinds that are overridden if supplied:
// - CatalogSource
// - Subscription
// - OperatorGroup
IncludePaths []string
}
PackageManifestsCmd configures deployment and teardown of an operator managed in a package manifests format via OLM.
func (*PackageManifestsCmd) AddToFlagSet ¶ added in v0.18.0
func (c *PackageManifestsCmd) AddToFlagSet(fs *pflag.FlagSet)
func (*PackageManifestsCmd) Cleanup ¶ added in v0.18.0
func (c *PackageManifestsCmd) Cleanup() (err error)
func (*PackageManifestsCmd) Run ¶ added in v0.18.0
func (c *PackageManifestsCmd) Run() error
Notes ¶
Bugs ¶
if operatorNamespace is not contained in targetNamespaces, DoCSVWait will fail because the CSV is not deployed in operatorNamespace.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.