How to add a Terraform Version to Terraform Enterprise

Introduction

This guide explains how to manually add a specific Terraform version to your Terraform Enterprise installation, making it available for selection in workspaces. This is useful when a required version is not yet available by default in your instance.

Prerequisites

• Administrative access to the Terraform Enterprise instance.

Procedure

You can add either an official HashiCorp-released version of Terraform or a custom-built version.

Option 1: Add an Official Terraform Version

1. Navigate to the Terraform Versions administration page in your browser: https://<TFE_HOSTNAME>/app/admin/terraform-versions/add
2. Complete the form with the following details:
   • Version: Enter the version number you are adding (e.g., 1.2.3).
   • Enable this version: Check this box to make the version immediately available.
   • Beta: Check this box only if it is a beta release.
   • URL: Provide the direct download link for the Linux amd64 binary. The URL follows this pattern, where you replace X.X.X with the target version number: https://releases.hashicorp.com/terraform/X.X.X/terraform_X.X.X_linux_amd64.zip
   • SHA256 Checksum: Provide the checksum to verify the binary's integrity. a. In a new browser tab, navigate to the SHA256SUMS file for your target version. The URL pattern is: https://releases.hashicorp.com/terraform/X.X.X/terraform_X.X.X_SHA256SUMS b. Open the downloaded terraform_X.X.X_SHA256SUMS file. c. Copy the 64-character checksum that corresponds to the terraform_X.X.X_linux_amd64.zip file.
3. Click Add terraform version to save the new version.

Option 2: Add a Custom Terraform Version

1. Navigate to the Terraform Versions administration page in your browser: https://<TFE_HOSTNAME>/app/admin/terraform-versions/add

2. Complete the form with the following details:

   • Version: Enter the version number for your custom build.
   • Enable this version: Check this box to make the version immediately available.
   • Beta: Check this box if appropriate for your custom build.
   • URL: Enter the URL where your custom Terraform .zip file is hosted.
   • SHA256 Checksum: Paste the checksum for your custom .zip file. You can generate this checksum using one of the following commands.

   On Linux:

   $ sha256sum /path/to/your/terraform.zip

   On macOS:

   $ shasum -a 256 /path/to/your/terraform.zip

   On Windows (PowerShell):

   $ Get-FileHash C:\path\to\your\terraform.zip -Algorithm SHA256

   On Windows (Command Prompt):

   $ CertUtil -hashfile C:\path\to\your\terraform.zip SHA256

3. Click Add terraform version to save the custom version.

Expected Outcome

After completing these steps, the newly added Terraform version will be available for selection in the settings of your Terraform Enterprise workspaces.

Additional Information

• For a list of official releases, see the Terraform Versions page on the HashiCorp Releases site.