helmclient

// Define a private chart repository
chartRepo := repo.Entry{
	Name:     "stable",
	URL:      "https://private-chartrepo.somedomain.com",
	Username: "foo",
	Password: "bar",
	// Since helm 3.6.1 it is necessary to pass 'PassCredentialsAll = true'.
	PassCredentialsAll: true,
}

// Add a chart-repository to the client.
if err := helmClient.AddOrUpdateChartRepo(chartRepo); err != nil {
	panic(err)
}

Output:

// Define a public chart repository.
chartRepo := repo.Entry{
	Name: "stable",
	URL:  "https://charts.helm.sh/stable",
}

// Add a chart-repository to the client.
if err := helmClient.AddOrUpdateChartRepo(chartRepo); err != nil {
	panic(err)
}

Output:

// Get specific details of a deployed release.
if _, err := helmClient.GetRelease("etcd-operator"); err != nil {
	panic(err)
}

Output:

// Get the values of a deployed release.
if _, err := helmClient.GetReleaseValues("etcd-operator", true); err != nil {
	panic(err)
}

Output:

// Define the chart to be installed
chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "stable/etcd-operator",
	Namespace:   "default",
	UpgradeCRDs: true,
	Wait:        true,
}

// Install a chart release.
// Note that helmclient.Options.Namespace should ideally match the namespace in chartSpec.Namespace.
if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
	panic(err)
}

Output:

// Use an unpacked chart directory.
chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "/path/to/stable/etcd-operator",
	Namespace:   "default",
	UpgradeCRDs: true,
	Wait:        true,
}

if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
	panic(err)
}

Output:

// Define the chart to be installed
chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "stable/etcd-operator",
	Namespace:   "default",
	UpgradeCRDs: true,
	Wait:        true,
}

// Use a custom rollback strategy (customRollBack needs to implement RollBack).
rollBacker := customRollBack{}

opts := GenericHelmOptions{
	RollBack: rollBacker,
}

// Install a chart release.
// Note that helmclient.Options.Namespace should ideally match the namespace in chartSpec.Namespace.
if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, &opts); err != nil {
	panic(err)
}

Output:

// Define the chart to be installed
chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "stable/etcd-operator",
	Namespace:   "default",
	UpgradeCRDs: true,
	Wait:        true,
}

// Use the default rollback strategy offer by HelmClient (revert to the previous version).
opts := GenericHelmOptions{
	RollBack: helmClient,
}

// Install a chart release.
// Note that helmclient.Options.Namespace should ideally match the namespace in chartSpec.Namespace.
if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, &opts); err != nil {
	panic(err)
}

Output:

// Use an archived chart directory.
chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "/path/to/stable/etcd-operator.tar.gz",
	Namespace:   "default",
	UpgradeCRDs: true,
	Wait:        true,
}

if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
	panic(err)
}

Output:

// Use an archived chart directory via URL.
chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "http://helm.whatever.com/repo/etcd-operator.tar.gz",
	Namespace:   "default",
	UpgradeCRDs: true,
	Wait:        true,
}

if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
	panic(err)
}

Output:

// Define a chart with custom values to be tested.
chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "stable/etcd-operator",
	Namespace:   "default",
	UpgradeCRDs: true,
	Wait:        true,
	ValuesYaml: `deployments:
  etcdOperator: true
  backupOperator: false`,
}

if err := helmClient.LintChart(&chartSpec); err != nil {
	panic(err)
}

Output:

// List all deployed releases.
if _, err := helmClient.ListDeployedReleases(); err != nil {
	panic(err)
}

Output:

// Define the released chart to be installed
chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "stable/etcd-operator",
	Namespace:   "default",
	UpgradeCRDs: true,
	Wait:        true,
}

// Rollback to the previous version of the release.
if err := helmClient.RollbackRelease(&chartSpec); err != nil {
	return
}

Output:

chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "stable/etcd-operator",
	Namespace:   "default",
	UpgradeCRDs: true,
	Wait:        true,
	ValuesYaml: `deployments:
  etcdOperator: true
  backupOperator: false`,
}

options := &HelmTemplateOptions{
	KubeVersion: &chartutil.KubeVersion{
		Version: "v1.23.10",
		Major:   "1",
		Minor:   "23",
	},
	APIVersions: []string{
		"helm.sh/v1/Test",
	},
}

_, err := helmClient.TemplateChart(&chartSpec, options)
if err != nil {
	panic(err)
}

Output:

// Define the released chart to be installed.
chartSpec := ChartSpec{
	ReleaseName: "etcd-operator",
	ChartName:   "stable/etcd-operator",
	Namespace:   "default",
	Wait:        true,
	DryRun:      true,
	KeepHistory: true,
}

// Uninstall the chart release.
// Note that helmclient.Options.Namespace should ideally match the namespace in chartSpec.Namespace.
if err := helmClient.UninstallRelease(&chartSpec); err != nil {
	panic(err)
}

Output:

// Uninstall a release by name.
if err := helmClient.UninstallReleaseByName("etcd-operator"); err != nil {
	panic(err)
}

Output:

// Update the list of chart repositories.
if err := helmClient.UpdateChartRepos(); err != nil {
	panic(err)
}

Output: