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.

Index

• func DownloadChartFromGitToTemp(ctx context.Context, url string) (string, error)
• func FindAnnotatedImagesForChart(chartPath string, values chartutil.Values) (images []string, err error)
• func StandardName(destination string, chart v1alpha1.ZarfChart) string
• func StandardValuesName(destination string, chart v1alpha1.ZarfChart, idx int) string
• type ChartImages
• type Helm
  • func New(chart v1alpha1.ZarfChart, chartPath string, valuesPath string, ...) *Helm
  • func (h *Helm) PackageChartFromGit(ctx context.Context, cosignKeyPath string) error
  • func (h *Helm) PackageChartFromLocalFiles(ctx context.Context, cosignKeyPath string) error
  • func (h *Helm) TemplateChart() (manifest string, chartValues chartutil.Values, err error)
• type Modifier
  • func WithKubeVersion(kubeVersion string) Modifier

Functions

func DownloadChartFromGitToTemp

func DownloadChartFromGitToTemp(ctx context.Context, url string) (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 v1alpha1.ZarfChart) string

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

func StandardValuesName

func StandardValuesName(destination string, chart v1alpha1.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 v1alpha1.ZarfChart, chartPath string, valuesPath string, mods ...Modifier) *Helm

New returns a new Helm config struct.

func (*Helm) PackageChartFromGit

func (h *Helm) PackageChartFromGit(ctx context.Context, cosignKeyPath string) error

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

func (*Helm) PackageChartFromLocalFiles

func (h *Helm) PackageChartFromLocalFiles(ctx context.Context, cosignKeyPath string) error

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

func (*Helm) TemplateChart

func (h *Helm) TemplateChart() (manifest string, chartValues chartutil.Values, err error)

TemplateChart generates a helm template from a given chart.

type Modifier

type Modifier func(*Helm)

Modifier is a function that modifies the Helm config.

func WithKubeVersion

func WithKubeVersion(kubeVersion string) Modifier

WithKubeVersion sets the Kube version for templating the chart