infrabox

A module for playing on the terraform ecosystem

Installation

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

Entrypoint

Return Type

Infrabox

Example

func (m *myModule) example() *Infrabox  {
	return dag.
			Infrabox()
}

@function
def example() -> dag.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

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 container

func (m *myModule) example() *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt()
}

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

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

Tf

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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 with-source --path string --src DIR_PATH \
 container

func (m *myModule) example(path string, src *Directory) *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			WithSource(path, src)
}

@function
def example(path: str, src: dagger.Directory) -> dag.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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 with-container --ctr IMAGE:TAG \
 container

func (m *myModule) example(ctr *Container) *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			WithContainer(ctr)
}

@function
def example(ctr: dagger.Container) -> dag.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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 with-secret-dot-env --dot-env env:MYSECRET \
 container

func (m *myModule) example(dotEnv *Secret) *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			WithSecretDotEnv(dotEnv)
}

@function
def example(dot_env: dagger.Secret) -> dag.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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 disable-color \
 container

func (m *myModule) example() *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			DisableColor()
}

@function
def example() -> dag.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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 container

func (m *myModule) example() *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@41e1f414c163b6676acd03c184d37e3ec8a64b2b 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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 directory

func (m *myModule) example() *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

Terminal !

Example

Function InfraboxTf.shell is not accessible from the infrabox module

func (m *myModule) example() *Terminal  {
	return dag.
			Infrabox().
			Terragrunt().
			Shell()
}

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

@func()
example(): Terminal {
	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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 with-cache-burster \
 container

func (m *myModule) example() *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			WithCacheBurster()
}

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

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

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)

Example

dagger -m github.com/Dudesons/daggerverse/infrabox@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 plan --work-dir string \
 container

func (m *myModule) example(workDir string) *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			Plan(workDir)
}

@function
def example(work_dir: str) -> dag.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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 apply --work-dir string \
 container

func (m *myModule) example(workDir string) *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			Apply(workDir)
}

@function
def example(work_dir: str) -> dag.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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 format --work-dir string --check boolean \
 container

func (m *myModule) example(workDir string, check bool) *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			Format(workDir, check)
}

@function
def example(work_dir: str, check: bool) -> dag.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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 output --work-dir string --is-json boolean \
 container

func (m *myModule) example(workDir string, isJson bool) *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			Output(workDir, isJson)
}

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

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

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@41e1f414c163b6676acd03c184d37e3ec8a64b2b call \
 terragrunt \
 run-all --work-dir string --cmd string \
 container

func (m *myModule) example(workDir string, cmd string) *InfraboxTf  {
	return dag.
			Infrabox().
			Terragrunt().
			RunAll(workDir, cmd)
}

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

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

catalog()

expose the module catalog (only available for terragrunt)

Return Type

Terminal !

Example

Function InfraboxTf.catalog is not accessible from the infrabox module

func (m *myModule) example() *Terminal  {
	return dag.
			Infrabox().
			Terragrunt().
			Catalog()
}

@function
def example() -> dag.Terminal:
	return (
		dag.infrabox()
		.terragrunt()
		.catalog()
	)

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