Native Terragrunt
Use an existing Terragrunt HCL unit as an Atmos Terraform component without adding Atmos stack YAML. The example discovers component demo in stack live, evaluates its HCL with Terragrunt Go modules,…
Try it out
- Install Atmos
- Try the example
Copy the example into a new directory and make it your own:
atmos init examples/terragrunt-native
cd terragrunt-native
Follow the README for prerequisites and next steps.
Native Terragrunt
Use an existing Terragrunt HCL unit as an Atmos Terraform component without adding
Atmos stack YAML. The example discovers component demo in stack live, evaluates
its HCL with Terragrunt Go modules, and executes OpenTofu through Atmos. It does not
run the Terragrunt executable.
The module uses the built-in terraform_data resource and local state. No cloud
credentials or provider downloads are needed.
Build the development package
This example requires the experimental Atmos branch and its local Terragrunt plugin. See plugin usage for package configuration. The plugin is not yet published. Install Go and OpenTofu, then run these commands from the root of the Atmos checkout containing this example:
go build -o build/atmos .export PATH="$PWD/build:$PATH"atmos plugin build plugins/terragruntexport ATMOS_TERRAGRUNT_PLUGIN_PATH="$PWD/plugins/terragrunt"
Copy the example into a new directory, then configure the package path:
atmos init ./examples/terragrunt-native ./terragrunt-native --copy --no-gitcd terragrunt-nativeatmos config set plugins.packages.terragrunt.path "$ATMOS_TERRAGRUNT_PLUGIN_PATH"
The example already enables native discovery. To enable the same behavior in an existing project, run these commands from that project's root:
atmos config set plugins.packages.terragrunt.path "$ATMOS_TERRAGRUNT_PLUGIN_PATH"atmos config set components.terraform.command tofuatmos config set components.terraform.terragrunt.enabled trueatmos config set components.terraform.terragrunt.mode nativeatmos config set --type=yaml components.terraform.terragrunt.discovery.included_paths '["live/**"]'atmos config set components.terraform.terragrunt.discovery.enabled true
The environment variable above is only a shell convenience for these commands.
The plugin path is stored in atmos.yaml; Atmos does not require that variable on
subsequent runs. Adjust included_paths to match your Terragrunt directory layout.
If you use Terraform instead, set components.terraform.command to terraform
and install Terraform 1.4 or newer.
Discover and plan
atmos list stacksatmos list instancesatmos terraform plan demo -s live
The plan contains one terraform_data.demo resource with the input
HELLO FROM TERRAGRUNT, evaluated by HCL's upper function. Atmos prepares an isolated workdir; the source HCL and
module stay in place. The local backend retains the unit's state path at
live/demo/state/terraform.tfstate.
Apply and clean up
atmos terraform apply demo -s live -- -auto-approveatmos terraform output demo -s live -- -raw greetingatmos terraform plan demo -s live -- -detailed-exitcodeatmos terraform destroy demo -s live -- -auto-approve
After apply, output prints the greeting and the unchanged plan exits with code zero. Destroy removes the local test resource. This example demonstrates one local unit; it does not establish compatibility with all Terragrunt constructs.