helmutil

Documentation

Index

• Constants
• func ChartVersion(cfg *action.Configuration, releaseName string) (*chart.Chart, error)
• func DownloadChartRelease(repoName, repoURL, chartName, chartVersion string, options ...getter.Option) (string, error)
• func ExtractChartRelease(saved, repoName, chartName, chartVersion string) (string, error)
• func GetChartTargetDir(repoName, chartName string) (string, error)
• func Install(cfg *action.Configuration, releaseName, path, namespace string, ...) (*release.Release, error)
• func ListInstallations(cfg *action.Configuration) ([]*release.Release, error)
• func MergeValuesFile(cfg *action.Configuration, settings *cli.EnvSettings, ...) (*os.File, error)
• func Release(cfg *action.Configuration, releaseName string) (*release.Release, error)
• func SetValues(cfg *action.Configuration, releaseName string) (map[string]interface{}, error)
• func Uninstall(cfg *action.Configuration, releaseName string) (*release.UninstallReleaseResponse, error)
• func UpgradeValues(cfg *action.Configuration, chartDir, chartName, releaseName string, ...) (*release.Release, error)
• func ValuesYaml(chartVersion string) (io.Reader, error)
• type Upgrader
  • func NewUpgrader(c client.Client, repoName, repoURL, chartName string, subCharts []string) (*Upgrader, error)
  • func (u *Upgrader) Upgrade(ctx context.Context, chartVersion string) ([]unstructured.Unstructured, error)

Constants

const (
	ManagedLabel      = "app.kubernetes.io/managed-by"
	ManagedLabelValue = "Helm"
	ReleaseAnnotation = "meta.helm.sh/release-name"

	StableK8ssandraRepoURL = "https://helm.k8ssandra.io/"
	// RepoName is the name of k8ssandra's helm repo chart
	K8ssandraRepoName = "k8ssandra"
)

const (
	AllSubCharts = "_"
)

Functions

func ChartVersion

func ChartVersion(cfg *action.Configuration, releaseName string) (*chart.Chart, error)

ChartVersion gets the release's chart version or returns an error if it did not exist

func DownloadChartRelease

func DownloadChartRelease(repoName, repoURL, chartName, chartVersion string, options ...getter.Option) (string, error)

DownloadChartRelease fetches the k8ssandra target version and extracts it to a directory which path is returned

func ExtractChartRelease

func ExtractChartRelease(saved, repoName, chartName, chartVersion string) (string, error)

func GetChartTargetDir

func GetChartTargetDir(repoName, chartName string) (string, error)

func Install

func Install(cfg *action.Configuration, releaseName, path, namespace string, values map[string]interface{}, devel bool, skipCRDs bool, timeout time.Duration) (*release.Release, error)

func ListInstallations

func ListInstallations(cfg *action.Configuration) ([]*release.Release, error)

func MergeValuesFile

func MergeValuesFile(cfg *action.Configuration, settings *cli.EnvSettings, chartDir, chartVersion, chartName, releaseName string) (*os.File, error)

func Release

func Release(cfg *action.Configuration, releaseName string) (*release.Release, error)

func SetValues

func SetValues(cfg *action.Configuration, releaseName string) (map[string]interface{}, error)

SetValues returns the deployed Helm releases modified values

func Uninstall

func Uninstall(cfg *action.Configuration, releaseName string) (*release.UninstallReleaseResponse, error)

func UpgradeValues

func UpgradeValues(cfg *action.Configuration, chartDir, chartName, releaseName string, inputValues *os.File) (*release.Release, error)

func ValuesYaml

func ValuesYaml(chartVersion string) (io.Reader, error)

ValuesYaml fetches the chartVersion's values.yaml file for editing purposes

Types

type Upgrader

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

Upgrader is a utility to update the CRDs in a helm chart's pre-upgrade hook

func NewUpgrader

func NewUpgrader(c client.Client, repoName, repoURL, chartName string, subCharts []string) (*Upgrader, error)

NewUpgrader returns a new Upgrader client

func (*Upgrader) Upgrade

func (u *Upgrader) Upgrade(ctx context.Context, chartVersion string) ([]unstructured.Unstructured, error)

Upgrade installs the missing CRDs or updates them if they exists already