## 🚨 CRITICAL GUIDELINES ### Windows File Path Requirements **MANDATORY: Always Use Backslashes on Windows for File Paths** When using Edit or Write tools on Windows, you MUST use backslashes (`\`) in file paths, NOT forward slashes (`/`). **Examples:** - ❌ WRONG: `D:/repos/project/file.tsx` - ✅ CORRECT: `D:\repos\project\file.tsx` This applies to: - Edit tool file_path parameter - Write tool file_path parameter - All file operations on Windows systems ### Documentation Guidelines **NEVER create new documentation files unless explicitly requested by the user.** - **Priority**: Update existing README.md files rather than creating new documentation - **Repository cleanliness**: Keep repository root clean - only README.md unless user requests otherwise - **Style**: Documentation should be concise, direct, and professional - avoid AI-generated tone - **User preference**: Only create additional .md files when user specifically asks for documentation --- # OpenTofu Expertise and Migration Guide ## Overview OpenTofu is the open-source fork of Terraform, created in 2023 after HashiCorp changed Terraform's license from MPL 2.0 to BSL (Business Source License). OpenTofu is stewarded by the Linux Foundation and maintains full compatibility with Terraform 1.5.x while adding community-driven features. ## Key Differences (2025) ### Licensing **Terraform (HashiCorp):** - BSL (Business Source License) since August 2023 - Restrictions on commercial use for competing products - IBM acquired HashiCorp in 2024 **OpenTofu:** - MPL 2.0 (Mozilla Public License) - True open-source - Linux Foundation governance - Community-driven development ### Feature Innovations (2025) **OpenTofu 1.7 Features:** - **State Encryption**: Client-side encryption (community requested for 5+ years) - **Loop-able Import Blocks**: for_each in import blocks - **Dynamic Provider Functions**: Provider-defined functions support - **Early Variable Evaluation**: Variables in terraform block **OpenTofu 1.8 Features (Latest):** - **OpenTofu-Specific Overrides**: Balance compatibility with innovation - **Early Variable Evaluation Expanded**: Use variables/locals in module sources - **Enhanced Provider Support**: Improved provider SDK **Terraform Advantages:** - **HCP Terraform**: Cloud platform with Stacks, HYOK, Private VCS Access - **Enterprise Support**: Direct HashiCorp/IBM support - **Larger Ecosystem**: More established marketplace - **Sentinel Policies**: Policy-as-code framework (350+ NIST policies) ### Compatibility **100% Compatible:** - HCL syntax (same language) - Provider ecosystem (same registry access) - State file format (Terraform 1.5.x) - Module structure - CLI commands **Migration Path:** - Drop-in replacement for Terraform 1.5.x - No code changes required - State files portable (with encryption consideration) ## When to Use OpenTofu vs Terraform ### Choose OpenTofu When: 1. **Open-Source Requirements:** - Organization policy requires open-source tools - Want vendor neutrality - Concerned about future license changes 2. **State Encryption Needed:** - Compliance requires client-side encryption - Want encryption without HCP Terraform - Multi-cloud encryption requirements 3. **Cost Optimization:** - Want free state encryption - No need for HCP Terraform features - Budget constraints on tooling 4. **Community-Driven:** - Want to influence roadmap - Prefer Linux Foundation governance - Value community contributions ### Choose Terraform When: 1. **Enterprise Features Required:** - Need HCP Terraform Stacks - Require HYOK (Hold Your Own Key) - Want Private VCS Access - Need Sentinel policy enforcement 2. **Enterprise Support:** - Want direct HashiCorp/IBM support - Need SLA guarantees - Require compliance certifications 3. **Advanced Features:** - Ephemeral values (1.10+) - Terraform Query (1.14+) - Actions blocks (1.14+) - Latest provider features first 4. **Established Ecosystem:** - Existing HCP Terraform investment - Tight integration needs - Mature tooling requirements ## Migration from Terraform to OpenTofu ### Step 1: Assess Compatibility ```bash # Check Terraform version terraform version # Must be 1.5.x or compatible # Check provider versions terraform providers # All providers compatible (same registry) ``` ### Step 2: Install OpenTofu **Windows:** ```powershell # Chocolatey choco install opentofu # Scoop scoop install opentofu # Manual # Download from https://github.com/opentofu/opentofu/releases ``` **macOS:** ```bash # Homebrew brew install opentofu # Manual curl -L https://github.com/opentofu/opentofu/releases/download/v1.8.0/tofu_1.8.0_darwin_amd64.tar.gz | tar xz sudo mv tofu /usr/local/bin/ ``` **Linux:** ```bash # Snap snap install opentofu --classic # Debian/Ubuntu curl -fsSL https://get.opentofu.org/install-opentofu.sh | sh # Manual wget https://github.com/opentofu/opentofu/releases/download/v1.8.0/tofu_1.8.0_linux_amd64.tar.gz tar -xzf tofu_1.8.0_linux_amd64.tar.gz sudo mv tofu /usr/local/bin/ ``` ### Step 3: Test Compatibility ```bash # Navigate to Terraform directory cd /path/to/terraform/project # Initialize with OpenTofu (non-destructive) tofu init # Validate configuration tofu validate # Generate plan (compare with Terraform plan) tofu plan ``` ### Step 4: Migrate State (Optional) **If NOT using state encryption:** ```bash # State is compatible - no migration needed # Just switch from 'terraform' to 'tofu' commands # Verify state tofu show ``` **If ENABLING state encryption:** ```bash # Configure encryption in .tofu file cat > .tofu <> .env echo ".env" >> .gitignore # Use CI/CD secrets # GitHub: Repository Settings → Secrets # Azure DevOps: Pipeline → Variables → Secret ``` 2. **Rotate Keys Regularly:** ```bash # Generate new key NEW_KEY=$(openssl rand -base64 32) # Add to fallback, update configs # Migrate state tofu init -migrate-state ``` 3. **Backup Unencrypted State:** ```bash # Before enabling encryption terraform state pull > backup-unencrypted.tfstate # Enable encryption tofu init -migrate-state # Verify tofu state pull # Should be encrypted in backend ``` ## Loop-able Import Blocks (OpenTofu 1.7+) **Terraform 1.5+ (Single Imports):** ```hcl import { to = azurerm_resource_group.example id = "/subscriptions/.../resourceGroups/my-rg" } ``` **OpenTofu 1.7+ (Loop Imports):** ```hcl # Import multiple resource groups locals { resource_groups = { "rg1" = "/subscriptions/.../resourceGroups/rg1" "rg2" = "/subscriptions/.../resourceGroups/rg2" "rg3" = "/subscriptions/.../resourceGroups/rg3" } } import { for_each = local.resource_groups to = azurerm_resource_group.imported[each.key] id = each.value } resource "azurerm_resource_group" "imported" { for_each = local.resource_groups name = each.key location = "eastus" } ``` ## Early Variable Evaluation (OpenTofu 1.7+) **Terraform 1.5.x:** ```hcl # Variables NOT allowed in terraform block terraform { required_version = ">= 1.5.0" # Static only backend "azurerm" { resource_group_name = "terraform-state" # Static only storage_account_name = "tfstate" } } ``` **OpenTofu 1.7+:** ```hcl # Variables allowed in terraform block variable "environment" { type = string } terraform { required_version = ">= 1.7.0" backend "azurerm" { resource_group_name = "terraform-state-${var.environment}" storage_account_name = "tfstate${var.environment}" key = "${var.environment}.tfstate" } } ``` **OpenTofu 1.8+ (Module Sources):** ```hcl variable "module_version" { type = string default = "v1.0.0" } module "networking" { source = "git::https://github.com/org/module.git?ref=${var.module_version}" # Dynamic module version! } ``` ## Practical Migration Examples ### Example 1: Small Project Migration ```bash # 1. Backup existing state terraform state pull > backup.tfstate # 2. Install OpenTofu brew install opentofu # 3. Test compatibility tofu init tofu plan # 4. Switch to OpenTofu alias terraform=tofu # Optional: maintain muscle memory # 5. Verify everything works tofu apply ``` ### Example 2: Enterprise Migration with Encryption ```bash # 1. Generate encryption key ENCRYPTION_KEY=$(openssl rand -base64 32) echo "TOFU_ENCRYPTION_KEY=$ENCRYPTION_KEY" >> .env.production # 2. Create encryption config cat > .tofu <