helm

The package manager for Kubernetes.

Example (Create)

no available example in current language

func (m *Examples) Helm_Create(ctx context.Context) error {
	chart := dag.Helm().Create("foo")

	_, err := chart.Package(dagger.HelmChartPackageOpts{
		AppVersion: "1.0.0",
		Version:    "1.0.0",
	}).File().Sync(ctx)

	return err
}

no available example in current language

no available example in current language

Installation

dagger install github.com/sagikazarmark/daggerverse/helm@v0.10.0

Entrypoint

Return Type

Helm !

Arguments

Name	Type	Description
version	String	Version (image tag) to use from the official image repository as a base container.
container	Container	Custom container to use as a base container.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \

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@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f 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()
}

withRegistryAuth() 🔗

Add credentials for a registry.

Note: WithRegistryAuth overrides any previous or subsequent calls to Login/Logout.

Return Type

Helm !

Arguments

Name	Type	Default Value	Description
address	String !	-	No description provided
username	String !	-	No description provided
secret	Secret !	-	No description provided

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 with-registry-auth --address string --username string --secret env:MYSECRET

func (m *myModule) example(address string, username string, secret *Secret) *Helm  {
	return dag.
			Helm().
			WithRegistryAuth(address, username, secret)
}

@function
def example(address: str, username: str, secret: dagger.Secret) -> dag.Helm:
	return (
		dag.helm()
		.with_registry_auth(address, username, secret)
	)

@func()
example(address: string, username: string, secret: Secret): Helm {
	return dag
		.helm()
		.withRegistryAuth(address, username, secret)
}

withoutRegistryAuth() 🔗

Removes credentials for a registry.

Return Type

Helm !

Arguments

Name	Type	Default Value	Description
address	String !	-	No description provided

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 without-registry-auth --address string

func (m *myModule) example(address string) *Helm  {
	return dag.
			Helm().
			WithoutRegistryAuth(address)
}

@function
def example(address: str) -> dag.Helm:
	return (
		dag.helm()
		.without_registry_auth(address)
	)

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

create() 🔗

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

Return Type

Chart !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 create --name string

func (m *myModule) example(name string) *HelmChart  {
	return dag.
			Helm().
			Create(name)
}

@function
def example(name: str) -> dag.HelmChart:
	return (
		dag.helm()
		.create(name)
	)

@func()
example(name: string): HelmChart {
	return dag
		.helm()
		.create(name)
}

lint() 🔗

Lint a Helm chart directory.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
chart	Directory !	-	A directory containing a Helm chart.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f 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

Name	Type	Default Value	Description
chart	Directory !	-	A directory containing a Helm chart.
appVersion	String	-	Set the appVersion on the chart to this version.
version	String	-	Set the version on the chart to this semver version.
dependencyUpdate	Boolean	-	Update dependencies from "Chart.yaml" to dir "charts/" before packaging.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f 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)
}

Authenticate to an OCI registry.

Note: Login stores credentials in the filesystem in plain text. Use WithRegistryAuth as a safer alternative.

Return Type

Helm !

Arguments

Name	Type	Default Value	Description
host	String !	-	Host of the OCI registry.
username	String !	-	Registry username.
password	Secret !	-	Registry password.
insecure	Boolean	-	Allow connections to TLS registry without certs.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 login --host string --username string --password env:MYSECRET

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

Name	Type	Default Value	Description
host	String !	-	No description provided

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 logout --host string

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

Name	Type	Default Value	Description
pkg	File !	-	Packaged Helm chart.
registry	String !	-	OCI registry to push to (including the path except the chart name).
plainHttp	Boolean	-	Use insecure HTTP connections for the chart upload.
insecureSkipTlsVerify	Boolean	-	Skip tls certificate checks for the chart upload.
caFile	File	-	Verify certificates of HTTPS-enabled servers using this CA bundle.
certFile	File	-	Identify registry client using this SSL certificate file.
keyFile	Secret	-	Identify registry client using this SSL key file.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f 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

Name	Type	Default Value	Description
source	Directory !	-	A directory containing a Helm chart.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 chart --source DIR_PATH

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@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f 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@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f 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

Name	Type	Default Value	Description
appVersion	String	-	Set the appVersion on the chart to this version.
version	String	-	Set the version on the chart to this semver version.
dependencyUpdate	Boolean	-	Update dependencies from "Chart.yaml" to dir "charts/" before packaging.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 chart --source DIR_PATH \
 package

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()
}

install() 🔗

Install a Helm chart.

Return Type

Release !

Arguments

