helm
Installation
Entrypoint
Entrypoint
Entrypoint
Types
Helm
ChartValues
Chart

helm

No long description provided.

Installation

dagger install github.com/dagger/helm@d0a7e172e8212b31c6061bb699495b1e8ba0958f

Entrypoint

Return Type

Helm !

Arguments

Name	Type	Default Value	Description
version	String	-	The version of Helm to use.
valuesGlob	String	-	Glob for chart values files to check as extra matrix dimensions. Defaults to Helm chart-testing's CI values convention: https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md

Example

dagger -m github.com/dagger/helm@d0a7e172e8212b31c6061bb699495b1e8ba0958f call \

func (m *MyModule) Example() *dagger.Helm  {
	return dag.
			Helm()
}

@function
def example() -> dagger.Helm:
	return (
		dag.helm()
	)

@func()
example(): Helm {
	return dag
		.helm()
}

Entrypoint

Return Type

ChartValues !

Arguments

Name	Type	Default Value	Description
path	String !	-	Path to the custom values file, relative to the chart root.
source	Directory !	-	Chart source directory.
version	String !	-	Helm version to use.

Example

Function ChartValues.Constructor is not accessible from the helm module

Function ChartValues.Constructor is not accessible from the helm module

Function ChartValues.Constructor is not accessible from the helm module

Function ChartValues.Constructor is not accessible from the helm module

Entrypoint

Return Type

Chart !

Arguments

Name	Type	Default Value	Description
path	String !	-	Path of the chart directory in the workspace.
version	String !	-	Helm version to use.
valuesGlob	String !	-	Glob for chart values files to check as extra matrix dimensions.
source	Directory !	-	Chart source directory.

Example

Function Chart.Constructor is not accessible from the helm module

Function Chart.Constructor is not accessible from the helm module

Function Chart.Constructor is not accessible from the helm module

Function Chart.Constructor is not accessible from the helm module

Types

Helm 🔗

A Dagger module for Helm: a package manager for Kubernetes. https://helm.sh

version() 🔗

The version of Helm to use.

Return Type

String !

Example

dagger -m github.com/dagger/helm@d0a7e172e8212b31c6061bb699495b1e8ba0958f call \
 version

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Helm().
			Version(ctx)
}

@function
async def example() -> str:
	return await (
		dag.helm()
		.version()
	)

@func()
async example(): Promise<string> {
	return dag
		.helm()
		.version()
}

valuesGlob() 🔗

Glob for chart values files to check as extra matrix dimensions.

Defaults to Helm chart-testing’s CI values convention: https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md

Return Type

String !

Example

dagger -m github.com/dagger/helm@d0a7e172e8212b31c6061bb699495b1e8ba0958f call \
 values-glob

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Helm().
			ValuesGlob(ctx)
}

@function
async def example() -> str:
	return await (
		dag.helm()
		.values_glob()
	)

@func()
async example(): Promise<string> {
	return dag
		.helm()
		.valuesGlob()
}

charts() 🔗

Scan the workspace for Helm charts.

Return Type

[Chart ! ] !

Arguments

Name	Type	Default Value	Description
ws	Workspace	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example() []*dagger.HelmChart  {
	return dag.
			Helm().
			Charts()
}

@function
def example() -> List[dagger.HelmChart]:
	return (
		dag.helm()
		.charts()
	)

@func()
example(): HelmChart[] {
	return dag
		.helm()
		.charts()
}

chart() 🔗

Return one discovered chart by its workspace-relative path.

Return Type

Chart !

Arguments

Name	Type	Default Value	Description
ws	Workspace	-	No description provided
path	String !	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(path string) *dagger.HelmChart  {
	return dag.
			Helm().
			Chart(path)
}

@function
def example(path: str) -> dagger.HelmChart:
	return (
		dag.helm()
		.chart(path)
	)

@func()
example(path: string): HelmChart {
	return dag
		.helm()
		.chart(path)
}

