types

Documentation

Index

• type HelmClient
• type HelmInstaller
• type HelmUninstaller
• type Installer
• type InstallerConfig
• type ReleaseListRunner

Types

type HelmClient

type HelmClient interface {
	// Prepare an installation object that can then be .Run() with a chart object
	NewInstall(namespace, releaseName string, dryRun bool) (HelmInstaller, *cli.EnvSettings, error)

	// Prepare an un-installation object that can then be .Run() with a release name
	NewUninstall(namespace string) (HelmUninstaller, error)

	// List the already-existing releases in the given namespace
	ReleaseList(namespace string) (ReleaseListRunner, error)

	// Returns the Helm chart archive located at the given URI (can be either an http(s) address or a file path)
	DownloadChart(chartArchiveUri string) (*chart.Chart, error)

	// Returns true if the release with the given name exists in the given namespace
	ReleaseExists(namespace, releaseName string) (releaseExists bool, err error)
}

This interface implements the Helm CLI actions. The implementation relies on the Helm 3 libraries.

type HelmInstaller

type HelmInstaller interface {
	Run(chrt *chart.Chart, vals map[string]interface{}) (*release.Release, error)
}

an interface around Helm's action.Install struct

type HelmUninstaller

type HelmUninstaller interface {
	Run(name string) (*release.UninstallReleaseResponse, error)
}

an interface around Helm's action.Uninstall struct

type Installer

type Installer interface {
	Install(installerConfig *InstallerConfig) error
}

type InstallerConfig

type InstallerConfig struct {
	DryRun           bool
	CreateNamespace  bool
	Verbose          bool
	InstallNamespace string
	ReleaseName      string
	// the uri to the helm chart, can either be a local file or a valid http/https link
	ReleaseUri  string
	ValuesFiles []string
	ExtraValues map[string]interface{}

	PreInstallMessage  string
	PostInstallMessage string
}

type ReleaseListRunner

type ReleaseListRunner interface {
	Run() ([]*release.Release, error)
	SetFilter(filter string)
}

an interface around Helm's action.List struct