Toggle navigation
Terragrunt
by
Gruntwork.io
Install
Quick Start
Docs
Use cases
Docs
/
Community
/
License
License
License
Documentation
Getting started
Quick start
Introduction
Keep your backend configuration DRY
Keep your provider configuration DRY
Keep your Terraform CLI arguments DRY
Promote immutable, versioned Terraform modules across environments
Next steps
Install
Install Terragrunt
Download from releases page
Install via a package manager
Configuration
Terragrunt configuration file
Configuration parsing order
Formatting terragrunt.hcl
Features
Keep your Terraform code DRY
Keep your Terraform code DRY
Motivation
Remote Terraform configurations
Achieve DRY Terraform code and immutable infrastructure
Working locally
Important gotcha: Terragrunt caching
Important gotcha: working with relative file paths
Using Terragrunt with private Git repos
DRY common Terraform code with Terragrunt generate blocks
Keep your remote state configuration DRY
Keep your remote state configuration DRY
Motivation
Filling in remote state settings with Terragrunt
Rules for merging parent and child configurations
Using the generate property to generate terraform code for managing remote state
Create remote state and locking resources automatically
S3-specific remote state settings
GCS-specific remote state settings
Keep your CLI flags DRY
Keep your CLI flags DRY
Motivation
Multiple extra_arguments blocks
extra_arguments
for
init
Required and optional var-files
Handling whitespace
Execute Terraform commands on multiple modules at once
Execute Terraform commands on multiple modules at once
Motivation
The apply-all, destroy-all, output-all and plan-all commands
Passing outputs between modules
Unapplied dependency and mock outputs
Dependencies between modules
Testing multiple modules locally
Limiting the module execution parallelism
Work with multiple AWS accounts
Work with multiple AWS accounts
Motivation
Configuring Terragrunt to assume an IAM role
Inputs
Inputs
Variable precedence
Locals
Locals
Including globally defined locals
Before and After Hooks
Before and After Hooks
Auto-init
Auto-Init
Auto-retry
Auto-Retry
Caching
Clearing the Terragrunt cache
AWS Auth
AWS credentials
AWS IAM policies
Community
Contributing
Contributing
Contribution Guidelines
File a GitHub issue or write an RFC
Update the documentation
Update the tests
Update the code
Create a pull request
Merge and release
Developing Terragrunt
Running locally
Dependencies
Running tests
Debug logging
Error handling
Formatting
Releasing new versions
Support
Stack Overflow
Github Issues
Commercial support
License
License
Reference
CLI options
terragrunt-config
terragrunt-tfpath
terragrunt-no-auto-init
terragrunt-no-auto-retry
terragrunt-non-interactive
terragrunt-working-dir
terragrunt-download-dir
terragrunt-source
terragrunt-source-update
terragrunt-ignore-dependency-errors
terragrunt-iam-role
terragrunt-exclude-dir
terragrunt-include-dir
terragrunt-strict-include
terragrunt-ignore-dependency-order
terragrunt-ignore-external-dependencies
terragrunt-include-external-dependencies
terragrunt-check
terragrunt-hclfmt-file
Built-in functions
Terraform built-in functions
find_in_parent_folders
path_relative_to_include
path_relative_from_include
get_env
get_platform
get_terragrunt_dir
get_parent_terragrunt_dir
get_terraform_commands_that_need_vars
get_terraform_commands_that_need_input
get_terraform_commands_that_need_locking
get_terraform_commands_that_need_parallelism
get_aws_account_id
get_aws_caller_identity_arn
get_terraform_command
get_terraform_cli_args
get_aws_caller_identity_user_id
run_cmd
read_terragrunt_config
sops_decrypt_file
Configuration Blocks and Attributes
Blocks
terraform
remote_state
include
locals
dependency
dependencies
generate
Attributes
inputs
download_dir
prevent_destroy
skip
iam_role
terraform_binary
terraform_version_constraint
terragrunt_version_constraint
License
This code is released under the MIT License. See
LICENSE.txt
.
Use cases
Keep your Terraform code DRY
Keep your remote state configuration DRY
Keep your CLI flags DRY
Execute Terraform commands on multiple modules at once
Work with multiple AWS accounts
Links
Install
Quick start
Full documentation
Install
