Dagger
Search

terragrunt

No long description provided.

Installation

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

Entrypoint

Return Type
Terragrunt !
Arguments
NameTypeDescription
tfVersionString tfVersion is the version of the Terraform to use, e.g., "1.0.0". For more information, visit HashiCorp's Terraform GitHub repository.
imageString image is the image to use as the base container.
srcDirectory !src is the directory that contains all the source code, including the module directory.
ctrContainer Ctrl is the container to use as a base container.
envVarsFromHost[String ! ] envVarsFromHost 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"}
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@0669fa4939723cde84d16e78b228aa9d972ad146 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@0669fa4939723cde84d16e78b228aa9d972ad146 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()
}

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
NameTypeDefault ValueDescription
imageUrlString !-No description provided
Example
dagger -m github.com/Excoriate/daggerverse/terragrunt@0669fa4939723cde84d16e78b228aa9d972ad146 call \
 --src DIR_PATH base --image-url string \
 version
func (m *myModule) example(src *Directory, imageUrl string) *Terragrunt  {
	return dag.
			Terragrunt(src).
			Base(imageUrl)
}
@function
def example(src: dagger.Directory, image_url: str) -> dag.Terragrunt:
	return (
		dag.terragrunt(src)
		.base(image_url)
	)
@func()
example(src: Directory, imageUrl: string): Terragrunt {
	return dag
		.terragrunt(src)
		.base(imageUrl)
}

withSource() 🔗

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

Return Type
Terragrunt !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
workdirString !-No description provided
Example
dagger -m github.com/Excoriate/daggerverse/terragrunt@0669fa4939723cde84d16e78b228aa9d972ad146 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@0669fa4939723cde84d16e78b228aa9d972ad146 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
NameTypeDefault ValueDescription
nameString !-No description provided
valueString !-No description provided
expandBoolean !-No description provided
Example
dagger -m github.com/Excoriate/daggerverse/terragrunt@0669fa4939723cde84d16e78b228aa9d972ad146 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)
}

withCmd() 🔗

WithCMD sets the command to run in the container.

Return Type
Terragrunt !
Arguments
NameTypeDefault ValueDescription
cmd[String ! ] !-No description provided
Example
dagger -m github.com/Excoriate/daggerverse/terragrunt@0669fa4939723cde84d16e78b228aa9d972ad146 call \
 --src DIR_PATH with-cmd --cmd string1 --cmd string2 \
 version
func (m *myModule) example(src *Directory, cmd []string) *Terragrunt  {
	return dag.
			Terragrunt(src).
			WithCmd(cmd)
}
@function
def example(src: dagger.Directory, cmd: List[str]) -> dag.Terragrunt:
	return (
		dag.terragrunt(src)
		.with_cmd(cmd)
	)
@func()
example(src: Directory, cmd: string[]): Terragrunt {
	return dag
		.terragrunt(src)
		.withCmd(cmd)
}

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@0669fa4939723cde84d16e78b228aa9d972ad146 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@0669fa4939723cde84d16e78b228aa9d972ad146 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()
}

run() 🔗

Run executes any Terragrunt command.

Return Type
String !
Arguments
NameTypeDefault ValueDescription
moduleString !-module is the terragunt module to use that includes the terragrunt.hcl the module should be relative to the mounted directory (--src).
cmdString !-cmd is the Terragrunt 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"}
argsString -args is the list of arguments to pass to the Terragrunt command.
Example
dagger -m github.com/Excoriate/daggerverse/terragrunt@0669fa4939723cde84d16e78b228aa9d972ad146 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
NameTypeDefault ValueDescription
moduleString !-module is the terragunt module to use that includes the terragrunt.hcl the module should be relative to the mounted directory (--src).
cmdString !-cmd is the Terragrunt 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"}
argsString -args is the list of arguments to pass to the Terragrunt command.
Example
dagger -m github.com/Excoriate/daggerverse/terragrunt@0669fa4939723cde84d16e78b228aa9d972ad146 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)
}