olm

Documentation

Overview

Package olm provides an API to install, uninstall, and check the status of an Operator Lifecycle Manager installation. TODO: move to OLM repository?

Package olm provides an API to install, uninstall, and check the status of an Operator Lifecycle Manager installation. TODO: move to OLM repository?

Index

• Constants
• Variables
• type Client
  • func ClientForConfig(cfg *rest.Config) (*Client, error)
  • func (c Client) DoCSVWait(ctx context.Context, key types.NamespacedName) error
  • func (c Client) DoCreate(ctx context.Context, objs ...runtime.Object) error
  • func (c Client) DoDelete(ctx context.Context, objs ...runtime.Object) error
  • func (c Client) DoRolloutWait(ctx context.Context, key types.NamespacedName) error
  • func (c Client) GetInstalledVersion(ctx context.Context) (string, error)
  • func (c Client) GetObjectsStatus(ctx context.Context, objs ...runtime.Object) Status
• type ResourceStatus
• type Status
  • func (s Status) HasInstalledResources() (bool, error)
  • func (s Status) String() string

Constants

const OLMNamespace = "olm"

Variables

var ErrOLMNotInstalled = errors.New("no existing installation found")

var Scheme = scheme.Scheme

Types

type Client

type Client struct {
	KubeClient client.Client
}

func ClientForConfig

func ClientForConfig(cfg *rest.Config) (*Client, error)

func (Client) DoCSVWait

func (c Client) DoCSVWait(ctx context.Context, key types.NamespacedName) error

func (Client) DoCreate

func (c Client) DoCreate(ctx context.Context, objs ...runtime.Object) error

func (Client) DoDelete

func (c Client) DoDelete(ctx context.Context, objs ...runtime.Object) error

func (Client) DoRolloutWait

func (c Client) DoRolloutWait(ctx context.Context, key types.NamespacedName) error

func (Client) GetInstalledVersion

func (c Client) GetInstalledVersion(ctx context.Context) (string, error)

func (Client) GetObjectsStatus

func (c Client) GetObjectsStatus(ctx context.Context, objs ...runtime.Object) Status

type ResourceStatus

type ResourceStatus struct {
	NamespacedName types.NamespacedName
	Resource       *unstructured.Unstructured
	GVK            schema.GroupVersionKind
	Error          error
	// contains filtered or unexported fields
}

type Status

type Status struct {
	Resources []ResourceStatus
}

func (Status) HasInstalledResources

func (s Status) HasInstalledResources() (bool, error)

HasInstalledResources only returns true if at least one resource in s was returned successfully by the API server. A resource error status containing any error except "not found", or "no kind match" errors for Custom Resources, will result in HasInstalledResources returning false and the error.

func (Status) String

func (s Status) String() string