Deprecation Notice

This module has been deprecated. We have re-worked some of the core concepts and recommend using workspace-orchestrator instead.

Note: This module is in alpha state and is likely to contain bugs and updates may introduce breaking changes. It is not recommended for production use at this time.

Terraform Cloud Workspace

This module configures your Terraform organization and workspace.
Authors: David Wright (dwright@hashicorp.com) and Tony Vattahil (tonynv@amazon.com)

Install Terraform

To deploy this module, do the following: Install Terraform. (See Install Terraform for a tutorial.)

Sign up for Terraform Cloud

Sign up and log into Terraform Cloud. (There is a free tier available.)

Configure Terraform Cloud API Access

Generate terraform cloud token

terraform login

Export TERRAFORM_CONFIG Variable

export TERRAFORM_CONFIG="$HOME/.terraform.d/credentials.tfrc.json"

Configure your tfvars file

Example tfvars file (replace *** with AKEY and SKEY)

AWS_SECRET_ACCESS_KEY = "*****************"

AWS_ACCESS_KEY_ID = "*****************"

AWS_SESSION_TOKEN = "*****************"

Note: STS-based credentials are optional but highly recommended.

!!!!CAUTION!!!!: Make sure your credential are secured ourside version control (and follow secrets mangement bestpractices)

Deploy this module (instruction for linux or mac)

Clone the aws-ia/terraform-hashicorp-cloud_workspace repository.

git clone https://github.com/aws-ia/terraform-hashicorp-cloud_workspace

Change directory to the root directory.

cd terraform-hashicorp-cloud_workspace

Change to setup_workspace directory

cd setup_workspace.

Run to following commands in order:

terraform init

terraform apply or terraform apply -var-file="$HOME/.aws/terraform.tfvars".

Change directory to deploy dir (previous command auto generates backend.hcl)

cd ../deploy

View you backend file

cat backend.hcl

Terraform apply run remotely in Terraform Cloud (out will also stream to local env)

How to use this module to setup the deploy example for your module (instruction for linux or mac)

Clone the aws-ia/terraform-hashicorp-cloud_workspace repository.

git clone https://github.com/aws-ia/terraform-hashicorp-cloud_workspace.git

Copy terraform-hashicorp-cloud_workspace/setup_workspace folder to the root of your module

eg: cp terraform-hashicorp-cloud_workspace/setup_workspace /path/to/your/module

Create deploy folder in the root of your module.

eg: mkdir /path/to/your/module/deploy

Change to setup_workspace directory

cd /path/to/your/module/setup_workspace

Run to following commands in order:

terraform init

terraform apply or terraform apply -var-file="$HOME/.aws/terraform.tfvars"

This command generates a backend.hcl

cd ../deploy

You will see a backend.hcl for newly created workspace