helm
Copyright © 2024 Patrick Hermann patrick.hermann@sva.de
Installation
dagger install github.com/stuttgart-things/dagger/helm@v0.0.4
Entrypoint
Return Type
Helm !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
helmContainer | Container | - | helm container It need contain helm |
Example
dagger -m github.com/stuttgart-things/dagger/helm@1349ca6c48e63b2d6ad7c8e2c4619dd44b73e13c 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 🔗
helmContainer() 🔗
Return Type
Container !
Example
dagger -m github.com/stuttgart-things/dagger/helm@1349ca6c48e63b2d6ad7c8e2c4619dd44b73e13c call \
helm-container
func (m *myModule) example() *Container {
return dag.
Helm().
HelmContainer()
}
@function
def example() -> dagger.Container:
return (
dag.helm()
.helm_container()
)
@func()
example(): Container {
return dag
.helm()
.helmContainer()
}
getHelmContainer() 🔗
GetHelmContainer return the default image for helm
Return Type
Container !
Example
dagger -m github.com/stuttgart-things/dagger/helm@1349ca6c48e63b2d6ad7c8e2c4619dd44b73e13c call \
get-helm-container
func (m *myModule) example() *Container {
return dag.
Helm().
GetHelmContainer()
}
@function
def example() -> dagger.Container:
return (
dag.helm()
.get_helm_container()
)
@func()
example(): Container {
return dag
.helm()
.getHelmContainer()
}
runPipeline() 🔗
RunPipeline orchestrates all pipeline steps
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
values | File ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/helm@1349ca6c48e63b2d6ad7c8e2c4619dd44b73e13c call \
run-pipeline --src DIR_PATH --values file:path
func (m *myModule) example(ctx context.Context, src *Directory, values *File) {
return dag.
Helm().
RunPipeline(ctx, src, values)
}
@function
async def example(src: dagger.Directory, values: dagger.File) -> None:
return await (
dag.helm()
.run_pipeline(src, values)
)
@func()
async example(src: Directory, values: File): Promise<void> {
return dag
.helm()
.runPipeline(src, values)
}
lint() 🔗
Lints a chart
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/helm@1349ca6c48e63b2d6ad7c8e2c4619dd44b73e13c call \
lint --src DIR_PATH
func (m *myModule) example(ctx context.Context, src *Directory) string {
return dag.
Helm().
Lint(ctx, src)
}
@function
async def example(src: dagger.Directory) -> str:
return await (
dag.helm()
.lint(src)
)
@func()
async example(src: Directory): Promise<string> {
return dag
.helm()
.lint(src)
}
package() 🔗
Packages a chart into a versioned chart archive file (.tgz)
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/helm@1349ca6c48e63b2d6ad7c8e2c4619dd44b73e13c call \
package --src DIR_PATH
func (m *myModule) example(src *Directory) *File {
return dag.
Helm().
Package(src)
}
@function
def example(src: dagger.Directory) -> dagger.File:
return (
dag.helm()
.package(src)
)
@func()
example(src: Directory): File {
return dag
.helm()
.package(src)
}
push() 🔗
PUSH HELM CHART TO TARGET REGISTRY
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
registry | String ! | "ghcr.io" | No description provided |
repository | String ! | - | No description provided |
username | String ! | - | No description provided |
password | Secret ! | - | No description provided |
src | Directory ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/helm@1349ca6c48e63b2d6ad7c8e2c4619dd44b73e13c call \
push --registry string --repository string --username string --password env:MYSECRET --src DIR_PATH
func (m *myModule) example(ctx context.Context, registry string, repository string, username string, password *Secret, src *Directory) string {
return dag.
Helm().
Push(ctx, registry, repository, username, password, src)
}
@function
async def example(registry: str, repository: str, username: str, password: dagger.Secret, src: dagger.Directory) -> str:
return await (
dag.helm()
.push(registry, repository, username, password, src)
)
@func()
async example(registry: string, repository: string, username: string, password: Secret, src: Directory): Promise<string> {
return dag
.helm()
.push(registry, repository, username, password, src)
}
render() 🔗
Renders a chart as Kubernetes manifests
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
chart | Directory ! | - | No description provided |
values | File ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/helm@1349ca6c48e63b2d6ad7c8e2c4619dd44b73e13c call \
render --chart DIR_PATH --values file:path
func (m *myModule) example(ctx context.Context, chart *Directory, values *File) string {
return dag.
Helm().
Render(ctx, chart, values)
}
@function
async def example(chart: dagger.Directory, values: dagger.File) -> str:
return await (
dag.helm()
.render(chart, values)
)
@func()
async example(chart: Directory, values: File): Promise<string> {
return dag
.helm()
.render(chart, values)
}