Upgrade Terraform Enterprise

This topic describes how to upgrade Terraform Enterprise installations on non-Replicated runtimes. For information about upgrading Replicated deployments, refer to Upgrade Terraform Enterprise on Replicated.

Introduction

We recommend upgrading in a non-production environment first before upgrading the production instance of Terraform Enterprise.

Upgrade

Complete the following steps to upgrade Terraform Enterprise:

1. Back up your Terraform Enterprise data. Refer to Backup and restore for instructions.

2. Use the Terraform Enterprise CLI to stop any existing Terraform runs and prevent Terraform Enterprise from starting new operations. Refer to Gracefully stop work on a node for instructions.

3. If your deployment is configured to run multiple terraform-enterprise nodes, scale down to a single node. You can run multiple nodes when Terraform Enterprise is in active-active mode. Refer to Configure the operational mode for additional information.

4. If your deployment makes use of an autoscaling group to manage instances of Terraform Enterprise, disable any configured health checks that would trigger the autoscaling group to rotate Terraform Enterprise instances during an upgrade.

5. Stop the Terraform Enterprise application.

   Docker ComposeHelm ChartPodman

   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
   

   For installs that use Kubernetes YAML, use the following command:

   $ podman kube play --down <path_to_YAML_file>
   

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

   Docker ComposeHelm ChartPodman

   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-#>
   

   For installs that use Kubernetes YAML, update the kube.yaml with the appropriate image tag:

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

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

   Docker ComposeHelm ChartPodman

   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
   

   For installs that use Kubernetes YAML, use the following command:

   $ podman kube play <path_to_YAML_file>
   

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