Intro
This guide will walk you through how to update the Gruntwork Reference Architecture and any code that depends on the Gruntwork Infrastructure as Code Library to Terraform 0.13. Terraform 0.13 introduces a number of new features and fixes, but it also has a number of backwards incompatibilities that have to be incorporated into your codebase.
What you’ll learn in this guide
This guide consists of two main sections:
- Core Concepts
-
An overview of Terraform 0.13 and why it is important to update your code for compatibility.
- Deployment walkthrough
-
The steps you need to take to update your code relying on the Gruntwork Infrastructure as Code library and your version of the Gruntwork Reference Architecture to work with Terraform 0.13. Includes a version compatibility table you can use as a reference to know which Gruntwork Repo version tag is compatible with Terraform 0.13.
Core Concepts
Background
Terraform 0.13 was released on August 10th, 2020. Some of the major new features in 0.13 include:
-
The ability to use
count,for_each, anddepends_onwith modules. -
A new
required_providersblock that makes it much easier to work with third-party providers. -
Custom variable validation.
For more info, check out the announcement blog post.
0.13 is a major new release for Terraform, which means it includes a number of backwards incompatible changes. We have gone through all the Terraform modules in the Gruntwork Infrastructure as Code Library and updated them to work with Terraform 0.13. In order to use 0.13, you will need to update to these new versions and make other changes to your code, as described in the following section.
Deployment walkthrough
Step 1: update your code to be compatible with Terraform 0.12
If you haven’t already, you need to:
-
Update your code to work with Terraform 0.12. Do NOT skip from, say, 0.11, straight to 0.13. You MUST update to 0.12.26 or above first! If you’re still on Terraform 0.11 or older, see our Terraform 0.12 upgrade guide for instructions.
-
Update all your Gruntwork modules to the latest versions just before the TF 0.13 versions in the compatibility table below. The upgrade will be much easier and less error prone if you keep the number of version jumps as small as possible.
Step 2: update your code to be compatible with Terraform 0.13
The first step is to update your own code (e.g., the code that lives in your infrastructure-modules repo) to be
compatible with Terraform 0.13 by following HashiCorp’s Terraform 0.13
Upgrade Guide.
Step 3: update references to the Gruntwork Infrastructure as Code Library
In order to take advantage of the Terraform 0.13, you need to update your references to the Gruntwork Infrastructure as Code Library to use a compatible version. We (Gruntwork) have gone through all our modules in the library to test and update the code to be compatible with Terraform 0.13. As a customer, you need to update to the proper versions of the Gruntwork library to pick up the fixes/changes that were made to be compatible. Refer to the "Updating" section of "How to use the Gruntwork Infrastructure as Code Library" for instructions on how to update the versions in your code.
For the vast majority of the repos, the only change that will be necessary is a version number bump, but several repos
require more extensive code changes and state migrations. To upgrade without downtime and data loss, you MUST follow
the migration instructions in the release notes in each repo to know what changes need to be made to update to the new
version. The repo most affected by the 0.13 backward incompatibilities was terraform-aws-eks, so if you are an EKS
user, pay special attention to the release notes!
|
Important
|
Gruntwork follows semantic versioning. For any pre-1.0 modules, this means that version updates to the minor version are considered backwards incompatible releases for any version updates prior to 1.0.0 release. Make sure to read the release notes for the relevant modules any time you are updating minor versions! Note that you will want to read the release notes for each minor version that is updated (e.g., if you are going from v0.5.x to v0.9.x, you will want to read the notes for v0.6.0, v0.7.0, v0.8.0, and v0.9.0 to get the full list of backwards incompatible updates). |
The following table provides a summary of all the relevant Gruntwork AWS modules and the respective versions that are compatible with Terraform 0.13:
| Gruntwork Repo | Minimum version with Terraform 0.13 support |
|---|---|
Terratest |
|
Terragrunt |
|
package-terraform-utilities |
|
terraform-aws-vpc |
|
module-asg |
|
module-server |
|
package-lambda |
|
module-security |
|
module-load-balancer |
|
module-data-storage |
|
module-cache |
|
package-messaging |
|
package-static-assets |
|
terraform-aws-monitoring |
|
package-openvpn |
|
module-ecs |
|
module-ci |
|
terraform-aws-eks |
|
package-zookeeper |
|
package-kafka |
|
package-elk |
|
terraform-kubernetes-helm |
Deprecated. Migrate to |
terraform-kubernetes-namespace |
|
cis-compliance-aws |
|
package-sam |
|
terraform-aws-couchbase |
|
terraform-aws-influx |
|
terraform-aws-consul |
|
terraform-aws-vault |
|
terraform-aws-nomad |
Updating the Gruntwork Reference Architecture to Terraform 0.13
If you purchased the Gruntwork Reference Architecture, you will have a copy of the infrastructure-live and
infrastructure-modules repositories that contain the infrastructure code for deploying the Reference Architecture. You
will need to update the relevant code in infrastructure-modules to use a compatible version of the
Gruntwork Infrastructure as Code Library, as per the compatibility table above.
To help guide you through the upgrade process, we have updated the Acme Reference Architecture examples to support Terraform 0.13. You can refer to the pull requests to see an example of the updates you’lll need to do to make your Reference Architecture work with Terraform 0.13:
- Standard Reference Architecture
-
See the Release Notes for v0.0.1-20201218 tag in infrastructure-modules instructions on how to update the Reference Architecture for Terraform 0.13 compatibility. You can also view the infrastructure-modules PR and the infrastructure-live PR for an example of a Terraform 0.13 update.
- CIS Reference Architecture
-
See the infrastructure-modules PR and the infrastructure-live PR for an example of a Terraform 0.13 update for the CIS components of the Reference Architecture. For all other components, refer to PRs in the Standard Reference Architecture section above.
Comments