Name	Type	Default Value	Description
name	String !	-	Helm release name.
atomic	Boolean	-	If set, the installation process deletes the installation on failure. Wait flag will be set automatically if atomic is used.
caFile	File	-	Verify certificates of HTTPS-enabled servers using this CA bundle.
certFile	File	-	Identify HTTPS client using this SSL certificate file.
createNamespace	Boolean	-	Create the release namespace if not present.
dependencyUpdate	Boolean	-	Update dependencies if they are missing before installing the chart.
description	String	-	Add a custom description.
disableOpenapiValidation	Boolean	-	If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema.
enableDns	Boolean	-	Enable DNS lookups when rendering templates.
force	Boolean	-	Force resource updates through a replacement strategy.
generateName	Boolean	-	Generate the name.
insecureSkipTlsVerify	Boolean	-	Skip tls certificate checks for the chart download.
keyFile	Secret	-	Identify HTTPS client using this SSL key file.
labels	[String ! ]	-	Labels that would be added to release metadata.
nameTemplate	String	-	Specify template used to name the release.
noHooks	Boolean	-	Prevent hooks from running during install.
plainHttp	Boolean	-	Use insecure HTTP connections for the chart download.
postRenderer	String	-	The path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path.
postRendererArgs	[String ! ]	-	Arguments to the post-renderer.
renderSubchartNotes	Boolean	-	If set, render subchart notes along with the parent.
replace	Boolean	-	Re-use the given name, only if that name is a deleted release which remains in the history. This is unsafe in production.
skipCrds	Boolean	-	If set, no CRDs will be installed. By default, CRDs are installed if not already present.
timeout	String	-	Time to wait for any individual Kubernetes operation (like Jobs for hooks).
values	[File ! ]	-	Specify values in a YAML file.
verify	Boolean	-	Verify the package before using it.
wait	Boolean	-	If set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as timeout.
waitForJobs	Boolean	-	If set and wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as timeout.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 chart --source DIR_PATH \
 install --name string

func (m *myModule) example(source *Directory, name string) *HelmRelease  {
	return dag.
			Helm().
			Chart(source).
			Install(name)
}

@function
def example(source: dagger.Directory, name: str) -> dag.HelmRelease:
	return (
		dag.helm()
		.chart(source)
		.install(name)
	)

@func()
example(source: Directory, name: string): HelmRelease {
	return dag
		.helm()
		.chart(source)
		.install(name)
}

Package 🔗

A Helm chart package.

file() 🔗

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f 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() 🔗

Add credentials for a registry.

Return Type

Package !

Arguments

Name	Type	Default Value	Description
address	String !	-	No description provided
username	String !	-	No description provided
secret	Secret !	-	No description provided

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 chart --source DIR_PATH \
 package \
 with-registry-auth --address string --username string --secret env:MYSECRET

func (m *myModule) example(source *Directory, address string, username string, secret *Secret) *HelmPackage  {
	return dag.
			Helm().
			Chart(source).
			Package().
			WithRegistryAuth(address, username, secret)
}

@function
def example(source: dagger.Directory, address: str, username: str, secret: dagger.Secret) -> dag.HelmPackage:
	return (
		dag.helm()
		.chart(source)
		.package()
		.with_registry_auth(address, username, secret)
	)

@func()
example(source: Directory, address: string, username: string, secret: Secret): HelmPackage {
	return dag
		.helm()
		.chart(source)
		.package()
		.withRegistryAuth(address, username, secret)
}

withoutRegistryAuth() 🔗

Removes credentials for a registry.

Return Type

Package !

Arguments

Name	Type	Default Value	Description
address	String !	-	No description provided

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 chart --source DIR_PATH \
 package \
 without-registry-auth --address string

func (m *myModule) example(source *Directory, address string) *HelmPackage  {
	return dag.
			Helm().
			Chart(source).
			Package().
			WithoutRegistryAuth(address)
}

@function
def example(source: dagger.Directory, address: str) -> dag.HelmPackage:
	return (
		dag.helm()
		.chart(source)
		.package()
		.without_registry_auth(address)
	)

@func()
example(source: Directory, address: string): HelmPackage {
	return dag
		.helm()
		.chart(source)
		.package()
		.withoutRegistryAuth(address)
}

publish() 🔗

Publishes this Helm chart package to an OCI registry.

Return Type

Void !

Arguments

Name	Type	Default Value	Description
registry	String !	-	OCI registry to push to (including the path except the chart name).
plainHttp	Boolean	-	Use insecure HTTP connections for the chart upload.
insecureSkipTlsVerify	Boolean	-	Skip tls certificate checks for the chart upload.
caFile	File	-	Verify certificates of HTTPS-enabled servers using this CA bundle.
certFile	File	-	Identify registry client using this SSL certificate file.
keyFile	Secret	-	Identify registry client using this SSL key file.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f 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)
}

install() 🔗

Install a Helm chart.

Return Type

Release !

Arguments

