helm
The package manager for Kubernetes.
Installation
dagger install github.com/sagikazarmark/daggerverse/helm@v0.4.0
Entrypoint
Return Type
Helm !
Arguments
Name | Type | Default Value | 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String ! | - | No description provided |
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@b45dbd7448bb967aca4a538af9ce7f042abf0316 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
Name | Type | Default Value | Description |
---|---|---|---|
chart | Directory ! | - | A directory containing a Helm chart. |
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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.
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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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 | File | - | Identify registry client using this SSL key file. |
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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()
}
Package 🔗
A Helm chart package.
file() 🔗
Return Type
File !
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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@b45dbd7448bb967aca4a538af9ce7f042abf0316 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 | File | - | Identify registry client using this SSL key file. |
Example
dagger -m github.com/sagikazarmark/daggerverse/helm@b45dbd7448bb967aca4a538af9ce7f042abf0316 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)
}