|
| 1 | +# Prefer OpenTofu; Minimize Friction |
| 2 | + |
| 3 | +Gruntwork is a co-founder and active maintainer of [OpenTofu](https://opentofu.org/), the open source successor to HashiCorp Terraform. We proudly support OpenTofu because we believe that core infrastructure should run on proven open source technology. In line with this philosophy, Gruntwork IaC Library aims to provide first-class OpenTofu support. |
| 4 | + |
| 5 | +But we also know that platform teams may be on very early versions of Terraform (pre-1.0) or still on Terraform 1.5.7, and that upgrading to the latest OpenTofu is yet another item on their plate of competing priorities. This means we must balance the benefits of embracing the latest OpenTofu functionality with the real-world costs of migration. |
| 6 | + |
| 7 | +## Core principle |
| 8 | + |
| 9 | +We prefer OpenTofu over Terraform but design our modules to work seamlessly with both whenever possible, ensuring customers can adopt OpenTofu without syntax changes or configuration rewrites. |
| 10 | + |
| 11 | +## Implementation |
| 12 | + |
| 13 | +### Approach |
| 14 | + |
| 15 | +1. We design our modules to work with both OpenTofu and Terraform, prioritizing features that work identically in both tools. |
| 16 | +2. When we do adopt OpenTofu-specific features, we use `.tofu` files and provide clear migration guidance. |
| 17 | + |
| 18 | +### OpenTofu/Terraform version support |
| 19 | + |
| 20 | +- **OpenTofu**: We support OpenTofu 1.9 for new features that provide significant customer value. |
| 21 | +- **Terraform**: We maintain compatibility with Terraform versions that support the same OpenTofu language features we use, but do not explicitly test or support Terraform versions beyond 1.5.7. |
| 22 | + |
| 23 | +### OpenTofu feature adoption |
| 24 | + |
| 25 | +When evaluating new OpenTofu language features for use in Gruntwork modules: |
| 26 | + |
| 27 | +1. **Dual-compatible features (Preferred)**: Features that work identically in both OpenTofu and Terraform should be placed in `.tf` files. (e.g. see [cross-variable validation](#cross-variable-validation) below.) |
| 28 | +2. **OpenTofu-only Features (Discouraged)**: Features that only work in OpenTofu should be placed in `.tofu` files and used sparingly. Terraform ignores `.tofu` files, while OpenTofu reads both `.tf` and `.tofu`. Avoid duplicating the same blocks across both extensions; prefer additive enhancements in `.tofu`. This approach increases maintenance cost, so we will use it only when the user benefit is clear. |
| 29 | +3. **Terraform-only Features**: We do not support Terraform-specific features. |
| 30 | + |
| 31 | +## Current feature adoption |
| 32 | + |
| 33 | +### Cross-variable validation |
| 34 | + |
| 35 | +We now support cross-variable validation (the ability to reference the values of other variables in `variable` validation blocks) because: |
| 36 | +- It significantly improves module usability by preventing invalid input combinations |
| 37 | +- It works identically in both OpenTofu 1.9+ and Terraform 1.9+ |
| 38 | +- It addresses direct customer feedback about configuration errors |
| 39 | + |
| 40 | +## Future evolution |
| 41 | + |
| 42 | +This principle will evolve as the OpenTofu and Terraform ecosystems develop. We will: |
| 43 | +- Regularly review compatibility and our support policy based on customer needs |
| 44 | +- Update our supported feature list as new stable releases become available |
| 45 | +- Clearly communicate any changes to our compatibility strategy |
| 46 | +- Regularly review any customer request for adoption of new features |
0 commit comments