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?

Index

• Constants
• type Client
  • func ClientForConfig(cfg *rest.Config) (*Client, error)
  • func (c Client) GetStatus(ctx context.Context, version string) (*Status, error)
  • func (c Client) InstallVersion(ctx context.Context, version string) (*Status, error)
  • func (c Client) UninstallVersion(ctx context.Context, version string) error
• type Manager
  • func (m *Manager) AddToFlagSet(fs *pflag.FlagSet)
  • func (m *Manager) Install() error
  • func (m *Manager) Status() error
  • func (m *Manager) Uninstall() error
• type ResourceStatus
• type Status
  • func (s Status) HasExistingResources() bool
  • func (s Status) String() string

Constants

const (
	DefaultVersion = "latest"
	DefaultTimeout = time.Minute * 2
)

Types

type Client

type Client struct {
	KubeClient      client.Client
	HTTPClient      http.Client
	BaseDownloadURL string
}

func ClientForConfig

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

func (Client) GetStatus

func (c Client) GetStatus(ctx context.Context, version string) (*Status, error)

func (Client) InstallVersion

func (c Client) InstallVersion(ctx context.Context, version string) (*Status, error)

func (Client) UninstallVersion

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

type Manager

type Manager struct {
	Client  *Client
	Version string
	Timeout time.Duration
	// contains filtered or unexported fields
}

func (*Manager) AddToFlagSet

func (m *Manager) AddToFlagSet(fs *pflag.FlagSet)

func (*Manager) Install

func (m *Manager) Install() error

func (*Manager) Status

func (m *Manager) Status() error

func (*Manager) Uninstall

func (m *Manager) Uninstall() error

type ResourceStatus

type ResourceStatus struct {
	NamespacedName types.NamespacedName
	Resource       *unstructured.Unstructured
	GVK            schema.GroupVersionKind
	Error          error
}

type Status

type Status struct {
	Resources []ResourceStatus
}

func (Status) HasExistingResources

func (s Status) HasExistingResources() bool

func (Status) String

func (s Status) String() string