cluster

Documentation

Overview

Package cluster implements lokoctl subcommands logic.

Index

• func Apply(contextLogger *log.Entry, options ApplyOptions) error
• func AvailableComponents() []string
• func ComponentApply(contextLogger *log.Entry, componentsList []string, ...) error
• func ComponentDelete(contextLogger *log.Entry, componentsList []string, ...) error
• func ComponentRenderManifest(contextLogger *log.Entry, componentsList []string, ...) error
• func Destroy(contextLogger *log.Entry, options DestroyOptions) error
• func Health(contextLogger *log.Entry, options HealthOptions) error
• func RotateCertificates(contextLogger *log.Entry, options CertificateRotateOptions) error
• func Version() string
• type ApplyOptions
• type CertificateRotateOptions
• type ComponentApplyOptions
• type ComponentDeleteOptions
• type ComponentRenderManifestOptions
• type DestroyOptions
• type HealthOptions

Functions

func Apply

func Apply(contextLogger *log.Entry, options ApplyOptions) error

Apply applies cluster configuration together with components.

func AvailableComponents

func AvailableComponents() []string

AvailableComponents returns list of valid component names.

func ComponentApply

func ComponentApply(contextLogger *log.Entry, componentsList []string, options ComponentApplyOptions) error

ComponentApply implements 'lokoctl component apply' separated from CLI dependencies.

func ComponentDelete

func ComponentDelete(contextLogger *log.Entry, componentsList []string, options ComponentDeleteOptions) error

ComponentDelete implements 'lokoctl component delete' separated from CLI dependencies.

func ComponentRenderManifest

func ComponentRenderManifest(contextLogger *log.Entry, componentsList []string, options ComponentRenderManifestOptions) error

ComponentRenderManifest prints selected components manifests.

func Destroy

func Destroy(contextLogger *log.Entry, options DestroyOptions) error

Destroy destroys cluster infrastructure.

func Health

func Health(contextLogger *log.Entry, options HealthOptions) error

Health prints cluster health status.

func RotateCertificates

func RotateCertificates(contextLogger *log.Entry, options CertificateRotateOptions) error

RotateCertificates replaces all certificates in a cluster. Due to the nature of it running as a lokoctl command it is idempotent.

func Version

func Version() string

Version returns current Lokomotive version.

Types

type ApplyOptions

type ApplyOptions struct {
	Confirm                  bool
	UpgradeKubelets          bool
	SkipComponents           bool
	SkipPreUpdateHealthCheck bool
	SkipControlPlaneUpdate   bool
	Verbose                  bool
	ConfigPath               string
	ValuesPath               string
}

ApplyOptions defines how cluster apply operation will behave.

type CertificateRotateOptions

type CertificateRotateOptions struct {
	Confirm    bool
	Verbose    bool
	ConfigPath string
	ValuesPath string
}

CertificateRotateOptions contains the options for the RotateCertificates function.

type ComponentApplyOptions

type ComponentApplyOptions struct {
	KubeconfigPath string
	ConfigPath     string
	ValuesPath     string
}

ComponentApplyOptions controls ComponentApply() behavior.

type ComponentDeleteOptions

type ComponentDeleteOptions struct {
	Confirm         bool
	DeleteNamespace bool
	KubeconfigPath  string
	ConfigPath      string
	ValuesPath      string
}

ComponentDeleteOptions controls ComponentDelete() behavior.

type ComponentRenderManifestOptions

type ComponentRenderManifestOptions struct {
	ConfigPath string
	ValuesPath string
}

ComponentRenderManifestOptions controls ComponentRenderManifest() behavior.

type DestroyOptions

type DestroyOptions struct {
	Confirm    bool
	Verbose    bool
	ConfigPath string
	ValuesPath string
}

DestroyOptions controls Destroy() behavior.

type HealthOptions

type HealthOptions struct {
	ConfigPath string
	ValuesPath string
}

HealthOptions controls Health() behavior.