Dagger
Search

helm

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809

Entrypoint

Return Type 
Helm !
Arguments
NameTypeDefault ValueDescription
baseHelmContainerContainer -base helm container It need contain helm
baseGeneratorContainerContainer -Base generator container It need contain readme-generator-for-helm
baseYqContainerContainer -Base YQ container It need contain yq
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 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 🔗

baseHelmContainer() 🔗

Return Type 
Container !
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 base-helm-container
func (m *myModule) example() *Container  {
	return dag.
			Helm().
			BaseHelmContainer()
}
@function
def example() -> dagger.Container:
	return (
		dag.helm()
		.base_helm_container()
	)
@func()
example(): Container {
	return dag
		.helm()
		.baseHelmContainer()
}

baseGeneratorContainer() 🔗

Return Type 
Container !
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 base-generator-container
func (m *myModule) example() *Container  {
	return dag.
			Helm().
			BaseGeneratorContainer()
}
@function
def example() -> dagger.Container:
	return (
		dag.helm()
		.base_generator_container()
	)
@func()
example(): Container {
	return dag
		.helm()
		.baseGeneratorContainer()
}

baseYqContainer() 🔗

Return Type 
Container !
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 base-yq-container
func (m *myModule) example() *Container  {
	return dag.
			Helm().
			BaseYqContainer()
}
@function
def example() -> dagger.Container:
	return (
		dag.helm()
		.base_yq_container()
	)
@func()
example(): Container {
	return dag
		.helm()
		.baseYqContainer()
}

updateChart() 🔗

Update Chart.yaml file

Return Type 
File !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-the source directory
keyString !-The key to update on yaml file
valueString !-The new value to put
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 update-chart --source DIR_PATH --key string --value string
func (m *myModule) example(source *Directory, key string, value string) *File  {
	return dag.
			Helm().
			UpdateChart(source, key, value)
}
@function
def example(source: dagger.Directory, key: str, value: str) -> dagger.File:
	return (
		dag.helm()
		.update_chart(source, key, value)
	)
@func()
example(source: Directory, key: string, value: string): File {
	return dag
		.helm()
		.updateChart(source, key, value)
}

updateValues() 🔗

Update values.yaml file

Return Type 
File !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-the source directory
keyString !-The key to update on yaml file
valueString !-The new value to put
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 update-values --source DIR_PATH --key string --value string
func (m *myModule) example(source *Directory, key string, value string) *File  {
	return dag.
			Helm().
			UpdateValues(source, key, value)
}
@function
def example(source: dagger.Directory, key: str, value: str) -> dagger.File:
	return (
		dag.helm()
		.update_values(source, key, value)
	)
@func()
example(source: Directory, key: string, value: string): File {
	return dag
		.helm()
		.updateValues(source, key, value)
}

generateDocumentation() 🔗

GenerateDocumentation permit to generate helm documentation It will return the readme file

Return Type 
File !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-the source directory
configFileString -Config file for readme-generator
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 generate-documentation --source DIR_PATH
func (m *myModule) example(source *Directory) *File  {
	return dag.
			Helm().
			GenerateDocumentation(source)
}
@function
def example(source: dagger.Directory) -> dagger.File:
	return (
		dag.helm()
		.generate_documentation(source)
	)
@func()
example(source: Directory): File {
	return dag
		.helm()
		.generateDocumentation(source)
}

lint() 🔗

Lint permit to lint helm chart

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-the source directory
withFiles[File ! ] -Files to inject on containers
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 lint --source DIR_PATH
func (m *myModule) example(ctx context.Context, source *Directory) string  {
	return dag.
			Helm().
			Lint(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.helm()
		.lint(source)
	)
@func()
async example(source: Directory): Promise<string> {
	return dag
		.helm()
		.lint(source)
}

generateSchema() 🔗

GenerateSchema permit to generate helm schema It will return the values.schema.json file

Return Type 
File !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-the source directory
configFileString -Config file for readme-generator
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 generate-schema --source DIR_PATH
func (m *myModule) example(source *Directory) *File  {
	return dag.
			Helm().
			GenerateSchema(source)
}
@function
def example(source: dagger.Directory) -> dagger.File:
	return (
		dag.helm()
		.generate_schema(source)
	)
@func()
example(source: Directory): File {
	return dag
		.helm()
		.generateSchema(source)
}

getBaseGeneratorContainer() 🔗

BaseGeneratorContainer return the default image for readme-generator-for-helm

Return Type 
Container !
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 get-base-generator-container
func (m *myModule) example() *Container  {
	return dag.
			Helm().
			GetBaseGeneratorContainer()
}
@function
def example() -> dagger.Container:
	return (
		dag.helm()
		.get_base_generator_container()
	)
@func()
example(): Container {
	return dag
		.helm()
		.getBaseGeneratorContainer()
}

getBaseHelmContainer() 🔗

BaseHelmContainer return the default image for helm

Return Type 
Container !
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 get-base-helm-container
func (m *myModule) example() *Container  {
	return dag.
			Helm().
			GetBaseHelmContainer()
}
@function
def example() -> dagger.Container:
	return (
		dag.helm()
		.get_base_helm_container()
	)
@func()
example(): Container {
	return dag
		.helm()
		.getBaseHelmContainer()
}

getBaseYqContainer() 🔗

BaseYqContainer return the default image for yq

Return Type 
Container !
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 get-base-yq-container
func (m *myModule) example() *Container  {
	return dag.
			Helm().
			GetBaseYqContainer()
}
@function
def example() -> dagger.Container:
	return (
		dag.helm()
		.get_base_yq_container()
	)
@func()
example(): Container {
	return dag
		.helm()
		.getBaseYqContainer()
}

withRepository() 🔗

WithRepository permit to login on private helm repository

Return Type 
Helm !
Arguments
NameTypeDefault ValueDescription
nameString !-The repository name
urlString !-The repository url
isOciBoolean !falseIs it an OCI repository
usernameSecret -The repository username
passwordSecret -The repository password
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 with-repository --name string --url string --is-oci boolean
func (m *myModule) example(name string, url string, isOci bool) *Helm  {
	return dag.
			Helm().
			WithRepository(name, url, isOci)
}
@function
def example(name: str, url: str, is_oci: bool) -> dag.Helm:
	return (
		dag.helm()
		.with_repository(name, url, is_oci)
	)
@func()
example(name: string, url: string, isOci: boolean): Helm {
	return dag
		.helm()
		.withRepository(name, url, isOci)
}

push() 🔗

Push helm chart on registry It will return the updated Chart.yaml file with the expected version

Return Type 
File !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-the source directory
registryUrlString !-The registry url
repositoryNameString !-The repository name
versionString !-The version
withFiles[File ! ] -Files to inject on containers
Example
dagger -m github.com/disaster37/dagger-library-go/helm@e30659b34d5604376aad53a466a5790839ad1809 call \
 push --source DIR_PATH --registry-url string --repository-name string --version string
func (m *myModule) example(source *Directory, registryUrl string, repositoryName string, version string) *File  {
	return dag.
			Helm().
			Push(source, registryUrl, repositoryName, version)
}
@function
def example(source: dagger.Directory, registry_url: str, repository_name: str, version: str) -> dagger.File:
	return (
		dag.helm()
		.push(source, registry_url, repository_name, version)
	)
@func()
example(source: Directory, registryUrl: string, repositoryName: string, version: string): File {
	return dag
		.helm()
		.push(source, registryUrl, repositoryName, version)
}