helmclient

type Chart struct {
	// Version is the version of the Helm Chart.
	Version string
}

type Client struct {
	// contains filtered or unexported fields
}

type Config struct {
	Fs afero.Fs
	// HelmClient sets a helm client used for all operations of the initiated
	// client. If this is nil, a new helm client will be created for each
	// operation via proper port forwarding. Setting the helm client here manually
	// might only be sufficient for testing or whenever you know what you do.
	HelmClient helmclient.Interface
	K8sClient  kubernetes.Interface
	Logger     micrologger.Logger

	EnsureTillerInstalledMaxWait time.Duration
	RestConfig                   *rest.Config
	TillerImageName              string
	TillerImageRegistry          string
	TillerNamespace              string
	TillerUpgradeEnabled         bool
}

type Interface interface {
	// DeleteRelease uninstalls a chart given its release name.
	DeleteRelease(ctx context.Context, releaseName string, options ...helm.DeleteOption) error
	// EnsureTillerInstalled installs Tiller by creating its deployment and waiting
	// for it to start. A service account and cluster role binding are also created.
	// As a first step, it checks if Tiller is already ready, in which case it
	// returns early.
	EnsureTillerInstalled(ctx context.Context) error
	// EnsureTillerInstalledWithValues installs Tiller by creating its deployment
	// and waiting for it to start. A service account and cluster role binding are
	// also created. Values can be provided to pass through to Tiller
	// and overwrite its deployment defaults.
	EnsureTillerInstalledWithValues(ctx context.Context, values []string) error
	// GetReleaseContent gets the current status of the Helm Release. The
	// releaseName is the name of the Helm Release that is set when the Chart
	// is installed.
	GetReleaseContent(ctx context.Context, releaseName string) (*ReleaseContent, error)
	// GetReleaseHistory gets the current installed version of the Helm Release.
	// The releaseName is the name of the Helm Release that is set when the Helm
	// Chart is installed.
	GetReleaseHistory(ctx context.Context, releaseName string) (*ReleaseHistory, error)
	// InstallReleaseFromTarball installs a Helm Chart packaged in the given tarball.
	InstallReleaseFromTarball(ctx context.Context, path, ns string, options ...helm.InstallOption) error
	// ListReleaseContents gets the current status of all Helm Releases.
	ListReleaseContents(ctx context.Context) ([]*ReleaseContent, error)
	// LoadChart loads a Helm Chart and returns its structure.
	LoadChart(ctx context.Context, chartPath string) (Chart, error)
	// PingTiller proxies the underlying Helm client PingTiller method.
	PingTiller(ctx context.Context) error
	// PullChartTarball downloads a tarball from the provided tarball URL,
	// returning the file path.
	PullChartTarball(ctx context.Context, tarballURL string) (string, error)
	// RunReleaseTest runs the tests for a Helm Release. This is the same
	// action as running the helm test command.
	RunReleaseTest(ctx context.Context, releaseName string, options ...helm.ReleaseTestOption) error
	// UpdateReleaseFromTarball updates the given release using the chart packaged
	// in the tarball.
	UpdateReleaseFromTarball(ctx context.Context, releaseName, path string, options ...helm.UpdateOption) error
}

type ReleaseContent struct {
	// Name is the name of the Helm Release.
	Name string
	// Status is the Helm status code of the Release.
	Status string
	// Values are the values provided when installing the Helm Release.
	Values map[string]interface{}
}

type ReleaseHistory struct {
	// AppVersion is the app version of the Helm Chart that has been deployed.
	AppVersion string
	// Description is a human-friendly "log entry" about this Helm release.
	Description string
	// LastDeployed is the time the Helm Chart was last deployed.
	LastDeployed time.Time
	// Name is the name of the Helm Release.
	Name string
	// Version is the version of the Helm Chart that has been deployed.
	Version string
}