helm

Documentation

Index

• func ListVersions() ([]semver.Version, error)
• func MergeVals(helmFlagOpts values.Options, helmMapOpts map[string]string) (map[string]interface{}, error)
• func ParseVals(helmStrValues []string) (map[string]interface{}, error)
• func ResolveHelmChartVersion(versionFlag, chartDirectoryFlag, repository string) (semver.Version, *chart.Chart, error)
• func Upgrade(ctx context.Context, actionConfig *action.Configuration, ...) (*release.Release, error)
• type UpgradeParameters
  • func (p *UpgradeParameters) IsDryRun() bool

Functions

func ListVersions

func ListVersions() ([]semver.Version, error)

ListVersions returns a list of available Helm chart versions sorted by semver in ascending order.

func MergeVals

func MergeVals(
	helmFlagOpts values.Options,
	helmMapOpts map[string]string,
) (map[string]interface{}, error)

MergeVals merges all values from flag options ('helmFlagOpts') and auto-generated helm options based on environment ('helmMapOpts'), and returns a single map with all of these options merged. 'helmMapOpts' can be nil.

func ParseVals

func ParseVals(helmStrValues []string) (map[string]interface{}, error)

ParseVals takes a slice of Helm values of the form ["some.chart.value=val1", "some.other.value=val2"] and returns a deeply nested map of Values of the form expected by Helm actions.

func ResolveHelmChartVersion

func ResolveHelmChartVersion(versionFlag, chartDirectoryFlag, repository string) (semver.Version, *chart.Chart, error)

ResolveHelmChartVersion resolves Helm chart version based on --version, --chart-directory, and --repository flags.

func Upgrade

func Upgrade(
	ctx context.Context,
	actionConfig *action.Configuration,
	params UpgradeParameters,
) (*release.Release, error)

Upgrade upgrades the existing Helm release with the given Helm chart and values

Types

type UpgradeParameters

type UpgradeParameters struct {
	// Namespace in which the Helm release is installed.
	Namespace string
	// Name of the Helm release to upgrade.
	Name string
	// Chart is the Helm chart to use for the release
	Chart *chart.Chart
	// Helm values to pass during upgrade.
	Values map[string]interface{}
	// --reset-values flag from Helm upgrade. See https://helm.sh/docs/helm/helm_upgrade/ for details.
	ResetValues bool
	// --reuse-values flag from Helm upgrade. See https://helm.sh/docs/helm/helm_upgrade/ for details.
	ReuseValues bool
	// Wait determines if Helm actions will wait for completion
	Wait bool
	// WaitDuration is the timeout for helm operations
	WaitDuration time.Duration
	// DryRun writes resources to be installed to stdout without actually installing them. For Helm
	// installation mode only.
	DryRun bool
	// DryRunHelmValues writes non-default Helm values to stdout without performing the actual installation.
	// For Helm installation mode only.
	DryRunHelmValues bool
}

UpgradeParameters contains parameters for helm upgrade operation.

func (*UpgradeParameters) IsDryRun

func (p *UpgradeParameters) IsDryRun() bool