generate

Usage

Generate a stack of units based on configurations in a terragrunt.stack.hcl file.

Examples

Generate a stack of units using the configurations in a terragrunt.stack.hcl file.

terragrunt stack generate

Generating a stack

terragrunt.stack.hcl

unit "mother" {
  source = "units/chicken"
  path   = "mother"
}

unit "father" {
  source = "./units/chicken"
  path   = "father"
}

unit "chick_1" {
  source = "./units/chick"
  path   = "chicks/chick-1"
}

unit "chick_2" {
  source = "units/chick"
  path   = "chicks/chick-2"
}

Running the following:

terragrunt stack generate

Generates the following stack:

• terragrunt.stack.hcl
• Directory.terragrunt-stack

  • Directorymother

    • terragrunt.hcl
  • Directoryfather

    • terragrunt.hcl
  • Directorychicks

    • Directorychick-1

      • terragrunt.hcl
    • Directorychick-2

      • terragrunt.hcl

Note

Parallel Execution: Stack generation runs concurrently to improve performance. The number of parallel tasks is determined by the GOMAXPROCS environment variable and can be explicitly controlled using the --parallelism flag:

terragrunt stack generate --parallelism 4

Automatic Discovery: The command automatically discovers all terragrunt.stack.hcl files within the directory structure and generates them in parallel.

Validation of Units and Stacks: During the stack generation, the system will validate that each unit and stack’s target directory contains the appropriate configuration file (terragrunt.hcl for units and terragrunt.stack.hcl for stacks). This ensures the directories are correctly structured before proceeding with the stack generation. To skip this validation, you can use the --no-stack-validate flag:

terragrunt stack generate --no-stack-validate

Caution

Path Restrictions: If an absolute path is provided as an argument, generate will throw an error. Only relative paths within the working directory are supported.