helm

Documentation

Overview

Package helm handles Helm-related operations.

Index

• func ChartFromAssets(location string) (*chart.Chart, error)
• func GetHistory(client HistoryClient, name string, max int) ([]*release.Release, error)
• type HistoryClient
• type LokomotiveChart

Functions

func ChartFromAssets

func ChartFromAssets(location string) (*chart.Chart, error)

ChartFromAssets finds a Helm chart in the assets at location, creates a chart.Chart struct from the chart and returns a pointer to it.

func GetHistory

func GetHistory(client HistoryClient, name string, max int) ([]*release.Release, error)

GetHistory returns at most max elements of the Helm history in descending version order, that is, the first element returned is the newest version of the release.

See https://github.com/helm/helm/blob/041ce5a2c17a58be0fcd5f5e16fb3e7e95fea622/cmd/helm/history.go#L115-L135. When helm exposes this in the API we can get rid of this.

Types

type HistoryClient

type HistoryClient interface {
	Run(name string) ([]*release.Release, error)
}

HistoryClient allows mocking for tests.

type LokomotiveChart

type LokomotiveChart struct {
	// The name of the chart.
	Name string
	// The namespace into which the chart should be deployed.
	Namespace string
}

LokomotiveChart represents a Helm chart belonging to a Lokomotive component or control plane element.