1539 Terraform Roadmap 820fb50a

Terraform Support Roadmap

Extending Agentic InfraOps to support Terraform alongside Bicep

This guide outlines the roadmap for adding Terraform support to the Agentic InfraOps workflow. Currently, the project uses Bicep as the primary IaC language. Terraform support will enable multi-cloud scenarios and support organizations with existing Terraform investments.

[!NOTE] Status: Planned - See Issue #85 for progress tracking.

Overview

Adding Terraform support requires changes across several areas:

1. Dev Container Configuration

Features

Add to .devcontainer/devcontainer.json:

"features": {
  // Existing features...
  "ghcr.io/devcontainers/features/terraform:1": {
    "installTFsec": true,
    "installTerragrunt": false,
    "version": "latest"
  },
  "ghcr.io/devcontainers/features/go:1": {
    "version": "latest"  // For Terratest
  }
}

Environment Variables

"containerEnv": {
  "TF_PLUGIN_CACHE_DIR": "/home/vscode/.terraform-cache"
}

Post-Create Script

Update post-create.sh:

# Create Terraform plugin cache directory
mkdir -p "${HOME}/.terraform-cache"
chmod 755 "${HOME}/.terraform-cache"

# Install Infracost for cost estimation
curl -fsSL https://raw.githubusercontent.com/infracost/infracost/master/scripts/install.sh | sh

2. VS Code Extensions

Add to the extensions array:

Editor Settings

"settings": {
  "[terraform]": {
    "editor.tabSize": 2,
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "hashicorp.terraform"
  },
  "[terraform-vars]": {
    "editor.tabSize": 2
  }
}

3. Git Configuration

.gitignore Additions

# Terraform
*.tfstate
*.tfstate.backup
*.tfstate.*.backup
.terraform/
.terraform.lock.hcl
*.tfvars
!*.tfvars.example
crash.log
crash.*.log
override.tf
override.tf.json
*_override.tf
*_override.tf.json

# Infracost
.infracost/

.gitattributes Additions

# Terraform files
*.tf           text eol=lf linguist-language=HCL
*.tfvars       text eol=lf linguist-language=HCL
*.hcl          text eol=lf linguist-language=HCL

# Go files (for Terratest)
*.go           text eol=lf

4. Copilot Agents

terraform-plan.agent.md

---
name: Terraform Planning
description: Creates Terraform implementation plans from architecture assessments
tools:
  - semantic_search
  - read_file
  - list_dir
  - create_file
---

Responsibilities:

1. Analyze 02-architecture-assessment.md for infrastructure requirements
2. Map requirements to Terraform resources and AVM modules
3. Discover governance constraints via Azure Resource Graph
4. Generate 04-implementation-plan.md with Terraform-specific guidance
5. Create 04-governance-constraints.md with provider requirements

terraform-code.agent.md

---
name: Terraform Code
description: Generates Terraform configurations from implementation plans
tools:
  - semantic_search
  - read_file
  - create_file
  - replace_string_in_file
  - run_in_terminal
---

Responsibilities:

1. Follow 04-implementation-plan.md specifications
2. Use Azure Verified Modules for Terraform (AVM-TF)
3. Generate modular code in infra/terraform/{project}/
4. Create 05-implementation-reference.md
5. Run terraform fmt and terraform validate

terraform-deploy.agent.md

---
name: Terraform Deploy
description: Deploys Terraform configurations to Azure
tools:
  - run_in_terminal
  - read_file
  - create_file
---

Responsibilities:

1. Run terraform init with proper backend configuration
2. Execute terraform plan and save plan file
3. Apply after user approval
4. Generate 06-deployment-summary.md with outputs

5. Copilot Skills

Skill Parity Matrix

terraform-deployment-preflight Skill

Validates before deployment:

• Provider version constraints
• Required provider features enabled
• State backend accessibility
• Variable validation passes
• terraform plan succeeds
• No tfsec critical/high findings

terraform-cost-estimate Skill

Integrates with Infracost:

# Generate cost estimate
infracost breakdown --path . --format json > cost.json

# Compare with baseline
infracost diff --path . --compare-to baseline.json

6. Instruction Files

terraform-code-best-practices.instructions.md

---
applyTo: "**/*.tf"
description: "Infrastructure as Code best practices for Terraform configurations"
---

# Terraform Code Best Practices

## Provider Configuration

- Pin versions with pessimistic constraint: `~> 3.0`
- Configure backend for remote state (Azure Storage recommended)
- Use provider aliases for multi-region deployments
- Enable required features explicitly

