kaddons

Documentation

Index

• func AddHelmChart(scope kgen.Scope, props HelmChartProps)
• func SetOptions(scope kgen.Scope, opts Options)
• type HelmChartInfo
• type HelmChartProps
• type Options

Functions

func AddHelmChart

func AddHelmChart(scope kgen.Scope, props HelmChartProps)

AddHelmChart runs helm template and adds the generated objects to the scope.

func SetOptions

func SetOptions(scope kgen.Scope, opts Options)

SetOptions sets the options for kaddons.

Types

type HelmChartInfo

type HelmChartInfo struct {
	// Repo is the helm chart repository
	Repo string
	// Chart is the helm chart name
	Chart string
	// Version is the helm chart version
	Version string
}

HelmChartInfo represents the information required to fetch a helm chart

type HelmChartProps

type HelmChartProps struct {
	// ChartInfo is the information required to fetch a helm chart.
	ChartInfo HelmChartInfo
	// ChartFileNamePrefix is the prefix to be used for the chart file name.
	ChartFileNamePrefix string
	// ReleaseName is the release name to be used while executing helm template.
	ReleaseName string
	// Namespace is the namespace to be used while executing helm template. Defaults to the scope's namespace.
	Namespace string
	// Values is the values to be passed to helm template.
	Values map[string]interface{}
	// PatchObject is the function to be used to patch the object before adding it to the scope. Default is nil.
	PatchObject func(obj runtime.Object) error
}

HelmChartProps represents the properties required to add a helm chart to the scope.

type Options

type Options struct {
	// CacheDir is the directory where the cache (downloaded helm charts) is stored. Default is os.TempDir() + "/kgen-cache".
	CacheDir string
	// HelmKubeVersion is the kubernetes version passed to helm (kube-version arg) while running helm template. Default is "v1.30.2".
	HelmKubeVersion string
	// contains filtered or unexported fields
}

Options for kaddons.