infrabox

A module for playing on the terraform ecosystem

Installation

dagger install github.com/Dudesons/daggerverse/infrabox@v0.6.0

Entrypoint

Return Type

Infrabox

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \

func (m *MyModule) Example() *dagger.Infrabox  {
	return dag.
			Infrabox()
}

@function
def example() -> dagger.Infrabox:
	return (
		dag.infrabox()
	)

@func()
example(): Infrabox {
	return dag
		.infrabox()
}

Types

Infrabox 🔗

terragrunt() 🔗

Expose a terragrunt runtime

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
image	String	"alpine/terragrunt"	The image to use which contain terragrunt ecosystem
version	String	"1.7.4"	The version of the image to use
ctr	Container	-	A container to use as a base

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt

func (m *MyModule) Example() *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt()
}

@function
def example() -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
	)

@func()
example(): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
}

Tf 🔗

tfPlan() 🔗

Content of the terraform plan

Return Type

File !

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 tf-plan

func (m *MyModule) Example() *dagger.File  {
	return dag.
			Infrabox().
			Terragrunt().
			TfPlan()
}

@function
def example() -> dagger.File:
	return (
		dag.infrabox()
		.terragrunt()
		.tf_plan()
	)

@func()
example(): File {
	return dag
		.infrabox()
		.terragrunt()
		.tfPlan()
}

withSource() 🔗

Mount the source code at the given path

Return Type

Tf !

Arguments

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

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 with-source --path string --src DIR_PATH

func (m *MyModule) Example(path string, src *dagger.Directory) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			WithSource(path, src)
}

@function
def example(path: str, src: dagger.Directory) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.with_source(path, src)
	)

@func()
example(path: string, src: Directory): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.withSource(path, src)
}

withContainer() 🔗

Use a new container

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
ctr	Container !	-	No description provided

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 with-container --ctr IMAGE:TAG

func (m *MyModule) Example(ctr *dagger.Container) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			WithContainer(ctr)
}

@function
def example(ctr: dagger.Container) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.with_container(ctr)
	)

@func()
example(ctr: Container): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.withContainer(ctr)
}

withSecretDotEnv() 🔗

Convert a dotfile format to secret environment variables in the container (could be use to configure providers)

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
dotEnv	Secret !	-	No description provided

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 with-secret-dot-env --dot-env env:MYSECRET

func (m *MyModule) Example(dotEnv *dagger.Secret) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			WithSecretDotEnv(dotEnv)
}

@function
def example(dot_env: dagger.Secret) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.with_secret_dot_env(dot_env)
	)

@func()
example(dotEnv: Secret): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.withSecretDotEnv(dotEnv)
}

disableColor() 🔗

Indicate to disable the the color in the output

Return Type

Tf !

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 disable-color

func (m *MyModule) Example() *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			DisableColor()
}

@function
def example() -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.disable_color()
	)

@func()
example(): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.disableColor()
}

container() 🔗

Expose the container

Return Type

Container !

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 container

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Infrabox().
			Terragrunt().
			Container()
}

@function
def example() -> dagger.Container:
	return (
		dag.infrabox()
		.terragrunt()
		.container()
	)

@func()
example(): Container {
	return dag
		.infrabox()
		.terragrunt()
		.container()
}

do() 🔗

Execute the call chain

Return Type

String !

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 do

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Infrabox().
			Terragrunt().
			Do(ctx)
}

@function
async def example() -> str:
	return await (
		dag.infrabox()
		.terragrunt()
		.do()
	)

@func()
async example(): Promise<string> {
	return dag
		.infrabox()
		.terragrunt()
		.do()
}

directory() 🔗

Return the source directory

Return Type

Directory !

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 directory

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			Infrabox().
			Terragrunt().
			Directory()
}

@function
def example() -> dagger.Directory:
	return (
		dag.infrabox()
		.terragrunt()
		.directory()
	)

@func()
example(): Directory {
	return dag
		.infrabox()
		.terragrunt()
		.directory()
}

shell() 🔗

Open a shell

Return Type

Container !

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 shell

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Infrabox().
			Terragrunt().
			Shell()
}

