addons

Documentation

Overview

Package addons manages the default addons installations in the cluster. Addons are mostly Helm Charts, but can also be other resources as the project evolves. All of the AddOns must implement the AddOn interface.

Index

• type AddOn
• type Applier
  • func NewApplier(opts ...Option) *Applier
  • func (a *Applier) Apply(ctx context.Context) error
  • func (a *Applier) HostPreflights() (*v1beta2.HostPreflightSpec, error)
  • func (a *Applier) Versions() (map[string]string, error)
• type Option
  • func Quiet() Option
  • func WithoutAddon(addon string) Option
  • func WithoutPrompt() Option

Types

type AddOn

type AddOn interface {
	Apply(ctx context.Context) error
	Version() (map[string]string, error)
	HostPreflights() (*v1beta2.HostPreflightSpec, error)
}

AddOn is the interface that all addons must implement.

type Applier

type Applier struct {
	// contains filtered or unexported fields
}

Applier is an entity that applies (installs and updates) addons in the cluster.

func NewApplier

func NewApplier(opts ...Option) *Applier

NewApplier creates a new Applier instance with all addons registered.

func (*Applier) Apply

func (a *Applier) Apply(ctx context.Context) error

Apply applies all registered addons to the cluster. Simply calls Apply on each addon.

func (*Applier) HostPreflights

func (a *Applier) HostPreflights() (*v1beta2.HostPreflightSpec, error)

HostPreflights reads all embedded host preflights from all add-ons and returns them merged in a single HostPreflightSpec.

func (*Applier) Versions

func (a *Applier) Versions() (map[string]string, error)

Versions returns a map with the version of each addon that will be applied.

type Option

type Option func(*Applier)

Option sets and option on an Applier reference.

func Quiet

func Quiet() Option

Quiet disables logging for addons.

func WithoutAddon

func WithoutAddon(addon string) Option

WithoutAddon disables an addon from being applied.

func WithoutPrompt

func WithoutPrompt() Option

WithoutPrompt disables the prompt before applying addons.