helm

Documentation

Overview

Package helm contains operations for working with helm charts.

Package helm contains operations for working with helm charts.

Package helm contains operations for working with helm charts.

Package helm contains operations for working with helm charts.

Package helm contains operations for working with helm charts.

Package helm contains operations for working with helm charts.

Index

• func StandardName(destination string, chart types.ZarfChart) string
• type Helm
  • func (h *Helm) CreateChartFromLocalFiles(destination string) string
  • func (h *Helm) Destroy(purgeAllZarfInstallations bool)
  • func (h *Helm) DownloadChartFromGit(destination string) string
  • func (h *Helm) DownloadPublishedChart(destination string)
  • func (h *Helm) GenerateChart(manifest types.ZarfManifest) (types.ConnectStrings, string, error)
  • func (h *Helm) InstallOrUpgradeChart() (types.ConnectStrings, string, error)
  • func (h *Helm) RemoveChart(namespace string, name string, spinner *message.Spinner) error
  • func (h *Helm) TemplateChart() (string, error)

Functions

func StandardName

func StandardName(destination string, chart types.ZarfChart) string

StandardName generates a predictable full path for a helm chart for Zarf.

Types

type Helm

type Helm struct {
	BasePath          string
	Chart             types.ZarfChart
	ReleaseName       string
	ChartLoadOverride string
	ChartOverride     *chart.Chart
	ValueOverride     map[string]any
	Component         types.ZarfComponent
	Cluster           *cluster.Cluster
	Cfg               *types.PackagerConfig
	// contains filtered or unexported fields
}

Helm is a config object for working with helm charts.

func (*Helm) CreateChartFromLocalFiles

func (h *Helm) CreateChartFromLocalFiles(destination string) string

CreateChartFromLocalFiles creates a chart archive from a path to a chart on the host os.

func (*Helm) Destroy

func (h *Helm) Destroy(purgeAllZarfInstallations bool)

Destroy removes ZarfInitPackage charts from the cluster and optionally all Zarf-installed charts.

func (*Helm) DownloadChartFromGit

func (h *Helm) DownloadChartFromGit(destination string) string

DownloadChartFromGit is a special implementation of chart downloads that support the https://p1.dso.mil/#/products/big-bang/ model.

func (*Helm) DownloadPublishedChart

func (h *Helm) DownloadPublishedChart(destination string)

DownloadPublishedChart loads a specific chart version from a remote repo.

func (*Helm) GenerateChart

func (h *Helm) GenerateChart(manifest types.ZarfManifest) (types.ConnectStrings, string, error)

GenerateChart generates a helm chart for a given Zarf manifest.

func (*Helm) InstallOrUpgradeChart

func (h *Helm) InstallOrUpgradeChart() (types.ConnectStrings, string, error)

InstallOrUpgradeChart performs a helm install of the given chart.

func (*Helm) RemoveChart

func (h *Helm) RemoveChart(namespace string, name string, spinner *message.Spinner) error

RemoveChart removes a chart from the cluster.

func (*Helm) TemplateChart

func (h *Helm) TemplateChart() (string, error)

TemplateChart generates a helm template from a given chart.