operator

Documentation

Index

• Constants
• func CatalogNameForPackage(pkg string) string
• func GetSupportedInstallModes(csvInstallModes []v1alpha1.InstallMode) set.Set[string]
• func LoadBundle(ctx context.Context, bundleImage string, skipTLSVerify bool, useHTTP bool) (registryutil.LabelsMap, *apimanifests.Bundle, error)
• type Configuration
  • func (c *Configuration) BindFlags(fs *pflag.FlagSet)
  • func (c *Configuration) Load() error
• type ErrPackageNotFound
  • func (e ErrPackageNotFound) Error() string
• type InstallMode
  • func (i InstallMode) CheckCompatibility(csv *v1alpha1.ClusterServiceVersion, operatorNamespace string) error
  • func (i InstallMode) IsEmpty() bool
  • func (i *InstallMode) Set(str string) error
  • func (i InstallMode) String() string
  • func (InstallMode) Type() string
  • func (i InstallMode) Validate() error
• type Uninstall
  • func NewUninstall(cfg *Configuration) *Uninstall
  • func (u *Uninstall) BindFlags(fs *pflag.FlagSet)
  • func (u *Uninstall) Run(ctx context.Context) error

Constants

const (
	SDKOperatorGroupName = "operator-sdk-og"
)

Functions

func CatalogNameForPackage

func CatalogNameForPackage(pkg string) string

func GetSupportedInstallModes

func GetSupportedInstallModes(csvInstallModes []v1alpha1.InstallMode) set.Set[string]

GetSupportedInstallModes returns the given slice of InstallModes as a String set.

func LoadBundle

func LoadBundle(ctx context.Context, bundleImage string, skipTLSVerify bool, useHTTP bool) (registryutil.LabelsMap, *apimanifests.Bundle, error)

LoadBundle returns metadata and manifests from within bundleImage.

Types

type Configuration

type Configuration struct {
	Namespace      string
	ServiceAccount string
	KubeconfigPath string
	RESTConfig     *rest.Config
	Client         client.Client
	Scheme         *runtime.Scheme
	Timeout        time.Duration
	// contains filtered or unexported fields
}

func (*Configuration) BindFlags

func (c *Configuration) BindFlags(fs *pflag.FlagSet)

func (*Configuration) Load

func (c *Configuration) Load() error

type ErrPackageNotFound

type ErrPackageNotFound struct {
	PackageName string
}

func (ErrPackageNotFound) Error

func (e ErrPackageNotFound) Error() string

type InstallMode

type InstallMode struct {
	InstallModeType  v1alpha1.InstallModeType
	TargetNamespaces []string
}

func (InstallMode) CheckCompatibility

func (i InstallMode) CheckCompatibility(csv *v1alpha1.ClusterServiceVersion, operatorNamespace string) error

CheckCompatibility checks if an InstallMode is compatible with the operator's namespace and is supported by csv.

func (InstallMode) IsEmpty

func (i InstallMode) IsEmpty() bool

IsEmpty returns true if the InstallModeType is empty.

func (*InstallMode) Set

func (i *InstallMode) Set(str string) error

Set is called when the --install-mode flag is passed to the CLI. It will configure the InstallMode based on the values passed in.

func (InstallMode) String

func (i InstallMode) String() string

func (InstallMode) Type

func (InstallMode) Type() string

func (InstallMode) Validate

func (i InstallMode) Validate() error

type Uninstall

type Uninstall struct {
	Package                  string
	DeleteAll                bool
	DeleteCRDs               bool
	DeleteOperatorGroups     bool
	DeleteOperatorGroupNames []string

	Logf func(string, ...interface{})
	// contains filtered or unexported fields
}

func NewUninstall

func NewUninstall(cfg *Configuration) *Uninstall

func (*Uninstall) BindFlags

func (u *Uninstall) BindFlags(fs *pflag.FlagSet)

func (*Uninstall) Run

func (u *Uninstall) Run(ctx context.Context) error