Workspaces and remote state in Terraform - Step-by-Step Execution

Process Flow - Workspaces and remote state

Start Terraform

↓

Select Workspace

↓

Load Remote State

↓

Apply Changes

↓

Update Remote State

↓

End

Terraform starts by selecting a workspace, loads the remote state for that workspace, applies changes, then updates the remote state.

Execution Sample

Terraform

terraform workspace new dev
terraform workspace select dev
terraform apply
terraform state pull

Create and select a workspace named 'dev', apply infrastructure changes, then pull the remote state.

Process Table

Step	Action	Workspace	State Loaded	Result
1	Create workspace 'dev'	dev	No (new workspace)	Workspace 'dev' created
2	Select workspace 'dev'	dev	No (just selected)	Workspace 'dev' selected
3	Load remote state	dev	Yes (empty or existing)	State loaded for 'dev'
4	Apply changes	dev	Yes	Infrastructure updated, state changed
5	Update remote state	dev	Yes	Remote state updated with new info
6	End	dev	Yes	Process complete

💡 Process stops after updating remote state and completing apply.

Status Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 4	After Step 5	Final
Workspace	default	dev	dev	dev	dev	dev	dev
State Loaded	No	No	No	Yes	Yes	Yes	Yes
Infrastructure	Initial	Initial	Initial	Initial	Updated	Updated	Updated

Key Moments - 3 Insights

Why does Terraform load a different state after selecting a workspace?

Each workspace has its own separate state file. Selecting a workspace changes which remote state Terraform loads, as shown in step 3 of the execution table.

What happens if you apply changes without selecting a workspace?

Terraform uses the default workspace and its state. This means changes apply to that environment, not to others like 'dev' or 'prod'. See step 2 where workspace selection matters.

How does remote state help when using multiple workspaces?

Remote state stores the current infrastructure info for each workspace separately. This keeps environments isolated and consistent, as shown by the state loaded and updated in steps 3 and 5.

Visual Quiz - 3 Questions

Look at the execution table, what is the workspace after step 2?

A dev

B default

C prod

D None

💡 Hint

Check the 'Workspace' column in row for step 2.

At which step does Terraform load the remote state for the workspace?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look for 'Load remote state' action in the execution table.

If you skip creating a new workspace and apply directly, what workspace is used?

A dev

B default

C prod

D No workspace

💡 Hint

Refer to variable_tracker 'Workspace' start value and key moments about default workspace.

Concept Snapshot

Terraform Workspaces:
- Separate environments with isolated state files
- Use 'terraform workspace new NAME' to create
- Use 'terraform workspace select NAME' to switch
Remote State:
- Stores current infra info remotely
- Keeps state consistent across users
- Each workspace has its own remote state

Full Transcript

Terraform uses workspaces to separate environments like development and production. Each workspace has its own remote state file stored remotely, which Terraform loads when you select that workspace. When you apply changes, Terraform updates the infrastructure and then updates the remote state for that workspace. This keeps environments isolated and consistent. The default workspace is used if no other is selected. Creating and selecting workspaces changes which remote state is loaded and updated.

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