Terraform Enterprise Flexible Deployment Options upgrade

Follow these steps to upgrade Terraform Enterprise.

1. We recommend upgrading a non-production environment before upgrading your production instance of Terraform Enterprise.

2. We recommend backing up your Terraform Enterprise data before upgrading. For best practices, refer to our recommended patterns for backing up and restoring your data.

3. Stop terraform runs by draining instance nodes.

4. For a multi-node setup, scale down to a single node.

5. Stop the Terraform Enterprise application.

   Docker ComposeHelm Chart

   For installs that use Docker Compose, use the following command:

   $ docker compose down
   

   For installs that use Helm charts, update the values.yaml file's replicaCount:

   replicaCount: 0
   

6. Pull the new Terraform Enterprise Flexible Deployment Options image for a specific release: images.releases.hashicorp.com/hashicorp/terraform-enterprise:vYYYYMM-#.

   Docker ComposeHelm Chart

   For installs that use Docker Compose, update the compose.yaml with the appropriate image tag:

     name: terraform-enterprise
     services:
       tfe:
         image: images.releases.hashicorp.com/hashicorp/terraform-enterprise:<vYYYYMM-#>
   

   For installs that use Helm charts, update the values.yaml with the appropriate image tag and replicaCount:

     replicaCount: 1
     image:
     repository: images.releases.hashicorp.com
     name: hashicorp/terraform-enterprise
     tag: <vYYYYMM-#>
   

7. Start the Terraform Enterprise application with the new image.

   Docker ComposeHelm Chart

   For installs that use Docker Compose, use the following command:

   $ docker compose up --detach
   

   For installs that use Helm charts, upgrade the helm release with the new values:

   $ helm -n <TFE_NAMESPACE> upgrade --values=<OVERRIDES_FILE> terraform-enterprise hashicorp/terraform-enterprise
   

8. Repeat the process for the production instance of Terraform Enterprise.