helm-oci
A lightweight wrapper around Helm OCI.
Installation
dagger install github.com/purpleclay/daggerverse/helm-oci@v0.1.0
Entrypoint
Return Type
HelmOci !
Arguments
Name | Type | Description |
---|---|---|
base | Container | a custom base image containing an installation of helm |
Example
dagger -m github.com/purpleclay/daggerverse/helm-oci@07289c711a54a58c797273b8a05b1a5d31e52aa4 call \
func (m *myModule) example() *HelmOci {
return dag.
HelmOci()
}
@function
def example() -> dag.HelmOci:
return (
dag.helm_oci()
)
@func()
example(): HelmOci {
return dag
.helmOci()
}
Types
HelmOci 🔗
Helm OCI dagger module
packagePush() 🔗
Packages a Helm chart and publishes it to an OCI registry
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
chart | Directory ! | - | a path to the directory containing the Chart.yaml file |
registry | String ! | - | the OCI registry to publish the chart to, should include full path without chart name |
username | String ! | - | the username for authenticating with the registry |
password | Secret ! | - | the password for authenticating with the registry |
Example
dagger -m github.com/purpleclay/daggerverse/helm-oci@07289c711a54a58c797273b8a05b1a5d31e52aa4 call \
package-push --chart DIR_PATH --registry string --username string --password env:MYSECRET
func (m *myModule) example(ctx context.Context, chart *Directory, registry string, username string, password *Secret) string {
return dag.
HelmOci().
PackagePush(ctx, chart, registry, username, password)
}
@function
async def example(chart: dagger.Directory, registry: str, username: str, password: dagger.Secret) -> str:
return await (
dag.helm_oci()
.package_push(chart, registry, username, password)
)
@func()
async example(chart: Directory, registry: string, username: string, password: Secret): Promise<string> {
return dag
.helmOci()
.packagePush(chart, registry, username, password)
}
lint() 🔗
Lints a Helm chart
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
chart | Directory ! | - | a path to the directory containing the Chart.yaml file |
strict | Boolean | - | fail on any linting errors by returning a non zero exit code |
quiet | Boolean | - | print only warnings and errors |
Example
dagger -m github.com/purpleclay/daggerverse/helm-oci@07289c711a54a58c797273b8a05b1a5d31e52aa4 call \
lint --chart DIR_PATH
func (m *myModule) example(ctx context.Context, chart *Directory) string {
return dag.
HelmOci().
Lint(ctx, chart)
}
@function
async def example(chart: dagger.Directory) -> str:
return await (
dag.helm_oci()
.lint(chart)
)
@func()
async example(chart: Directory): Promise<string> {
return dag
.helmOci()
.lint(chart)
}