terragrunt
Installation
Entrypoint
Types
Terragrunt
EnvVarDagger

terragrunt

No long description provided.

Installation

dagger install github.com/Excoriate/daggerverse/terragrunt@v1.12.0

Entrypoint

Return Type

Terragrunt !

Arguments

Name	Type	Description
tfVersion	String	tfVersion is the version of the Terraform to use, e.g., "1.0.0". For more information, visit HashiCorp's Terraform GitHub repository.
image	String	image is the image to use as the base container.
src	Directory !	src is the directory that contains all the source code, including the module directory.
ctr	Container	Ctrl is the container to use as a base container.

Example

func (m *myModule) example(src *Directory) *Terragrunt  {
	return dag.
			Terragrunt(src)
}

@function
def example(src: dagger.Directory, ) -> dag.Terragrunt:
	return (
		dag.terragrunt(src)
	)

@func()
example(src: Directory, ): Terragrunt {
	return dag
		.terragrunt(src)
}

Types

Terragrunt 🔗

src() 🔗

Src is the directory that contains all the source code, including the module directory.

Return Type

Directory !

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH src

func (m *myModule) example(src *Directory) *Directory  {
	return dag.
			Terragrunt(src).
			Src()
}

@function
def example(src: dagger.Directory, ) -> dagger.Directory:
	return (
		dag.terragrunt(src)
		.src()
	)

@func()
example(src: Directory, ): Directory {
	return dag
		.terragrunt(src)
		.src()
}

ctr() 🔗

Ctr is the container to use as a base container.

Return Type

Container !

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH ctr

func (m *myModule) example(src *Directory) *Container  {
	return dag.
			Terragrunt(src).
			Ctr()
}

@function
def example(src: dagger.Directory, ) -> dagger.Container:
	return (
		dag.terragrunt(src)
		.ctr()
	)

@func()
example(src: Directory, ): Container {
	return dag
		.terragrunt(src)
		.ctr()
}

version() 🔗

Version returns the Terragrunt version. Consider to configure Terragrunt based on the target Terraform version.

Return Type

String !

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH version

func (m *myModule) example(ctx context.Context, src *Directory) string  {
	return dag.
			Terragrunt(src).
			Version(ctx)
}

@function
async def example(src: dagger.Directory, ) -> str:
	return await (
		dag.terragrunt(src)
		.version()
	)

@func()
async example(src: Directory, ): Promise<string> {
	return dag
		.terragrunt(src)
		.version()
}

help() 🔗

Help returns the Terragrunt help.

Return Type

String !

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH help

func (m *myModule) example(ctx context.Context, src *Directory) string  {
	return dag.
			Terragrunt(src).
			Help(ctx)
}

@function
async def example(src: dagger.Directory, ) -> str:
	return await (
		dag.terragrunt(src)
		.help()
	)

@func()
async example(src: Directory, ): Promise<string> {
	return dag
		.terragrunt(src)
		.help()
}

addCmd() 🔗

AddCMD adds a command to the container. It supports environment variables and arguments.

Return Type

Terragrunt !

Arguments

Name	Type	Default Value	Description
module	String !	-	module is the terragunt module to use that includes the terragrunt.hcl the module should be relative to the mounted directory (--src).
cmd	String !	-	cmd is the command to run.
envVars	[String ! ]	[]	envVars is the list of environment variables to pass from the host to the container. the format of the environment variables passed from the host are slices of strings separted by "=", and commas. E.g., []string{"HOST=localhost", "PORT=8080"}
args	String	-	args is the list of arguments to pass to the Terragrunt command.

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH add-cmd --module string --cmd string \
 version

func (m *myModule) example(src *Directory, module string, cmd string) *Terragrunt  {
	return dag.
			Terragrunt(src).
			AddCmd(module, cmd)
}

@function
def example(src: dagger.Directory, module: str, cmd: str) -> dag.Terragrunt:
	return (
		dag.terragrunt(src)
		.add_cmd(module, cmd)
	)

