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 FindAnnotatedImagesForChart(chartPath string, values chartutil.Values) (images []string, err error)
• func StandardName(destination string, chart types.ZarfChart) string
• type ChartImages
• type Helm
  • func (h *Helm) Destroy(purgeAllZarfInstallations bool)
  • func (h *Helm) DownloadChartFromGitToTemp(spinner *message.Spinner) (string, error)
  • func (h *Helm) DownloadPublishedChart(destination string)
  • func (h *Helm) GenerateChart(manifest types.ZarfManifest) error
  • func (h *Helm) InstallOrUpgradeChart() (types.ConnectStrings, string, error)
  • func (h *Helm) PackageChart(destination string) error
  • func (h *Helm) PackageChartFromGit(destination string) (string, error)
  • func (h *Helm) PackageChartFromLocalFiles(destination string) (string, error)
  • func (h *Helm) RemoveChart(namespace string, name string, spinner *message.Spinner) error
  • func (h *Helm) TemplateChart() (string, chartutil.Values, error)

Functions

func FindAnnotatedImagesForChart

func FindAnnotatedImagesForChart(chartPath string, values chartutil.Values) (images []string, err error)

FindAnnotatedImagesForChart attempts to parse any image annotations found in a chart archive or directory.

func StandardName

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

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

Types

type ChartImages

type ChartImages []struct {
	// Name of the image.
	Name string `yaml:"name"`
	// Image with tag.
	Image string `yaml:"image"`
	// Condition specifies the values to determine if the image is included or not.
	Condition string `yaml:"condition"`
	// Dependency is the subchart that contains the image, if empty its the parent chart.
	Dependency string `yaml:"dependency"`
}

ChartImages captures the structure of the helm.sh/images annotation within the Helm chart.

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
	KubeVersion       string
	Settings          *cli.EnvSettings
	// contains filtered or unexported fields
}

Helm is a config object for working with helm charts.

func (*Helm) Destroy

func (h *Helm) Destroy(purgeAllZarfInstallations bool)

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

func (*Helm) DownloadChartFromGitToTemp

func (h *Helm) DownloadChartFromGitToTemp(spinner *message.Spinner) (string, error)

DownloadChartFromGitToTemp downloads a chart from git into a temp directory

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) 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) PackageChart

func (h *Helm) PackageChart(destination string) error

PackageChart creates a chart archive from a path to a chart on the host os and builds chart dependencies

func (*Helm) PackageChartFromGit

func (h *Helm) PackageChartFromGit(destination string) (string, error)

PackageChartFromGit is a special implementation of chart archiving that supports the https://p1.dso.mil/#/products/big-bang/ model.

func (*Helm) PackageChartFromLocalFiles

func (h *Helm) PackageChartFromLocalFiles(destination string) (string, error)

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

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, chartutil.Values, error)

TemplateChart generates a helm template from a given chart.