How-to upload a Terraform binary to a Terraform enterprise instance

Introduction

This guide provides instructions on how to add a custom Terraform binary to your Terraform Enterprise instance from a private web server.

Prerequisites

• Administrator privileges in your Terraform Enterprise instance.
• A custom Terraform binary packaged as a .zip file.
• The .zip file must be hosted on a web server accessible from the Terraform Enterprise instance.

Use Case

You may need to use a specific Terraform binary that is not publicly available due to network constraints, security policies, or custom workflow requirements. This procedure allows you to make that binary available for runs within your Terraform Enterprise environment.

Procedure

Follow these steps to configure Terraform Enterprise to use your custom Terraform binary.

1. Generate a SHA256 Checksum

Before adding the binary to Terraform Enterprise, you must generate its SHA256 checksum. Use the appropriate command for your operating system.

For Linux

Use the sha256sum command.

$ sha256sum file.zip

For macOS

Use the shasum command.

$ shasum -a 256 file.zip

For Windows (PowerShell)

Use the Get-FileHash command.

$ Get-FileHash file.zip -Algorithm SHA256

For Windows (Command Prompt)

Use the CertUtil command.

$ CertUtil -hashfile file.zip SHA256

2. Navigate to the Terraform Enterprise UI

Access the administration settings in your Terraform Enterprise instance. Navigate to the Add Terraform Version page at https://<TFE_HOSTNAME>/app/admin/terraform-versions/add, replacing <TFE_HOSTNAME> with your instance's hostname.

This page is only available to users with administrator privileges.

3. Add the New Terraform Version

Complete the form with the following details:

• Version: Enter the version number for your custom binary (e.g., 1.2.3-custom).
• Accessibility: Choose the status of this version (Enable this version, Deprecated, or Beta).
• URL: Enter the full URL where the .zip file can be retrieved.
• SHA256 Checksum: Paste the checksum you generated in step 1.

After filling out the fields, click Add terraform version to save the configuration.

Additional Information

• How to add a Terraform Version to Terraform Enterprise