Terraform Cloud Remote Backend

Terrateam Configuration

Terrateam behavior can be configured via a config.yml. This file is located in a directory named .terrateam at the root of your Terraform repository: .terrateam/config.yml.

See Configuration documentation for details.

It’s possible to use Terraform Cloud as a remote backend to store and manage state files.

Terraform Cloud Token

Terrateam needs a Terraform Cloud user API token in order to authenticate against the Terraform Cloud remote backend.

1. Navigate to the Tokens section of the Terraform Cloud Console

2. Select Create an API token

3. Choose a Description and select Create API token

4. Save your token in a safe place as it will not be displayed again

Workspace Configuration

Terrateam can work with existing Terraform Cloud workspaces or a newly created workspace.

New Workspace Configuration

1. Select Workspaces in the Terraform Cloud Console

2. Select New workspace in the top right corner

3. Select CLI-driven workflow

4. Choose a workspace name and description and select Create workspace

5. Navigate to Settings

6. Set Execution Mode to Local and select Save settings

Existing Workspace Configuration

1. Select your existing workspace in the Terraform Cloud Console

2. Navigate to Settings

3. Set Execution Mode to Local and select Save settings

Granting Terrateam Access

1. Navigate to the main page of your Terraform repository on GitHub and select Settings

2. In the left sidebar, select Secrets → Actions

3. Select New repository secret

4. Populate the Name and Secret fields and select Add secret

• Name: TF_API_TOKEN
• Value: <Terraform-Cloud-API-Token>

Backend Provider Example

Basic configuration to start using Terraform Cloud as a remote backend:

terraform {
  backend "remote" {
    hostname = "app.terraform.io"
    organization = "<your-terraform-cloud-organization>"

    workspaces {
      name = "production"
    }
  }
}