Upgrading

This section explains how to upgrade Terraform Enterprise to a new version when deployed to the Replicated platform. If Terraform Enterprise is deployed to a non-Replicated runtime, such as Nomad or Kubernetes, refer to Upgrade Terraform Enterprise.

The upgrade process may affect Terraform Enterprise availability. Refer Availability During Upgrades for additional information.

Before Upgrade

We strongly recommend the following:

Create a backup copy of the storage prior to upgrading your instance. Backup and restore responsibility varies depending on your Terraform Enterprise operation mode.
Review the general Terraform Enterprise requirements, including credentials, hardware, operating system, data storage, and network.
Review the upgrade requirements and release notes for the specific Terraform Enterprise release.
Review the Upgrading Terraform Enterprise or Patching Terraform Enterprise Node Instances for your Terraform Enterprise active/active architecture.

Compatibility warning: The below process describes upgrading single-node external service deployments of Terraform Enterprise. If you want to upgrade multi-node Active/Active deployments, follow the Active/Active install guide and the Admin CLI guide.

Online

Replicated Console

From the installer dashboard (https://<TFE HOSTNAME>:8800/dashboard), click the "Check Now" button. Terraform recognizes the new version.
Click "View Update".
Review the release notes and then click "Install Update".

Replicated Command Line Interface

Connect to the Terraform Enterprise host machine using SSH.
Fetch the versions of Terraform Enterprise.
```
$ replicatedctl app-release ls --fetch
```
Upgrade to the latest version of Terraform Enterprise.
```
$ replicatedctl app-release apply
```
Alternatively, upgrade to a specific version of Terraform Enterprise.
```
$ replicatedctl app-release apply --sequence "504"
```

Airgapped

Replicated Console

Determine the update path where the installer will look for new .airgap packages. You can do this from the console settings of your instance (https://<TFE HOSTNAME>:8800/console/settings) in the field Update Path.
Download the new .airgap package onto the instance and put it into the Update Path location.
From the installer dashboard (https://<TFE HOSTNAME>:8800/dashboard) click the "Check Now" button. Terraform recognizes the new version.
Click "View Update".
Review the release notes and then click "Install Update".

Replicated Command Line Interface

Connect to the Terraform Enterprise host machine using SSH.

Print the AirgapPackagePath.

$ replicatedctl params export --template '{{.AirgapPackagePath}}'

On the Terraform Enterprise host machine, upload the desired airgap packages into the AirgapPackagePath.
Fetch the versions of Terraform Enterprise from the uploaded airgap packages.
```
$ replicatedctl app-release ls --fetch
```
List the available versions of airgap packages for the upgrade.
```
$ replicatedctl app-release ls
```
Upgrade to the latest version of the available airgap packages.
```
$ replicatedctl app-release apply
```
Alternatively, upgrade to a specific version, using one of the options listed in the output of the previous step.
```
$ replicatedctl app-release apply --sequence "504"
```