@func()
example(src: Directory, module: string, cmd: string): Terragrunt {
	return dag
		.terragrunt(src)
		.addCmd(module, cmd)
}

run() 🔗

Run executes any Terragrunt command.

Return Type

String !

Arguments

Name	Type	Default Value	Description
module	String !	-	module is the terragunt module to use that includes the terragrunt.hcl the module should be relative to the mounted directory (--src).
cmd	String !	-	cmd is the command to run.
envVars	[String ! ]	[]	envVars is the list of environment variables to pass from the host to the container. the format of the environment variables passed from the host are slices of strings separted by "=", and commas. E.g., []string{"HOST=localhost", "PORT=8080"}
args	String	-	args is the list of arguments to pass to the Terragrunt command.

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH run --module string --cmd string

func (m *myModule) example(ctx context.Context, src *Directory, module string, cmd string) string  {
	return dag.
			Terragrunt(src).
			Run(ctx, module, cmd)
}

@function
async def example(src: dagger.Directory, module: str, cmd: str) -> str:
	return await (
		dag.terragrunt(src)
		.run(module, cmd)
	)

@func()
async example(src: Directory, module: string, cmd: string): Promise<string> {
	return dag
		.terragrunt(src)
		.run(module, cmd)
}

runAll() 🔗

RunAll executes any Terragrunt run-all command.

Return Type

String !

Arguments

Name	Type	Default Value	Description
module	String !	-	module is the terragunt module to use that includes the terragrunt.hcl the module should be relative to the mounted directory (--src).
cmd	String !	-	cmd is the command to run.
envVars	[String ! ]	[]	envVars is the list of environment variables to pass from the host to the container. the format of the environment variables passed from the host are slices of strings separted by "=", and commas. E.g., []string{"HOST=localhost", "PORT=8080"}
args	String	-	args is the list of arguments to pass to the Terragrunt command.

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH run-all --module string --cmd string

func (m *myModule) example(ctx context.Context, src *Directory, module string, cmd string) string  {
	return dag.
			Terragrunt(src).
			RunAll(ctx, module, cmd)
}

@function
async def example(src: dagger.Directory, module: str, cmd: str) -> str:
	return await (
		dag.terragrunt(src)
		.run_all(module, cmd)
	)

@func()
async example(src: Directory, module: string, cmd: string): Promise<string> {
	return dag
		.terragrunt(src)
		.runAll(module, cmd)
}

base() 🔗

Base sets the base image and version, and creates the base container. For Terragrunt, the default image is “alpine/terragrunt” and the default version is “1.7.0”. Consider that the container isn’t created based on the Terragrunt version, but on the Terraform version.

Return Type

Terragrunt !

Arguments

Name	Type	Default Value	Description
image	String !	-	No description provided
version	String !	-	No description provided

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH base --image string --version string \
 version

func (m *myModule) example(src *Directory, image string, version string) *Terragrunt  {
	return dag.
			Terragrunt(src).
			Base(image, version)
}

@function
def example(src: dagger.Directory, image: str, version: str) -> dag.Terragrunt:
	return (
		dag.terragrunt(src)
		.base(image, version)
	)

@func()
example(src: Directory, image: string, version: string): Terragrunt {
	return dag
		.terragrunt(src)
		.base(image, version)
}

withSource() 🔗

WithSource sets the source directory if it’s passed, and mounts the source directory to the container.

Return Type

Terragrunt !

Arguments

Name	Type	Default Value	Description
src	Directory !	-	No description provided
workdir	String !	-	No description provided

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH with-source --src DIR_PATH --workdir string \
 version

func (m *myModule) example(src *Directory, src1 *Directory, workdir string) *Terragrunt  {
	return dag.
			Terragrunt(src).
			WithSource(src1, workdir)
}

