installer

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) (*olmresourceclient.Status, error)
  • func (c Client) InstallVersion(ctx context.Context, namespace, version string) (*olmresourceclient.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

Constants

const (
	// TODO: switch back to latest once olm fixes their releases
	// https://github.com/operator-framework/operator-lifecycle-manager/issues/3419
	DefaultVersion = "0.28.0"
	DefaultTimeout = time.Minute * 2
	// DefaultOLMNamespace is the namespace where OLM is installed
	DefaultOLMNamespace = "olm"
)

Types

type Client

type Client struct {
	*olmresourceclient.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) (*olmresourceclient.Status, error)

func (Client) InstallVersion

func (c Client) InstallVersion(ctx context.Context, namespace, version string) (*olmresourceclient.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
	OLMNamespace string
	// 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