lint() 🔗

Lint every discovered Helm chart in the workspace.

Return Type

Void !

Arguments

Name	Type	Default Value	Description
ws	Workspace	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			Helm().
			Lint(ctx)
}

@function
async def example() -> None:
	return await (
		dag.helm()
		.lint()
	)

@func()
async example(): Promise<void> {
	return dag
		.helm()
		.lint()
}

assertTemplate() 🔗

Assert every discovered values file renders with helm template –dry-run=client.

Return Type

Void !

Arguments

Name	Type	Default Value	Description
ws	Workspace	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			Helm().
			AssertTemplate(ctx)
}

@function
async def example() -> None:
	return await (
		dag.helm()
		.assert_template()
	)

@func()
async example(): Promise<void> {
	return dag
		.helm()
		.assertTemplate()
}

ChartValues 🔗

A values dimension for Helm chart checks.

path() 🔗

Path to the custom values file, relative to the chart root.

Return Type

String !

Example

Function HelmChartValues.path is not accessible from the helm module

Function HelmChartValues.path is not accessible from the helm module

Function HelmChartValues.path is not accessible from the helm module

Function HelmChartValues.path is not accessible from the helm module

lint() 🔗

Run helm lint for this values dimension.

Return Type

Void !

Example

Function HelmChartValues.lint is not accessible from the helm module

Function HelmChartValues.lint is not accessible from the helm module

Function HelmChartValues.lint is not accessible from the helm module

Function HelmChartValues.lint is not accessible from the helm module

assertTemplate() 🔗

Assert this values file renders with helm template –dry-run=client.

Return Type

Void !

Example

Function HelmChartValues.assertTemplate is not accessible from the helm module

Function HelmChartValues.assertTemplate is not accessible from the helm module

Function HelmChartValues.assertTemplate is not accessible from the helm module

Function HelmChartValues.assertTemplate is not accessible from the helm module

Chart 🔗

A discovered Helm chart in the workspace.

path() 🔗

Path of the chart directory in the workspace.

Return Type

String !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context, path string) string  {
	return dag.
			Helm().
			Chart(path).
			Path(ctx)
}

@function
async def example(path: str) -> str:
	return await (
		dag.helm()
		.chart(path)
		.path()
	)

@func()
async example(path: string): Promise<string> {
	return dag
		.helm()
		.chart(path)
		.path()
}

lint() 🔗

Run helm lint on this chart.

Return Type

Void !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context, path string)   {
	return dag.
			Helm().
			Chart(path).
			Lint(ctx)
}

@function
async def example(path: str) -> None:
	return await (
		dag.helm()
		.chart(path)
		.lint()
	)

@func()
async example(path: string): Promise<void> {
	return dag
		.helm()
		.chart(path)
		.lint()
}

values() 🔗

Values dimensions for this chart’s check matrix.

Defaults to chart-testing’s convention: chart-root ci/*-values.yaml files.

Return Type

[ChartValues ! ] !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(path string) []*dagger.HelmChartValues  {
	return dag.
			Helm().
			Chart(path).
			Values()
}

@function
def example(path: str) -> List[dagger.HelmChartValues]:
	return (
		dag.helm()
		.chart(path)
		.values()
	)

@func()
example(path: string): HelmChartValues[] {
	return dag
		.helm()
		.chart(path)
		.values()
}

assertTemplate() 🔗

Assert every discovered values file renders with helm template –dry-run=client.

This intentionally skips the bare chart. Some charts only render cleanly with one of their explicit values files.

Return Type

Void !

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context, path string)   {
	return dag.
			Helm().
			Chart(path).
			AssertTemplate(ctx)
}

@function
async def example(path: str) -> None:
	return await (
		dag.helm()
		.chart(path)
		.assert_template()
	)

@func()
async example(path: string): Promise<void> {
	return dag
		.helm()
		.chart(path)
		.assertTemplate()
}