Why Workspaces and remote state in Terraform? - Purpose & Use Cases

The Big Idea

What if a simple switch could save your team from costly infrastructure mistakes?

The Scenario

Imagine you are managing infrastructure for multiple environments like development, testing, and production all by yourself. You keep separate files on your computer for each environment and update them manually every time you make a change.

The Problem

This manual method is slow and risky. You might accidentally overwrite the wrong environment's settings or lose track of what changes were made where. Sharing these files with your team becomes confusing, and coordinating updates is a headache.

The Solution

Workspaces and remote state in Terraform solve this by keeping each environment's data separate and stored safely in the cloud. This way, everyone on the team can see the current state, avoid conflicts, and manage infrastructure changes smoothly without stepping on each other's toes.

Before vs After

✗ Before

terraform apply -var-file=dev.tfvars
terraform apply -var-file=prod.tfvars

✓ After

terraform workspace select dev
terraform apply
terraform workspace select prod
terraform apply

What It Enables

It enables safe, organized, and collaborative infrastructure management across multiple environments without confusion or errors.

Real Life Example

A team managing a website uses workspaces to separate development and production servers. Developers can test changes safely in the dev workspace, while the live site remains stable in production.

Key Takeaways

Manual environment management is error-prone and hard to track.

Workspaces keep environment states separate and organized.

Remote state sharing enables team collaboration and safety.

Practice

1. What is the main purpose of Terraform workspaces?

easy

A. To store Terraform state files locally on your computer

B. To manage multiple versions of infrastructure in the same configuration

C. To write Terraform code faster using templates

D. To automatically fix errors in Terraform code

Solution

1. Step 1: Understand what workspaces do

   Workspaces allow you to keep separate state files for the same Terraform configuration, so you can manage different environments or versions.

2. Step 2: Compare options

   Only To manage multiple versions of infrastructure in the same configuration correctly describes this purpose. Options B, C, and D describe unrelated features.

3. Final Answer:

   To manage multiple versions of infrastructure in the same configuration -> Option B

4. Quick Check:

   Workspaces = multiple infrastructure versions [OK]

Hint: Workspaces separate states for different environments [OK]

Common Mistakes:

• Confusing workspaces with local state storage
• Thinking workspaces speed up code writing
• Believing workspaces fix code errors automatically

2. Which command correctly switches to a Terraform workspace named prod?

easy

A. terraform workspace select prod

B. terraform switch workspace prod

C. terraform change workspace prod

D. terraform use workspace prod

Solution

1. Step 1: Recall the correct command syntax

   The correct command to switch workspaces is terraform workspace select <name>.

2. Step 2: Verify options

   Only terraform workspace select prod uses the correct command and syntax. Options B, C, and D are invalid commands.

3. Final Answer:

   terraform workspace select prod -> Option A

4. Quick Check:

   Switch workspace = terraform workspace select [OK]

Hint: Use 'terraform workspace select' to switch workspaces [OK]

Common Mistakes:

• Using 'terraform switch' instead of 'workspace select'
• Confusing workspace commands with other Terraform commands
• Omitting the 'workspace' keyword

3. Given this Terraform backend configuration snippet:

terraform {
  backend "s3" {
    bucket = "my-terraform-state"
    key    = "envs/${terraform.workspace}/terraform.tfstate"
    region = "us-east-1"
  }
}

What happens when you run terraform workspace select dev and then terraform apply?

medium

A. Terraform stores state in S3 under key 'envs/dev/terraform.tfstate'

B. Terraform stores state in S3 under key 'envs/prod/terraform.tfstate'

C. Terraform throws an error because workspace names cannot be used in backend keys

D. Terraform stores state locally instead of S3

Solution

1. Step 1: Understand backend key interpolation

   The backend key uses ${terraform.workspace} to dynamically set the state file path based on the current workspace.

2. Step 2: Apply workspace selection effect

   After selecting workspace 'dev', the key becomes 'envs/dev/terraform.tfstate', so state is stored there in S3.

3. Final Answer:

   Terraform stores state in S3 under key 'envs/dev/terraform.tfstate' -> Option A

4. Quick Check:

   Workspace name in backend key = state path [OK]

Hint: Workspace name replaces ${terraform.workspace} in backend key [OK]

Common Mistakes:

• Assuming state always stored under 'prod' key
• Thinking workspace names can't be used in backend keys
• Believing state is stored locally despite backend config

4. You run terraform init after changing the backend configuration, but get this error:
Error: Backend reinitialization required
What is the most likely cause?

medium

A. You did not run terraform init after changing backend settings

B. You have multiple state files in the same workspace

C. You switched workspaces without updating the backend

D. You changed the backend configuration but did not confirm reinitialization

Solution

1. Step 1: Understand backend reinitialization

   Changing backend settings requires Terraform to reinitialize and confirm the changes to avoid state corruption.

2. Step 2: Identify cause of error

   The error means Terraform detected backend changes but you did not confirm reinitialization during terraform init.

3. Final Answer:

   You changed the backend configuration but did not confirm reinitialization -> Option D

4. Quick Check:

   Backend change needs confirmed reinit [OK]

Hint: Confirm backend reinit after config changes with terraform init [OK]

Common Mistakes:

• Ignoring the prompt to confirm backend reinitialization
• Confusing workspace switch with backend reinit
• Assuming multiple state files cause this error

5. You want to manage separate infrastructure for dev and prod using the same Terraform code and remote backend. Which setup is best practice?

hard

A. Use one workspace and manually rename state files in the backend

B. Create two separate Terraform configurations with different backend buckets

C. Use Terraform workspaces with backend key including ${terraform.workspace} to separate state files

D. Store all state files locally and switch workspace manually

Solution

1. Step 1: Understand workspace and backend usage

   Workspaces let you use one configuration for multiple environments by separating state files using workspace names.

2. Step 2: Evaluate options for best practice

   Use Terraform workspaces with backend key including ${terraform.workspace} to separate state files uses workspaces and dynamic backend keys to keep states separate and managed centrally, which is best practice.

3. Step 3: Reject other options

   Create two separate Terraform configurations with different backend buckets duplicates code and backend unnecessarily. Use one workspace and manually rename state files in the backend risks state conflicts. Store all state files locally and switch workspace manually loses benefits of remote state.

4. Final Answer:

   Use Terraform workspaces with backend key including ${terraform.workspace} to separate state files -> Option C

5. Quick Check:

   Workspaces + dynamic backend key = best practice [OK]

Hint: Use workspaces with backend key for separate environment states [OK]

Common Mistakes:

• Duplicating configs instead of using workspaces
• Manually renaming state files causing errors
• Storing state locally losing collaboration benefits