action

Documentation

Index

• type Apply
  • func NewApply(opts ApplyOptions) *Apply
  • func (a Apply) Run() error
• type ApplyOptions
• type Backup
  • func (b Backup) Run() error
• type ConfigEdit
  • func (c ConfigEdit) Run() error
• type ConfigStatus
  • func (c ConfigStatus) Run() error
• type Kubeconfig
  • func (k *Kubeconfig) Run() error
• type Reset
  • func (r Reset) Run() error

Types

type Apply

type Apply struct {
	ApplyOptions
	Phases phase.Phases
}

func NewApply

func NewApply(opts ApplyOptions) *Apply

NewApply creates a new Apply action. The list of phases can be modified via the Phases field, for example:

apply := NewApply(opts)
gatherK0sFacts := &phase.GatherK0sFacts{} // advisable to get the title from the phase itself instead of hardcoding the title.
apply.Phases.InsertBefore(gatherK0sFacts.Title(), &myCustomPhase{}) // insert a custom phase before the GatherK0sFacts phase

func (Apply) Run

func (a Apply) Run() error

Run the Apply action

type ApplyOptions

type ApplyOptions struct {
	// Manager is the phase manager
	Manager *phase.Manager
	// DisableDowngradeCheck skips the downgrade check
	DisableDowngradeCheck bool
	// Force allows forced installation in case of certain failures
	Force bool
	// NoWait skips waiting for the cluster to be ready
	NoWait bool
	// NoDrain skips draining worker nodes
	NoDrain bool
	// RestoreFrom is the path to a cluster backup archive to restore the state from
	RestoreFrom string
	// KubeconfigOut is a writer to write the kubeconfig to
	KubeconfigOut io.Writer
	// KubeconfigAPIAddress is the API address to use in the kubeconfig
	KubeconfigAPIAddress string
	// KubeconfigUser is the username to use in the kubeconfig
	KubeconfigUser string
	// KubeconfigCluster is the cluster name to use in the kubeconfig
	KubeconfigCluster string
	// ConfigPath is the path to the configuration file (used for kubeconfig command tip on success)
	ConfigPath string
}

type Backup

type Backup struct {
	// Manager is the phase manager
	Manager *phase.Manager
}

func (Backup) Run

func (b Backup) Run() error

type ConfigEdit

type ConfigEdit struct {
	Config *v1beta1.Cluster
	Stdout io.Writer
	Stderr io.Writer
	Stdin  io.Reader
}

func (ConfigEdit) Run

func (c ConfigEdit) Run() error

type ConfigStatus

type ConfigStatus struct {
	Config      *v1beta1.Cluster
	Concurrency int
	Format      string
	Writer      io.Writer
}

func (ConfigStatus) Run

func (c ConfigStatus) Run() error

type Kubeconfig

type Kubeconfig struct {
	// Manager is the phase manager
	Manager              *phase.Manager
	KubeconfigAPIAddress string
	KubeconfigUser       string
	KubeconfigCluster    string

	Kubeconfig string
}

func (*Kubeconfig) Run

func (k *Kubeconfig) Run() error

type Reset

type Reset struct {
	// Manager is the phase manager
	Manager *phase.Manager
	Stdout  io.Writer
	Force   bool
}

func (Reset) Run

func (r Reset) Run() error