Name	Type	Default Value	Description
name	String !	-	Helm release name.
atomic	Boolean	-	If set, the installation process deletes the installation on failure. Wait flag will be set automatically if atomic is used.
caFile	File	-	Verify certificates of HTTPS-enabled servers using this CA bundle.
certFile	File	-	Identify HTTPS client using this SSL certificate file.
createNamespace	Boolean	-	Create the release namespace if not present.
dependencyUpdate	Boolean	-	Update dependencies if they are missing before installing the chart.
description	String	-	Add a custom description.
disableOpenapiValidation	Boolean	-	If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema.
enableDns	Boolean	-	Enable DNS lookups when rendering templates.
force	Boolean	-	Force resource updates through a replacement strategy.
generateName	Boolean	-	Generate the name.
insecureSkipTlsVerify	Boolean	-	Skip tls certificate checks for the chart download.
keyFile	Secret	-	Identify HTTPS client using this SSL key file.
labels	[String ! ]	-	Labels that would be added to release metadata.
nameTemplate	String	-	Specify template used to name the release.
noHooks	Boolean	-	Prevent hooks from running during install.
plainHttp	Boolean	-	Use insecure HTTP connections for the chart download.
postRenderer	String	-	The path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path.
postRendererArgs	[String ! ]	-	Arguments to the post-renderer.
renderSubchartNotes	Boolean	-	If set, render subchart notes along with the parent.
replace	Boolean	-	Re-use the given name, only if that name is a deleted release which remains in the history. This is unsafe in production.
skipCrds	Boolean	-	If set, no CRDs will be installed. By default, CRDs are installed if not already present.
timeout	String	-	Time to wait for any individual Kubernetes operation (like Jobs for hooks).
values	[File ! ]	-	Specify values in a YAML file.
verify	Boolean	-	Verify the package before using it.
wait	Boolean	-	If set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as timeout.
waitForJobs	Boolean	-	If set and wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as timeout.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 chart --source DIR_PATH \
 package \
 install --name string

func (m *myModule) example(source *Directory, name string) *HelmRelease  {
	return dag.
			Helm().
			Chart(source).
			Package().
			Install(name)
}

@function
def example(source: dagger.Directory, name: str) -> dag.HelmRelease:
	return (
		dag.helm()
		.chart(source)
		.package()
		.install(name)
	)

@func()
example(source: Directory, name: string): HelmRelease {
	return dag
		.helm()
		.chart(source)
		.package()
		.install(name)
}

Release 🔗

name() 🔗

Return Type

String !

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 chart --source DIR_PATH \
 install --name string \
 name

func (m *myModule) example(ctx context.Context, source *Directory, name string) string  {
	return dag.
			Helm().
			Chart(source).
			Install(name).
			Name(ctx)
}

@function
async def example(source: dagger.Directory, name: str) -> str:
	return await (
		dag.helm()
		.chart(source)
		.install(name)
		.name()
	)

@func()
async example(source: Directory, name: string): Promise<string> {
	return dag
		.helm()
		.chart(source)
		.install(name)
		.name()
}

test() 🔗

Run Helm tests.

Return Type

String !

Arguments

Name	Type	Default Value	Description
filter	[String ! ]	-	Specify tests by attribute (currently "name") using attribute=value syntax or '!attribute=value' to exclude a test.
logs	Boolean	-	Dump the logs from test pods (this runs after all tests are complete, but before any cleanup).
timeout	String	-	Time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s).

Example

dagger -m github.com/sagikazarmark/daggerverse/helm@2d1edf88fed2a2089e4323568b7094c5bd5d6c2f call \
 chart --source DIR_PATH \
 install --name string \
 test

func (m *myModule) example(ctx context.Context, source *Directory, name string) string  {
	return dag.
			Helm().
			Chart(source).
			Install(name).
			Test(ctx)
}

@function
async def example(source: dagger.Directory, name: str) -> str:
	return await (
		dag.helm()
		.chart(source)
		.install(name)
		.test()
	)

@func()
async example(source: Directory, name: string): Promise<string> {
	return dag
		.helm()
		.chart(source)
		.install(name)
		.test()
}

helm

Installation

Entrypoint

Return Type

Arguments

Types

Helm 🔗

container() 🔗

Return Type

withRegistryAuth() 🔗

Return Type

Arguments

withoutRegistryAuth() 🔗

Return Type

Arguments

create() 🔗

Return Type

Arguments

lint() 🔗

Return Type

Arguments

package() 🔗

Return Type

Arguments

login() 🔗

Return Type

Arguments

logout() 🔗

Return Type

Arguments

push() 🔗

Return Type

Arguments

chart() 🔗

Return Type

Arguments

Chart 🔗

directory() 🔗

Return Type

lint() 🔗

Return Type

package() 🔗

Return Type

Arguments

install() 🔗

Return Type

Arguments

Package 🔗

file() 🔗

Return Type

withRegistryAuth() 🔗

Return Type

Arguments

withoutRegistryAuth() 🔗

Return Type

Arguments

publish() 🔗

Return Type

Arguments

install() 🔗

Return Type

Arguments

Release 🔗

name() 🔗

Return Type

test() 🔗

Return Type

Arguments