@function
def example(src: dagger.Directory, src1: dagger.Directory, workdir: str) -> dag.Terragrunt:
	return (
		dag.terragrunt(src)
		.with_source(src1, workdir)
	)

@func()
example(src: Directory, src1: Directory, workdir: string): Terragrunt {
	return dag
		.terragrunt(src)
		.withSource(src1, workdir)
}

withTerragruntCache() 🔗

WithTerragruntCache creates a cache volume for Terragrunt for the .terragrunt-cache folder

Return Type

Terragrunt !

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH with-terragrunt-cache \
 version

func (m *myModule) example(src *Directory) *Terragrunt  {
	return dag.
			Terragrunt(src).
			WithTerragruntCache()
}

@function
def example(src: dagger.Directory, ) -> dag.Terragrunt:
	return (
		dag.terragrunt(src)
		.with_terragrunt_cache()
	)

@func()
example(src: Directory, ): Terragrunt {
	return dag
		.terragrunt(src)
		.withTerragruntCache()
}

withEnvVar() 🔗

WithEnvVar adds an environment variable to the container.

Return Type

Terragrunt !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided
value	String !	-	No description provided
expand	Boolean !	-	No description provided

Example

dagger -m github.com/Excoriate/daggerverse/terragrunt@42848834710d3286621b7e289424c2a0173dbc46 call \
 --src DIR_PATH with-env-var --name string --value string --expand boolean \
 version

func (m *myModule) example(src *Directory, name string, value string, expand bool) *Terragrunt  {
	return dag.
			Terragrunt(src).
			WithEnvVar(name, value, expand)
}

@function
def example(src: dagger.Directory, name: str, value: str, expand: bool) -> dag.Terragrunt:
	return (
		dag.terragrunt(src)
		.with_env_var(name, value, expand)
	)

@func()
example(src: Directory, name: string, value: string, expand: boolean): Terragrunt {
	return dag
		.terragrunt(src)
		.withEnvVar(name, value, expand)
}

withEnvVars() 🔗

WithEnvVars sets the environment variables to the container.

Return Type

Terragrunt !

Arguments

Name	Type	Default Value	Description
envVars	[EnvVarDagger ! ] !	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *myModule) example(src *Directory, envVars []*TerragruntEnvVarDagger) *Terragrunt  {
	return dag.
			Terragrunt(src).
			WithEnvVars(envVars)
}

@function
def example(src: dagger.Directory, env_vars: List[dag.TerragruntEnvVarDagger]) -> dag.Terragrunt:
	return (
		dag.terragrunt(src)
		.with_env_vars(env_vars)
	)

@func()
example(src: Directory, envVars: TerragruntEnvVarDagger[]): Terragrunt {
	return dag
		.terragrunt(src)
		.withEnvVars(envVars)
}

EnvVarDagger 🔗

name() 🔗

Return Type

String !

Example

Function TerragruntEnvVarDagger.name is not accessible from the terragrunt module

Function TerragruntEnvVarDagger.name is not accessible from the terragrunt module

Function TerragruntEnvVarDagger.name is not accessible from the terragrunt module

Function TerragruntEnvVarDagger.name is not accessible from the terragrunt module

value() 🔗

Return Type

String !

Example

Function TerragruntEnvVarDagger.value is not accessible from the terragrunt module

Function TerragruntEnvVarDagger.value is not accessible from the terragrunt module

Function TerragruntEnvVarDagger.value is not accessible from the terragrunt module

Function TerragruntEnvVarDagger.value is not accessible from the terragrunt module

expand() 🔗

Return Type

Boolean !

Example

Function TerragruntEnvVarDagger.expand is not accessible from the terragrunt module

Function TerragruntEnvVarDagger.expand is not accessible from the terragrunt module

Function TerragruntEnvVarDagger.expand is not accessible from the terragrunt module

Function TerragruntEnvVarDagger.expand is not accessible from the terragrunt module