## Module Structure

infra/terraform/{project}/
├── main.tf           # Root module, module calls
├── variables.tf      # Input variables with validation
├── outputs.tf        # Output values
├── providers.tf      # Provider configuration
├── versions.tf       # Terraform and provider versions
├── locals.tf         # Local values
├── data.tf           # Data sources
└── modules/          # Child modules
    └── {module}/
        ├── main.tf
        ├── variables.tf
        ├── outputs.tf
        └── README.md

## Security Requirements

- Never hardcode secrets - use Key Vault data sources
- Enable diagnostic settings on all resources
- Use `sensitive = true` for secret outputs
- Implement network security by default

## Naming Conventions

Follow CAF: `{type}-{workload}-{env}-{region}-{instance}`

## Azure Verified Modules (AVM-TF)

PREFER AVM modules from: `Azure/terraform-azurerm-avm-*`

Example:
```hcl
module "keyvault" {
  source  = "Azure/avm-res-keyvault-vault/azurerm"
  version = "~> 0.5"

  name                = "kv-${var.workload}-${var.environment}"
  resource_group_name = azurerm_resource_group.main.name
  location            = azurerm_resource_group.main.location
  tags                = local.tags
}

---

## 7. CI/CD Workflows

### terraform-validate.yml

```yaml
name: Terraform Validation

on:
  pull_request:
    paths:
      - "infra/terraform/**"
      - ".github/workflows/terraform-*.yml"

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: hashicorp/setup-terraform@v3
        with:
          terraform_version: "~1.7"

      - name: Terraform Format Check
        run: terraform fmt -check -recursive -diff
        working-directory: infra/terraform

      - name: Terraform Init
        run: |
          for dir in */; do
            echo "::group::Init $dir"
            terraform -chdir="$dir" init -backend=false
            echo "::endgroup::"
          done
        working-directory: infra/terraform

      - name: Terraform Validate
        run: |
          for dir in */; do
            echo "::group::Validate $dir"
            terraform -chdir="$dir" validate
            echo "::endgroup::"
          done
        working-directory: infra/terraform

  security:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: tfsec Security Scan
        uses: aquasecurity/tfsec-action@v1.0.3
        with:
          working_directory: infra/terraform
          soft_fail: false

  cost:
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    steps:
      - uses: actions/checkout@v4

      - name: Infracost Breakdown
        uses: infracost/actions/setup@v3
        with:
          api-key: ${{ secrets.INFRACOST_API_KEY }}

      - name: Generate Cost Estimate
        run: |
          infracost breakdown --path infra/terraform \
            --format json --out-file /tmp/infracost.json

      - name: Post Cost Comment
        uses: infracost/actions/comment@v1
        with:
          path: /tmp/infracost.json
          behavior: update

8. Directory Structure

infra/
├── bicep/                    # Existing Bicep templates
│   └── {project}/
└── terraform/                # New Terraform templates
    ├── _baseline/            # Shared baseline modules
    │   ├── naming/
    │   ├── tagging/
    │   └── networking/
    └── {project}/
        ├── main.tf
        ├── variables.tf
        ├── outputs.tf
        ├── providers.tf
        ├── versions.tf
        ├── terraform.tfvars.example
        └── modules/

9. Learning Resources

Refer to the Prompt Guide for Terraform agent prompt examples once the Terraform agents are implemented.

docs/prompt-guide/
└── README.md          # Includes future Terraform section

10. Azure Verified Modules for Terraform

Common AVM-TF Modules

[!TIP] Search for AVM modules: https://registry.terraform.io/search/modules?q=avm&namespace=Azure

11. State Management

Recommended: Azure Storage Backend

terraform {
  backend "azurerm" {
    resource_group_name  = "rg-terraform-state"
    storage_account_name = "stterraformstate"
    container_name       = "tfstate"
    key                  = "{project}/{environment}.tfstate"
  }
}

State Locking

Azure Storage backend provides automatic state locking via blob leases.

State Security

• Enable storage account firewall
• Use private endpoints for production
• Enable soft delete for state recovery
• Use customer-managed keys (CMK) for encryption

Summary

[!IMPORTANT] This roadmap enables Terraform to coexist with Bicep while maintaining the structured Agentic InfraOps workflow. Organizations can choose their preferred IaC tool per project.

References

• Azure Verified Modules for Terraform
• Terraform Azure Provider
• Infracost Documentation
• tfsec Security Scanner
• Terratest
• Issue #85: Add Terraform Support