upgrade

Documentation

Overview

Package upgrade implements upgrade logic for the CLI.

Index

• Constants
• Variables
• type Config
• type Upgrade
  • func NewUpgrade(cfg *Config, l *zap.SugaredLogger) (*Upgrade, error)
  • func (u *Upgrade) Run(ctx context.Context) error

Constants

const (

	// FlagSkipEnvDetection is the name of the skip env detection flag.
	FlagSkipEnvDetection = "skip-env-detection"
)

Variables

var ErrNoUpdateAvailable = errors.New("no update available")

ErrNoUpdateAvailable is returned when no update is available.

Types

type Config

type Config struct {
	// KubeconfigPath is a path to a kubeconfig
	KubeconfigPath string `mapstructure:"kubeconfig"`
	// InCluster is set if the upgrade process should use in-cluster configuration.
	InCluster bool `mapstructure:"in-cluster"`
	// VersionMetadataURL stores hostname to retrieve version metadata information from.
	VersionMetadataURL string `mapstructure:"version-metadata-url"`
	// DryRun is set if the upgrade process should only perform pre-upgrade checks and not perform the actual upgrade.
	DryRun bool `mapstructure:"dry-run"`
	// If set, we will print the pretty output.
	Pretty bool
	// SkipEnvDetection skips detecting the Kubernetes environment.
	SkipEnvDetection bool `mapstructure:"skip-env-detection"`

	helm.CLIOptions
}

Config defines configuration required for upgrade command.

type Upgrade

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

Upgrade struct implements upgrade command.

func NewUpgrade

func NewUpgrade(cfg *Config, l *zap.SugaredLogger) (*Upgrade, error)

NewUpgrade returns a new Upgrade struct.

func (*Upgrade) Run

func (u *Upgrade) Run(ctx context.Context) error

Run runs the operators installation process.