install

Documentation

Index

• type CommonParams
• type Context
• type InstallOption
• type Manager
• type ParameterParser
• type UpgradeOption

Types

type CommonParams

type CommonParams struct {
	Set    map[string]string `help:"Set parameters."`
	File   *os.File          `short:"f" help:"Parameters file."`
	Bundle *os.File          `help:"Local bundle path."`
}

CommonParams are common parameters for installing and upgrading.

type Context

type Context struct {
	Kubeconfig *rest.Config
	Namespace  string
}

Context includes common data that installer consumers may utilize.

type InstallOption

type InstallOption func(*chart.Chart) error

InstallOption customizes the behavior of an install.

type Manager

type Manager interface {
	GetCurrentVersion() (string, error)
	Install(version string, parameters map[string]any, opts ...InstallOption) error
	Upgrade(version string, parameters map[string]any, opts ...UpgradeOption) error
	Uninstall() error
}

Manager can install and manage Upbound software in a Kubernetes cluster. TODO(hasheddan): support custom error types, such as AlreadyExists.

type ParameterParser

type ParameterParser interface {
	Parse() (map[string]any, error)
}

ParameterParser parses install and upgrade parameters.

type UpgradeOption

type UpgradeOption func(oldVersion string, ch *chart.Chart) error

UpgradeOption customizes the behavior of an upgrade.