Dagger
Search

helm

The package manager for Kubernetes.

Installation

dagger install github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9

Entrypoint

Return Type 
Helm !
Arguments
NameTypeDescription
versionString Version (image tag) to use from the official image repository as a base container.
imageString Custom image reference in "repository:tag" format to use as a base container.
containerContainer Custom container to use as a base container.
Example
func (m *myModule) example() *Helm  {
	return dag.
			Helm()
}
@function
def example() -> dag.Helm:
	return (
		dag.helm()
	)
@func()
example(): Helm {
	return dag
		.helm()
}

Types

Helm

container()

Return Type 
Container !
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 container
func (m *myModule) example() *Container  {
	return dag.
			Helm().
			Container()
}
@function
def example() -> dagger.Container:
	return (
		dag.helm()
		.container()
	)
@func()
example(): Container {
	return dag
		.helm()
		.container()
}

create()

Create a new chart directory along with the common files and directories used in a chart.

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 create --name string
func (m *myModule) example(name string) *Directory  {
	return dag.
			Helm().
			Create(name)
}
@function
def example(name: str) -> dagger.Directory:
	return (
		dag.helm()
		.create(name)
	)
@func()
example(name: string): Directory {
	return dag
		.helm()
		.create(name)
}

lint()

Lint a Helm chart directory.

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
chartDirectory !-A directory containing a Helm chart.
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 lint --chart DIR_PATH
func (m *myModule) example(chart *Directory) *Container  {
	return dag.
			Helm().
			Lint(chart)
}
@function
def example(chart: dagger.Directory) -> dagger.Container:
	return (
		dag.helm()
		.lint(chart)
	)
@func()
example(chart: Directory): Container {
	return dag
		.helm()
		.lint(chart)
}

package()

Build a Helm chart package.

Return Type 
File !
Arguments
NameTypeDefault ValueDescription
chartDirectory !-A directory containing a Helm chart.
appVersionString -Set the appVersion on the chart to this version.
versionString -Set the version on the chart to this semver version.
dependencyUpdateBoolean -Update dependencies from "Chart.yaml" to dir "charts/" before packaging.
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 package --chart DIR_PATH
func (m *myModule) example(chart *Directory) *File  {
	return dag.
			Helm().
			Package(chart)
}
@function
def example(chart: dagger.Directory) -> dagger.File:
	return (
		dag.helm()
		.package(chart)
	)
@func()
example(chart: Directory): File {
	return dag
		.helm()
		.package(chart)
}

login()

Authenticate to an OCI registry.

Return Type 
Helm !
Arguments
NameTypeDefault ValueDescription
hostString !-Host of the OCI registry.
usernameString !-Registry username.
passwordSecret !-Registry password.
insecureBoolean -Allow connections to TLS registry without certs.
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 login --host string --username string --password env:MYSECRET \
 container
func (m *myModule) example(host string, username string, password *Secret) *Helm  {
	return dag.
			Helm().
			Login(host, username, password)
}
@function
def example(host: str, username: str, password: dagger.Secret) -> dag.Helm:
	return (
		dag.helm()
		.login(host, username, password)
	)
@func()
example(host: string, username: string, password: Secret): Helm {
	return dag
		.helm()
		.login(host, username, password)
}

logout()

Remove credentials stored for an OCI registry.

Return Type 
Helm !
Arguments
NameTypeDefault ValueDescription
hostString !-No description provided
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 logout --host string \
 container
func (m *myModule) example(host string) *Helm  {
	return dag.
			Helm().
			Logout(host)
}
@function
def example(host: str) -> dag.Helm:
	return (
		dag.helm()
		.logout(host)
	)
@func()
example(host: string): Helm {
	return dag
		.helm()
		.logout(host)
}

push()

Push a Helm chart package to an OCI registry.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
pkgFile !-Packaged Helm chart.
registryString !-OCI registry to push to (including the path except the chart name).
plainHttpBoolean -Use insecure HTTP connections for the chart upload.
insecureSkipTlsVerifyBoolean -Skip tls certificate checks for the chart upload.
caFileFile -Verify certificates of HTTPS-enabled servers using this CA bundle.
certFileFile -Identify registry client using this SSL certificate file.
keyFileFile -Identify registry client using this SSL key file.
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 push --pkg file:path --registry string
func (m *myModule) example(ctx context.Context, pkg *File, registry string)   {
	return dag.
			Helm().
			Push(ctx, pkg, registry)
}
@function
async def example(pkg: dagger.File, registry: str) -> None:
	return await (
		dag.helm()
		.push(pkg, registry)
	)
@func()
async example(pkg: File, registry: string): Promise<void> {
	return dag
		.helm()
		.push(pkg, registry)
}

chart()

Returns a Helm chart from a source directory.

Return Type 
Chart !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-A directory containing a Helm chart.
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 chart --source DIR_PATH \
 lint
func (m *myModule) example(source *Directory) *HelmChart  {
	return dag.
			Helm().
			Chart(source)
}
@function
def example(source: dagger.Directory) -> dag.HelmChart:
	return (
		dag.helm()
		.chart(source)
	)
@func()
example(source: Directory): HelmChart {
	return dag
		.helm()
		.chart(source)
}

