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.

Package helm contains operations for working with helm charts.

Index

• func Destroy(purgeAllZarfInstallations bool)
• func DownloadChartFromGitToTemp(url string, spinner *message.Spinner) (string, error)
• func FindAnnotatedImagesForChart(chartPath string, values chartutil.Values) (images []string, err error)
• func StandardName(destination string, chart types.ZarfChart) string
• func StandardValuesName(destination string, chart types.ZarfChart, idx int) string
• type ChartImages
• type Helm
  • func New(chart types.ZarfChart, chartPath string, valuesPath string, mods ...Modifier) *Helm
  • func NewClusterOnly(cfg *types.PackagerConfig, cluster *cluster.Cluster) *Helm
  • func NewFromZarfManifest(manifest types.ZarfManifest, manifestPath, packageName, componentName string, ...) (h *Helm, err error)
  • func (h *Helm) DownloadPublishedChart(cosignKeyPath string) error
  • func (h *Helm) InstallOrUpgradeChart() (types.ConnectStrings, string, error)
  • func (h *Helm) PackageChart(cosignKeyPath string) error
  • func (h *Helm) PackageChartFromGit(cosignKeyPath string) error
  • func (h *Helm) PackageChartFromLocalFiles(cosignKeyPath string) error
  • func (h *Helm) RemoveChart(namespace string, name string, spinner *message.Spinner) error
  • func (h *Helm) TemplateChart() (manifest string, chartValues chartutil.Values, err error)
  • func (h *Helm) UpdateReleaseValues(updatedValues map[string]interface{}) error
  • func (h *Helm) UpdateZarfAgentValues() error
  • func (h *Helm) UpdateZarfRegistryValues() error
• type Modifier
  • func WithDeployInfo(component types.ZarfComponent, cfg *types.PackagerConfig, ...) Modifier
  • func WithKubeVersion(kubeVersion string) Modifier
  • func WithPackageConfig(cfg *types.PackagerConfig) Modifier

Functions

func Destroy

func Destroy(purgeAllZarfInstallations bool)

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

func DownloadChartFromGitToTemp

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

DownloadChartFromGitToTemp downloads a chart from git into a temp directory

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.

func StandardValuesName

func StandardValuesName(destination string, chart types.ZarfChart, idx int) string

StandardValuesName generates a predictable full path for the values file 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 {
	// contains filtered or unexported fields
}

Helm is a config object for working with helm charts.

func New

func New(chart types.ZarfChart, chartPath string, valuesPath string, mods ...Modifier) *Helm

New returns a new Helm config struct.

func NewClusterOnly

func NewClusterOnly(cfg *types.PackagerConfig, cluster *cluster.Cluster) *Helm

NewClusterOnly returns a new Helm config struct geared toward interacting with the cluster (not packages)

func NewFromZarfManifest

func NewFromZarfManifest(manifest types.ZarfManifest, manifestPath, packageName, componentName string, mods ...Modifier) (h *Helm, err error)

NewFromZarfManifest generates a helm chart and config from a given Zarf manifest.

func (*Helm) DownloadPublishedChart

func (h *Helm) DownloadPublishedChart(cosignKeyPath string) error

DownloadPublishedChart loads a specific chart version from a remote repo.

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(cosignKeyPath 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(cosignKeyPath 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(cosignKeyPath 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() (manifest string, chartValues chartutil.Values, err error)

TemplateChart generates a helm template from a given chart.

func (*Helm) UpdateReleaseValues

func (h *Helm) UpdateReleaseValues(updatedValues map[string]interface{}) error

UpdateReleaseValues updates values for a given chart release (note: this only works on single-deep charts, charts with dependencies (like loki-stack) will not work)

func (*Helm) UpdateZarfAgentValues

func (h *Helm) UpdateZarfAgentValues() error

UpdateZarfAgentValues updates the Zarf agent deployment with the new state values

func (*Helm) UpdateZarfRegistryValues

func (h *Helm) UpdateZarfRegistryValues() error

UpdateZarfRegistryValues updates the Zarf registry deployment with the new state values

type Modifier

type Modifier func(*Helm)

Modifier is a function that modifies the Helm config.

func WithDeployInfo

func WithDeployInfo(component types.ZarfComponent, cfg *types.PackagerConfig, cluster *cluster.Cluster, valuesOverrides map[string]any, timeout time.Duration, retries int) Modifier

WithDeployInfo adds the necessary information to deploy a given chart

func WithKubeVersion

func WithKubeVersion(kubeVersion string) Modifier

WithKubeVersion sets the Kube version for templating the chart

func WithPackageConfig

func WithPackageConfig(cfg *types.PackagerConfig) Modifier

WithPackageConfig sets the packager config for the chart