utility

Documentation

Index

• func AddRepo(repoName, repoURL string, logger log.FieldLogger) error
• func NewUtilityGroupHandle(allowCIDRRangeList []string, kubeconfigPath string, cluster *model.Cluster, ...) (*utilityGroup, error)
• type HelmListOutput
• type Utility

Functions

func AddRepo

func AddRepo(repoName, repoURL string, logger log.FieldLogger) error

AddRepo adds new helm repos

func NewUtilityGroupHandle

func NewUtilityGroupHandle(
	allowCIDRRangeList []string,
	kubeconfigPath string,
	cluster *model.Cluster,
	awsClient aws.AWS,
	parentLogger log.FieldLogger,
) (*utilityGroup, error)

Types

type HelmListOutput

type HelmListOutput []helmReleaseJSON

HelmListOutput is a struct for holding the unmarshaled representation of the output from helm list --output json

type Utility

type Utility interface {
	// CreateOrUpgrade is responsible for deploying the utility in the
	// cluster and then for updating it if it already exists when called
	CreateOrUpgrade() error

	// Destroy can be used if special care must be taken for deleting a
	// utility from a cluster
	Destroy() error

	// Migrate can be used if special care must be taken for migrating a
	// utility from a cluster
	Migrate() error

	// ActualVersion returns the utility's last reported actual version,
	// at the time of Create or Upgrade. This version will remain valid
	// unless something interacts with the cluster out of band, at which
	// time it will be invalid until Upgrade is called again
	ActualVersion() *model.HelmUtilityVersion

	// DesiredVersion returns the utility's target version, which has been
	// requested, but may not yet have been reconciled
	DesiredVersion() *model.HelmUtilityVersion

	// Name returns the canonical string-version name for the utility,
	// used throughout the application
	Name() string

	// ValuesPath returns the location where the values file(s) are
	// stored for this utility
	ValuesPath() string
}

A Utility is a service that runs one per cluster but is not part of k8s itself, nor is it part of a ClusterInstallation or an Installation