@function
def example() -> dagger.Container:
	return (
		dag.infrabox()
		.terragrunt()
		.shell()
	)

@func()
example(): Container {
	return dag
		.infrabox()
		.terragrunt()
		.shell()
}

withCacheBurster() 🔗

Define the cache buster strategy

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
cacheBursterLevel	String	-	Define if the cache burster level is done per day ('daily'), per hour ('hour'), per minute ('minute'), per second ('default') or no cache buster ('none')

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 with-cache-burster

func (m *MyModule) Example() *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			WithCacheBurster()
}

@function
def example() -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.with_cache_burster()
	)

@func()
example(): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.withCacheBurster()
}

withTfPlan() 🔗

Define the cache buster strategy

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
planFile	File !	-	A terraform plan file to apply

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 with-tf-plan --plan-file file:path

func (m *MyModule) Example(planFile *dagger.File) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			WithTfPlan(planFile)
}

@function
def example(plan_file: dagger.File) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.with_tf_plan(plan_file)
	)

@func()
example(planFile: File): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.withTfPlan(planFile)
}

plan() 🔗

Run a plan on a specific stack

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
workDir	String !	-	Define the path where to execute the command
destroyMode	Boolean	-	Define if we are executing the plan in destroy mode or not
detailedExitCode	Boolean	-	Define if the exit code is in detailed mode or not (0 - Succeeded, diff is empty (no changes) \| 1 - Errored \| 2 - Succeeded, there is a diff)
savePlan	Boolean	-	Define if the plan is saved in a file

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 plan --work-dir string

func (m *MyModule) Example(workDir string) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			Plan(workDir)
}

@function
def example(work_dir: str) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.plan(work_dir)
	)

@func()
example(workDir: string): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.plan(workDir)
}

apply() 🔗

Run an apply on a specific stack

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
workDir	String !	-	Define the path where to execute the command
destroyMode	Boolean	-	Define if we are executing the plan in destroy mode or not

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 apply --work-dir string

func (m *MyModule) Example(workDir string) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			Apply(workDir)
}

@function
def example(work_dir: str) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.apply(work_dir)
	)

@func()
example(workDir: string): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.apply(workDir)
}

format() 🔗

Format the code

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
workDir	String !	-	No description provided
check	Boolean !	-	No description provided

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 format --work-dir string --check boolean

func (m *MyModule) Example(workDir string, check bool) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			Format(workDir, check)
}

@function
def example(work_dir: str, check: bool) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.format(work_dir, check)
	)

@func()
example(workDir: string, check: boolean): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.format(workDir, check)
}

output() 🔗

Return the output of a specific stack

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
workDir	String !	-	No description provided
isJson	Boolean !	-	No description provided

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 output --work-dir string --is-json boolean

func (m *MyModule) Example(workDir string, isJson bool) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			Output(workDir, isJson)
}

@function
def example(work_dir: str, is_json: bool) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.output(work_dir, is_json)
	)

@func()
example(workDir: string, isJson: boolean): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.output(workDir, isJson)
}

show() 🔗

Run a show on a specific state or plan file

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
ojson	Boolean	-	Define if the output is in machine-readable form
path	String !	-	Define a path to a plan file or state

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 show --path string

func (m *MyModule) Example(path string) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			Show(path)
}

@function
def example(path: str) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.show(path)
	)

@func()
example(path: string): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.show(path)
}

runAll() 🔗

Execute the run-all command (only available for terragrunt)

Return Type

Tf !

Arguments

Name	Type	Default Value	Description
workDir	String !	-	No description provided
cmd	String !	-	No description provided

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@9348808c60af026c9ad036e9c8ce37da962dc979 call \
 terragrunt \
 run-all --work-dir string --cmd string

func (m *MyModule) Example(workDir string, cmd string) *dagger.InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			RunAll(workDir, cmd)
}

@function
def example(work_dir: str, cmd: str) -> dagger.InfraboxTf:
	return (
		dag.infrabox()
		.terragrunt()
		.run_all(work_dir, cmd)
	)

@func()
example(workDir: string, cmd: string): InfraboxTf {
	return dag
		.infrabox()
		.terragrunt()
		.runAll(workDir, cmd)
}