From devops-skills
Generates Terragrunt HCL files including root.hcl, terragrunt.hcl, stacks, child modules, multi-env layouts, and dependency wiring with 2025 features like feature flags and exclude blocks.
npx claudepluginhub akin-ozer/cc-devops-skills --plugin devops-skillsThis skill uses the workspace's default tool permissions.
Generate production-ready Terragrunt configurations following current best practices, naming conventions, and security standards. All generated configurations are automatically validated.
Searches, retrieves, and installs Agent Skills from prompts.chat registry using MCP tools like search_skills and get_skill. Activates for finding skills, browsing catalogs, or extending Claude.
Searches prompts.chat for AI prompt templates by keyword or category, retrieves by ID with variable handling, and improves prompts via AI. Use for discovering or enhancing prompts.
Checks Next.js compilation errors using a running Turbopack dev server after code edits. Fixes actionable issues before reporting complete. Replaces `next build`.
Generate production-ready Terragrunt configurations following current best practices, naming conventions, and security standards. All generated configurations are automatically validated.
Use this skill when the user asks for:
root.hcl, terragrunt.hcl, or terragrunt.stack.hcldev/staging/prod)dependency or dependencies blocks)tfr:///)catalog/units/*Terragrunt 2025 Features Supported:
terragrunt.stack.hcl (GA since v0.78.0)feature blocksskip)retryable_errors)RECOMMENDED: Use
root.hclinstead ofterragrunt.hclfor root files per migration guide.
| Approach | Root File | Include Syntax |
|---|---|---|
| Modern | root.hcl | find_in_parent_folders("root.hcl") |
| Legacy | terragrunt.hcl | find_in_parent_folders() |
Include standard: Default to find_in_parent_folders("root.hcl") in all new examples and generated configs. Use find_in_parent_folders() only when explicitly targeting a legacy root file named terragrunt.hcl.
CRITICAL: Before generating ANY configuration, you MUST determine the architecture pattern and understand its constraints.
Use when: Managing multiple environments (dev/staging/prod) with shared root configuration.
Key principle: root.hcl is environment-agnostic - it does NOT read environment-specific files.
infrastructure/
├── root.hcl # Environment-AGNOSTIC (no env.hcl references)
├── dev/
│ ├── env.hcl # Environment variables (locals block)
│ ├── vpc/terragrunt.hcl
│ └── rds/terragrunt.hcl
└── prod/
├── env.hcl # Environment variables (locals block)
├── vpc/terragrunt.hcl
└── rds/terragrunt.hcl
Root.hcl constraints:
read_terragrunt_config(find_in_parent_folders("env.hcl")) - env.hcl doesn't exist at root levellocal.environment or local.aws_region that come from env.hclget_env() for runtime configuration${path_relative_to_include()} for state keys (this works dynamically)Child modules read env.hcl:
# dev/vpc/terragrunt.hcl
include "root" {
path = find_in_parent_folders("root.hcl")
}
locals {
env = read_terragrunt_config(find_in_parent_folders("env.hcl"))
}
inputs = {
name = "${local.env.locals.environment}-vpc" # Works: env.hcl exists in dev/
}
Use when: Single environment OR all environments share the same root with environment detection.
infrastructure/
├── root.hcl # Can be environment-aware via get_env() or directory parsing
├── account.hcl # Account-level config (optional)
├── region.hcl # Region-level config (optional)
└── vpc/
└── terragrunt.hcl
Root.hcl can detect environment:
# root.hcl - environment detection via directory path
locals {
# Parse environment from path (e.g., "prod/vpc" -> "prod")
path_parts = split("/", path_relative_to_include())
environment = local.path_parts[0]
# OR use environment variable
environment = get_env("TG_ENVIRONMENT", "dev")
}
Use when: Centralizing environment variables with symlinks or direct references.
infrastructure/
├── root.hcl # Environment-AGNOSTIC
├── _env/ # Centralized environment definitions
│ ├── prod.hcl
│ ├── staging.hcl
│ └── dev.hcl
├── prod/
│ ├── env.hcl # Reads from _env/prod.hcl
│ └── vpc/terragrunt.hcl
└── dev/
├── env.hcl # Reads from _env/dev.hcl
└── vpc/terragrunt.hcl
env.hcl reads from _env:
# prod/env.hcl
locals {
env_vars = read_terragrunt_config("${get_repo_root()}/_env/prod.hcl")
# Re-export for child modules
environment = local.env_vars.locals.environment
aws_region = local.env_vars.locals.aws_region
vpc_cidr = local.env_vars.locals.vpc_cidr
# ... other variables
}
MANDATORY: Before writing any files, you MUST complete this checklist and OUTPUT it to the user with checkmarks filled in. This is not optional.
Output this completed checklist before generating any files:
## Architecture Pattern Selection
[x] Identified architecture pattern: Pattern ___ (A/B/C)
[x] Root.hcl scope: [ ] environment-agnostic OR [ ] environment-aware
[x] env.hcl location: ___________________
[x] Child modules access env via: ___________________
[x] Verified: No file references a path that doesn't exist from its location
Example completed checklist:
## Architecture Pattern Selection
[x] Identified architecture pattern: Pattern A (Multi-Environment with Environment-Agnostic Root)
[x] Root.hcl scope: [x] environment-agnostic OR [ ] environment-aware
[x] env.hcl location: dev/env.hcl, prod/env.hcl (one per environment)
[x] Child modules access env via: read_terragrunt_config(find_in_parent_folders("env.hcl"))
[x] Verified: No file references a path that doesn't exist from its location
Use these starter files for Pattern B and account/region-aware setups.
env.hcl
locals {
environment = "dev"
aws_region = "us-east-1"
project = "platform"
}
account.hcl
locals {
account_id = "123456789012"
account_name = "shared-services"
}
region.hcl
locals {
aws_region = "us-east-1"
}
Create root-level root.hcl or terragrunt.hcl with remote state, provider config, and common variables.
MANDATORY: Before generating, READ the template file:
Read: assets/templates/root/terragrunt.hcl
Template: assets/templates/root/terragrunt.hcl
Patterns: references/common-patterns.md → Root Configuration Patterns
Key placeholders to replace:
[BUCKET_NAME], [AWS_REGION], [DYNAMODB_TABLE][TERRAFORM_VERSION], [PROVIDER_NAME], [PROVIDER_SOURCE], [PROVIDER_VERSION][ENVIRONMENT], [PROJECT_NAME]Root.hcl Design Principles:
get_env() for runtime configpath_relative_to_include() - This automatically includes environment pathCreate child modules with dependencies, mock outputs, and proper includes.
MANDATORY: Before generating, READ the template file:
Read: assets/templates/child/terragrunt.hcl
Template: assets/templates/child/terragrunt.hcl
Patterns: references/common-patterns.md → Child Module Patterns
Module source options:
"../../modules/vpc""git::https://github.com/org/repo.git//path?ref=v1.0.0""tfr:///terraform-aws-modules/vpc/aws?version=5.1.0"Self-contained modules without root dependency.
MANDATORY: Before generating, READ the template file:
Read: assets/templates/module/terragrunt.hcl
Template: assets/templates/module/terragrunt.hcl
Use this map for every generated output:
| Placeholder | Meaning | Example Replacement | Notes |
|---|---|---|---|
[AWS_REGION] | AWS region | us-east-1 | Canonical region placeholder in all templates |
[ENVIRONMENT] | Environment name | dev | Keep lowercase for directory naming |
[PROJECT_NAME] | Project/application name | payments-platform | Use the same value in tags and names |
[BUCKET_NAME] | Remote state S3 bucket | acme-tfstate-prod | Bucket must exist before first apply |
[DYNAMODB_TABLE] | State lock table | acme-terraform-locks | Table must exist before first apply |
[PROVIDER_SOURCE] | Terraform provider source | hashicorp/aws | Use fully qualified source |
[TERRAFORM_VERSION] | Required Terraform/OpenTofu version | 1.8.5 | Used in both terraform_version_constraint and required_version. Keep compatible with module constraints. |
Legacy alias normalization: If you see [REGION] in older examples, treat it as [AWS_REGION] and replace it before validation.
Complete directory structures for dev/staging/prod.
MANDATORY: Before generating:
- Determine architecture pattern (see Architecture Patterns section)
- Read relevant templates for root, env, and child modules
- Verify env.hcl placement and access patterns:
Read: assets/templates/env/env.hcl
Patterns: references/common-patterns.md → Environment-Specific Patterns
Typical structure (Pattern A - Environment-Agnostic Root):
infrastructure/
├── root.hcl # Environment-AGNOSTIC root config
├── dev/
│ ├── env.hcl # Dev environment variables
│ └── vpc/terragrunt.hcl
└── prod/
├── env.hcl # Prod environment variables
└── vpc/terragrunt.hcl
Infrastructure blueprints using terragrunt.stack.hcl.
MANDATORY: Before generating, READ the template files:
Read: assets/templates/stack/terragrunt.stack.hcl Read: assets/templates/catalog/terragrunt.hcl
Docs: Stacks Documentation
Template: assets/templates/stack/terragrunt.stack.hcl
Catalog Template: assets/templates/catalog/terragrunt.hcl
Patterns: references/common-patterns.md → Stacks Patterns
Stack path rule: Keep no_dot_terragrunt_stack mode consistent across dependent units. Do not mix direct-path and .terragrunt-stack generation in the same dependency chain.
Commands:
terragrunt stack generate # Generate unit configurations
terragrunt stack run plan # Plan all units
terragrunt stack run apply # Apply all units
terragrunt stack output # Get aggregated outputs
terragrunt stack clean # Clean generated directories
Runtime control without code changes.
Docs: Feature Flags Documentation
Patterns: references/common-patterns.md → Feature Flags Patterns
CRITICAL: Feature flag
defaultvalues MUST be static (boolean, string, number). They CANNOT referencelocal.*values. Use static defaults and override via CLI/env vars.
Correct:
feature "enable_monitoring" {
default = false # Static value - OK
}
Incorrect:
feature "enable_monitoring" {
default = local.env.locals.enable_monitoring # Dynamic reference - FAILS
}
Usage:
terragrunt apply --feature enable_monitoring=true
# or
export TG_FEATURE="enable_monitoring=true"
Environment-specific defaults: Use different static defaults per environment file, not dynamic references.
Fine-grained execution control (replaces deprecated skip).
Docs: Exclude Block Reference
Patterns: references/common-patterns.md → Exclude Block Patterns
Actions: "plan", "apply", "destroy", "all", "all_except_output"
Production Recommendation: For critical production resources, add exclude blocks to prevent accidental destruction:
# Protect production databases from accidental destroy
exclude {
if = true
actions = ["destroy"]
exclude_dependencies = false
}
# Also use prevent_destroy for critical resources
prevent_destroy = true
Advanced error handling (replaces deprecated retryable_errors).
Docs: Errors Block Reference
Patterns: references/common-patterns.md → Errors Block Patterns
Use OpenTofu as the IaC engine.
Docs: Engine Documentation
Patterns: references/common-patterns.md → OpenTofu Engine Patterns
When generating configs with custom providers:
"[provider] terraform provider [version] documentation"required_providers blockCRITICAL: Follow this workflow for EVERY generation task. Skipping steps leads to validation errors.
MANDATORY: Select and document the pattern BEFORE writing any files.
| Scenario | Pattern | Root.hcl Scope |
|---|---|---|
| Multi-env with shared root | Pattern A | Environment-agnostic |
| Single environment | Pattern B | Environment-aware |
| Centralized env vars | Pattern C | Environment-agnostic |
Complete the Architecture Pattern Selection Checklist (Canonical) above and include it in output before file generation.
MANDATORY: Read the relevant template file(s) BEFORE generating each configuration type.
| Configuration Type | Template to Read | Purpose |
|---|---|---|
| Root configuration | assets/templates/root/terragrunt.hcl | Shared state backend, providers, and common inputs |
| Environment variables | assets/templates/env/env.hcl | Per-environment locals read by child modules (Pattern A) |
| Child module | assets/templates/child/terragrunt.hcl | Environment module wired to root include |
| Standalone module | assets/templates/module/terragrunt.hcl | Independent Terragrunt module without root include |
| Stack file | assets/templates/stack/terragrunt.stack.hcl | Blueprint that generates multiple units |
| Catalog unit | assets/templates/catalog/terragrunt.hcl | Reusable unit template consumed by stacks |
Also read:
references/common-patterns.md - Primary source for generation patternsValidation Strategy: Use a combination of inline checks during generation and batch validation at the end.
Generation order for multi-environment projects:
Generate root.hcl first
read_terragrunt_config(find_in_parent_folders("env.hcl")) if environment-agnosticremote_state block has encrypt = trueerrors block used (not deprecated retryable_errors)Generate env.hcl files for each environment
locals block contains environment, aws_region, and module-specific varsGenerate child modules (VPC, etc.) - modules with NO dependencies first
include block uses find_in_parent_folders("root.hcl")read_terragrunt_config(find_in_parent_folders("env.hcl")) presentterraform.source uses valid syntax (tfr:///, git::, or relative path)Generate dependent modules (RDS, EKS, etc.)
dependency blocks have mock_outputsmock_outputs_allowed_terraform_commands includes ["validate", "plan", "destroy"]prevent_destroy = true and/or exclude blockRun batch validation after ALL files are generated
Note: Full CLI validation (
terragrunt hcl fmt,terragrunt dag graph) requires all files to exist, so these are batched at the end.
# Batch validation commands (run after all files exist):
terragrunt hcl fmt --check # Format validation
terragrunt dag graph # Dependency graph validation
Skill(devops-skills:terragrunt-validator) for comprehensive validationIf validation fails:
Follow "Presentation Requirements" section below.
CRITICAL: Every generated configuration MUST be validated.
After generating root.hcl:
cd <infrastructure-directory>
terragrunt hcl fmt --check
After generating each child module:
cd <module-directory>
terragrunt hcl fmt --check
# If no dependencies on other modules:
terragrunt hcl validate --inputs
After all files are generated:
Invoke validation skill:
Invoke: Skill(devops-skills:terragrunt-validator)
If validation fails:
If validation succeeds: Present configurations with usage instructions
Skip validation only for: Partial snippets, documentation examples, or explicit user request
If the normal validation path is unavailable, use this fallback order and report what was skipped:
terragrunt is unavailable:
rg -n "\[[A-Z0-9_]+\]" .
rg -n "find_in_parent_folders\\(\"env\\.hcl\"\\)" .
terragrunt hcl fmt --check
terragrunt dag graph
tree is unavailable for presentation:
find . -maxdepth 4 -type f | sort
MANDATORY: After successful validation, you MUST present ALL of the following sections. Incomplete presentation is not acceptable. Copy and fill in the templates below.
# Show the generated structure
tree <infrastructure-directory>
Output this table with all generated files:
| File | Purpose |
|------|---------|
| root.hcl | Shared configuration for all child modules (state backend, provider) |
| dev/env.hcl | Development environment variables |
| prod/env.hcl | Production environment variables |
| dev/vpc/terragrunt.hcl | VPC module for development |
| ... | ... |
You MUST include this section. Copy the template below and fill in the actual values:
## Usage Instructions
### Prerequisites
Before running Terragrunt commands, ensure:
1. AWS credentials are configured (`aws configure` or environment variables)
2. S3 bucket `<BUCKET_NAME>` exists for state storage
3. DynamoDB table `<TABLE_NAME>` exists for state locking
### Commands
# Navigate to infrastructure directory
cd <INFRASTRUCTURE_DIR>
# Initialize all modules
terragrunt run --all init
# Preview changes for a specific environment
cd <ENV>/vpc && terragrunt plan
# Preview all changes
terragrunt run --all plan
# Apply changes (requires approval)
terragrunt run --all apply
# Destroy (use with extreme caution)
terragrunt run --all destroy
You MUST include this section. Copy the template below and fill in the actual values:
## Placeholder and Secrets Check
### Placeholder Replacement
- [ ] All placeholders (`[AWS_REGION]`, `[BUCKET_NAME]`, `[DYNAMODB_TABLE]`, etc.) replaced with real values
- [ ] No legacy placeholder aliases left (for example `[REGION]`)
- [ ] `terraform.source` values point to real module sources and pinned versions
### Secrets Safety
- [ ] No plaintext credentials or access keys in `terragrunt.hcl`, `root.hcl`, `env.hcl`, `account.hcl`, or `region.hcl`
- [ ] Sensitive values sourced via environment variables, secret managers, or CI variables
- [ ] Example values kept non-sensitive and clearly marked as placeholders
You MUST include this section. Copy the template below and fill in the actual values:
## Environment Notes
### Required Environment Variables
| Variable | Description | Example |
|----------|-------------|---------|
| AWS_PROFILE | AWS CLI profile to use | `my-profile` |
| AWS_REGION | AWS region (or set in provider) | `us-east-1` |
### Prerequisites
- [ ] S3 bucket `<BUCKET_NAME>` must exist before first run
- [ ] DynamoDB table `<TABLE_NAME>` must exist for state locking
- [ ] IAM permissions for Terraform state management
### Production-Specific Protections
| Module | Protection | Description |
|--------|------------|-------------|
| prod/rds | `prevent_destroy = true` | Prevents accidental database deletion |
| prod/rds | `exclude { actions = ["destroy"] }` | Blocks destroy commands |
Suggest what the user might want to do next (add more modules, customize configurations, etc.)
Reference ../terragrunt-validator/references/best_practices.md for comprehensive guidelines.
Key principles:
include blocks to inherit root configuration (DRY)encrypt = true)generate blocks for provider configuration~> 5.0, not >= 5.0) for local/Git modulesNote on Version Constraints with Registry Modules: When using Terraform Registry modules (e.g.,
tfr:///terraform-aws-modules/vpc/aws?version=5.1.0), they typically define their ownrequired_providers. In this case, you may omit generatingrequired_providersinroot.hclto avoid conflicts. The module's pinned version (?version=X.X.X) provides the version constraint. See "Common Issues → Provider Conflict with Registry Modules" for details.
Anti-patterns to avoid:
| Deprecated | Replacement | Reference |
|---|---|---|
skip | exclude block | Docs |
retryable_errors | errors.retry block | Docs |
run-all | run --all | Migration |
--terragrunt-* flags | Unprefixed flags | CLI Reference |
TERRAGRUNT_* env vars | TG_* env vars | CLI Reference |
| Configuration Type | Template File | Purpose | When to Read |
|---|---|---|---|
| Root configuration | assets/templates/root/terragrunt.hcl | Shared backend, provider, and common inputs | Before generating any root.hcl |
| Environment variables | assets/templates/env/env.hcl | Per-environment locals (environment, region, sizing, feature toggles) | Before generating any env.hcl (Pattern A) |
| Child module | assets/templates/child/terragrunt.hcl | Module include, source, and optional dependency scaffolding | Before generating any child module |
| Standalone module | assets/templates/module/terragrunt.hcl | Module config without root inheritance | Before generating standalone modules |
| Stack file | assets/templates/stack/terragrunt.stack.hcl | Stack blueprint and unit generation | Before generating stacks |
| Catalog unit | assets/templates/catalog/terragrunt.hcl | Reusable unit consumed by stack definitions | Before generating catalog units |
| Reference | Content | Purpose | When to Read |
|---|---|---|---|
references/common-patterns.md | All generation patterns with examples | Pick a compatible pattern before writing files | Always, before generating |
../terragrunt-validator/references/best_practices.md | Comprehensive best practices | Final quality and safety checks | Always, before generating |
Symptom:
Error: Attempt to get attribute from null value
on ./root.hcl line X:
This value is null, so it does not have any attributes.
Cause: Root.hcl is trying to read env.hcl via find_in_parent_folders("env.hcl"), but env.hcl doesn't exist at the root level.
Solution: Make root.hcl environment-agnostic:
# DON'T do this in root.hcl for multi-environment setups:
locals {
env_vars = read_terragrunt_config(find_in_parent_folders("env.hcl")) # FAILS
}
# DO use static values or get_env():
generate "provider" {
path = "provider.tf"
if_exists = "overwrite_terragrunt"
contents = <<EOF
provider "aws" {
region = "us-east-1" # Static value, or use get_env("AWS_REGION", "us-east-1")
}
EOF
}
When using Terraform Registry modules (e.g., tfr:///terraform-aws-modules/vpc/aws), they may define their own required_providers block. This can conflict with provider configuration generated by root.hcl.
Symptoms:
Error: Duplicate required providers configuration
Solutions:
Remove conflicting generate block - If using registry modules that manage their own providers, avoid generating duplicate required_providers:
# In root.hcl - only generate provider config, not required_providers
generate "provider" {
path = "provider.tf"
if_exists = "overwrite_terragrunt"
contents = <<EOF
provider "aws" {
region = "us-east-1"
}
EOF
}
Use if_exists = "skip" - Skip generation if file already exists:
generate "versions" {
path = "versions.tf"
if_exists = "skip" # Don't overwrite module's versions.tf
contents = "..."
}
Clear cache - If conflicts persist after fixes:
rm -rf .terragrunt-cache
terragrunt init
If you see Unknown variable; There is no variable named "local" in feature blocks, ensure defaults are static values (see Feature Flags section above).
Symptom:
Error: Attempt to get attribute from null value
on ./dev/vpc/terragrunt.hcl line X:
Cause: Child module's find_in_parent_folders("env.hcl") cannot find env.hcl.
Solution: Ensure env.hcl exists in the environment directory:
dev/
├── env.hcl # This file MUST exist
└── vpc/
└── terragrunt.hcl # Calls find_in_parent_folders("env.hcl")
Before generating, READ these files in order:
references/common-patterns.md - Understand available patterns../terragrunt-validator/references/best_practices.md - Know the rulesassets/templates/ - Structural referenceQ: Multiple environments (dev/staging/prod)?
├─ YES → Q: Shared root configuration?
│ ├─ YES → Pattern A: Environment-Agnostic Root
│ └─ NO → Separate root.hcl per environment
└─ NO → Q: Environment detection needed?
├─ YES → Pattern B: Environment-Aware Root
└─ NO → Pattern B: Simple single-environment
terragrunt hcl fmt --checkterragrunt hcl validate --inputsSkill(devops-skills:terragrunt-validator)This skill execution is complete only when ALL are true:
tfr:///NAMESPACE/NAME/PROVIDER?version=X.Y.Z format