helm

Documentation

Index

• type Helm
  • func New(executor commands.Executor, namespace string, chartName string, ...) Helm

Types

type Helm

type Helm interface {

	// SetVariables set the variables for the helm deployment. Variables set will be applied on any subsequent operation. If you do not provide
	// any variables with SetVariables, the default variables in file values.yaml are used.
	//
	// Parameters support are
	//     helmVariables (this is a map of helm variables, defined as string keys and interface values. Nested structures are supported)
	SetVariables(helmVariables map[string]interface{}) error

	// Deploy deploys the helm charts provided in the helmDirectory to the configured kubernetes namespace.
	Deploy() error

	// GetVariablesOverrideFileName returns the file name in which the helm variables will be stored. This name is convention based on the helm tool chain.
	GetVariablesOverrideFileName() string
}

Helm is a wrapper around common helm functionality used for automated app deployments to kubernetes.

func New

func New(executor commands.Executor, namespace string, chartName string, helmDirectory string) Helm

New creates a new instance of Helm, which is a wrapper around common Helm functionality. Parameters:

executor (can be provided from hq.GetExecutor() or by instantiating your own),
namespace (the kubernetes namespace to deploy to),
chartName (the chart name of the helm deployment),
helmDirectory (directory where your helm resources are stored. To construct the full path, simply use
    filepath.Join() method and the hq.ProjectBasePath)