Chart

A Helm chart.

directory()

Return Type 
Directory !
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 chart --source DIR_PATH \
 directory
func (m *myModule) example(source *Directory) *Directory  {
	return dag.
			Helm().
			Chart(source).
			Directory()
}
@function
def example(source: dagger.Directory) -> dagger.Directory:
	return (
		dag.helm()
		.chart(source)
		.directory()
	)
@func()
example(source: Directory): Directory {
	return dag
		.helm()
		.chart(source)
		.directory()
}

lint()

Lint a Helm chart.

Return Type 
Container !
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 chart --source DIR_PATH \
 lint
func (m *myModule) example(source *Directory) *Container  {
	return dag.
			Helm().
			Chart(source).
			Lint()
}
@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.helm()
		.chart(source)
		.lint()
	)
@func()
example(source: Directory): Container {
	return dag
		.helm()
		.chart(source)
		.lint()
}

package()

Build a Helm chart package.

Return Type 
Package !
Arguments
NameTypeDefault ValueDescription
appVersionString -Set the appVersion on the chart to this version.
versionString -Set the version on the chart to this semver version.
dependencyUpdateBoolean -Update dependencies from "Chart.yaml" to dir "charts/" before packaging.
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 chart --source DIR_PATH \
 package \
 publish --registry string
func (m *myModule) example(source *Directory) *HelmPackage  {
	return dag.
			Helm().
			Chart(source).
			Package()
}
@function
def example(source: dagger.Directory) -> dag.HelmPackage:
	return (
		dag.helm()
		.chart(source)
		.package()
	)
@func()
example(source: Directory): HelmPackage {
	return dag
		.helm()
		.chart(source)
		.package()
}

Package

A Helm chart package.

file()

Return Type 
File !
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 chart --source DIR_PATH \
 package \
 file
func (m *myModule) example(source *Directory) *File  {
	return dag.
			Helm().
			Chart(source).
			Package().
			File()
}
@function
def example(source: dagger.Directory) -> dagger.File:
	return (
		dag.helm()
		.chart(source)
		.package()
		.file()
	)
@func()
example(source: Directory): File {
	return dag
		.helm()
		.chart(source)
		.package()
		.file()
}

withRegistryAuth()

Authenticate to an OCI registry.

Return Type 
Package !
Arguments
NameTypeDefault ValueDescription
hostString !-Host of the OCI registry.
usernameString !-Registry username.
passwordSecret !-Registry password.
insecureBoolean -Allow connections to TLS registry without certs.
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 chart --source DIR_PATH \
 package \
 with-registry-auth --host string --username string --password env:MYSECRET \
 publish --registry string
func (m *myModule) example(source *Directory, host string, username string, password *Secret) *HelmPackage  {
	return dag.
			Helm().
			Chart(source).
			Package().
			WithRegistryAuth(host, username, password)
}
@function
def example(source: dagger.Directory, host: str, username: str, password: dagger.Secret) -> dag.HelmPackage:
	return (
		dag.helm()
		.chart(source)
		.package()
		.with_registry_auth(host, username, password)
	)
@func()
example(source: Directory, host: string, username: string, password: Secret): HelmPackage {
	return dag
		.helm()
		.chart(source)
		.package()
		.withRegistryAuth(host, username, password)
}

withoutRegistryAuth()

Remove credentials stored for an OCI registry.

Return Type 
Package !
Arguments
NameTypeDefault ValueDescription
hostString !-No description provided
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 chart --source DIR_PATH \
 package \
 without-registry-auth --host string \
 publish --registry string
func (m *myModule) example(source *Directory, host string) *HelmPackage  {
	return dag.
			Helm().
			Chart(source).
			Package().
			WithoutRegistryAuth(host)
}
@function
def example(source: dagger.Directory, host: str) -> dag.HelmPackage:
	return (
		dag.helm()
		.chart(source)
		.package()
		.without_registry_auth(host)
	)
@func()
example(source: Directory, host: string): HelmPackage {
	return dag
		.helm()
		.chart(source)
		.package()
		.withoutRegistryAuth(host)
}

publish()

Publishes this Helm chart package to an OCI registry.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
registryString !-OCI registry to push to (including the path except the chart name).
plainHttpBoolean -Use insecure HTTP connections for the chart upload.
insecureSkipTlsVerifyBoolean -Skip tls certificate checks for the chart upload.
caFileFile -Verify certificates of HTTPS-enabled servers using this CA bundle.
certFileFile -Identify registry client using this SSL certificate file.
keyFileFile -Identify registry client using this SSL key file.
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 chart --source DIR_PATH \
 package \
 publish --registry string
func (m *myModule) example(ctx context.Context, source *Directory, registry string)   {
	return dag.
			Helm().
			Chart(source).
			Package().
			Publish(ctx, registry)
}
@function
async def example(source: dagger.Directory, registry: str) -> None:
	return await (
		dag.helm()
		.chart(source)
		.package()
		.publish(registry)
	)
@func()
async example(source: Directory, registry: string): Promise<void> {
	return dag
		.helm()
		.chart(source)
		.package()
		.publish(registry)
}