helm
Installation
Entrypoint
Types
Helm

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@v0.0.20

Entrypoint

Return Type

Helm !

Arguments

Name	Type	Description
baseHelmContainer	Container	base helm container It need contain helm
baseGeneratorContainer	Container	Base generator container It need contain readme-generator-for-helm
baseYqContainer	Container	Base YQ container It need contain yq

Example

dagger -m github.com/disaster37/dagger-library-go/helm@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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()
}

push() 🔗

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

Return Type

File !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	the source directory
withRegistryUsername	Secret !	-	The registry username
withRegistryPassword	Secret !	-	The registry password
registryUrl	String !	-	The registry url
repositoryName	String !	-	The repository name
version	String !	-	The version
withFiles	[File ! ]	-	Files to inject on containers

Example

dagger -m github.com/disaster37/dagger-library-go/helm@7e7da44f35e584e7ff94bcea9b9885b8b397c138 call \
 push --source DIR_PATH --with-registry-username env:MYSECRET --with-registry-password env:MYSECRET --registry-url string --repository-name string --version string

func (m *myModule) example(source *Directory, withRegistryUsername *Secret, withRegistryPassword *Secret, registryUrl string, repositoryName string, version string) *File  {
	return dag.
			Helm().
			Push(source, withRegistryUsername, withRegistryPassword, registryUrl, repositoryName, version)
}

@function
def example(source: dagger.Directory, with_registry_username: dagger.Secret, with_registry_password: dagger.Secret, registry_url: str, repository_name: str, version: str) -> dagger.File:
	return (
		dag.helm()
		.push(source, with_registry_username, with_registry_password, registry_url, repository_name, version)
	)

@func()
example(source: Directory, withRegistryUsername: Secret, withRegistryPassword: Secret, registryUrl: string, repositoryName: string, version: string): File {
	return dag
		.helm()
		.push(source, withRegistryUsername, withRegistryPassword, registryUrl, repositoryName, version)
}

generateSchema() 🔗

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

Return Type

File !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	the source directory
configFile	String	-	Config file for readme-generator

Example

dagger -m github.com/disaster37/dagger-library-go/helm@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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)
}

lint() 🔗

Lint permit to lint helm chart

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	the source directory
withFiles	[File ! ]	-	Files to inject on containers

Example

dagger -m github.com/disaster37/dagger-library-go/helm@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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)
}

generateDocumentation() 🔗

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

Return Type

File !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	the source directory
configFile	String	-	Config file for readme-generator

Example

dagger -m github.com/disaster37/dagger-library-go/helm@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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)
}

getBaseGeneratorContainer() 🔗

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

Return Type

Container !

Example

dagger -m github.com/disaster37/dagger-library-go/helm@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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@7e7da44f35e584e7ff94bcea9b9885b8b397c138 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()
}