helm

Documentation

Index

• Variables
• type Agent
  • func GetAgentInClusterConfig(form *Form, l *logger.Logger) (*Agent, error)
  • func GetAgentOutOfClusterConfig(form *Form, l *logger.Logger) (*Agent, error)
  • func GetAgentTesting(form *Form, storage *storage.Storage, l *logger.Logger) *Agent
  • func (a *Agent) GetRelease(name string, version int) (*release.Release, error)
  • func (a *Agent) GetReleaseHistory(name string) ([]*release.Release, error)
  • func (a *Agent) InstallChart(cp string, values []byte) (*release.Release, error)
  • func (a *Agent) ListReleases(namespace string, filter *ListFilter) ([]*release.Release, error)
  • func (a *Agent) RollbackRelease(name string, version int) error
  • func (a *Agent) UpgradeRelease(name string, values string) (*release.Release, error)
• type Form
• type ListFilter
• type NewStorageDriver

Variables

var StorageMap map[string]NewStorageDriver = map[string]NewStorageDriver{
	"secret":    newSecretStorageDriver,
	"configmap": newConfigMapsStorageDriver,
	"memory":    newMemoryStorageDriver,
}

StorageMap is a map from storage configuration env variables to a function that initializes that Helm storage driver.

Types

type Agent

type Agent struct {
	ActionConfig *action.Configuration
}

Agent is a Helm agent for performing helm operations

func GetAgentInClusterConfig

func GetAgentInClusterConfig(form *Form, l *logger.Logger) (*Agent, error)

GetAgentInClusterConfig creates a new Agent from inside the cluster using the underlying kubernetes.GetAgentInClusterConfig method

func GetAgentOutOfClusterConfig

func GetAgentOutOfClusterConfig(form *Form, l *logger.Logger) (*Agent, error)

GetAgentOutOfClusterConfig creates a new Agent from outside the cluster using the underlying kubernetes.GetAgentOutOfClusterConfig method

func GetAgentTesting

func GetAgentTesting(form *Form, storage *storage.Storage, l *logger.Logger) *Agent

GetAgentTesting creates a new Agent using an optional existing storage class

func (*Agent) GetRelease

func (a *Agent) GetRelease(
	name string,
	version int,
) (*release.Release, error)

GetRelease returns the info of a release.

func (*Agent) GetReleaseHistory

func (a *Agent) GetReleaseHistory(
	name string,
) ([]*release.Release, error)

GetReleaseHistory returns a list of charts for a specific release

func (*Agent) InstallChart

func (a *Agent) InstallChart(
	cp string,
	values []byte,
) (*release.Release, error)

InstallChart installs a new chart by URL, absolute or relative filepaths. Equivalent to `helm install [CHART_NAME] [cp]` where cp is one of the following:

1. Absolute URL: https://example.com/charts/nginx-1.2.3.tgz
2. path to packaged chart ./nginx-1.2.3.tgz
3. path to unpacked chart ./nginx

func (*Agent) ListReleases

func (a *Agent) ListReleases(
	namespace string,
	filter *ListFilter,
) ([]*release.Release, error)

ListReleases lists releases based on a ListFilter

func (*Agent) RollbackRelease

func (a *Agent) RollbackRelease(
	name string,
	version int,
) error

RollbackRelease rolls a release back to a specified revision/version

func (*Agent) UpgradeRelease

func (a *Agent) UpgradeRelease(
	name string,
	values string,
) (*release.Release, error)

UpgradeRelease upgrades a specific release with new values.yaml

type Form

type Form struct {
	Cluster   *models.Cluster `form:"required"`
	Repo      *repository.Repository
	Storage   string `json:"storage" form:"oneof=secret configmap memory"`
	Namespace string `json:"namespace"`
}

Form represents the options for connecting to a cluster and creating a Helm agent

type ListFilter

type ListFilter struct {
	Namespace    string   `json:"namespace"`
	Limit        int      `json:"limit"`
	Skip         int      `json:"skip"`
	ByDate       bool     `json:"byDate"`
	StatusFilter []string `json:"statusFilter"`
}

ListFilter is a struct that represents the various filter options used for retrieving the releases

type NewStorageDriver

type NewStorageDriver func(
	l *logger.Logger,
	v1Interface corev1.CoreV1Interface,
	namespace string,
) *storage.Storage

NewStorageDriver is a function type for returning a new storage driver