When workspaces are appropriate in Terraform - Mini Project: Build & Apply

Using Terraform Workspaces for Environment Management

📖 Scenario: You are managing infrastructure for a web application that needs separate environments for development and production. You want to keep the infrastructure code the same but deploy it differently for each environment without mixing resources.

🎯 Goal: Learn how to use Terraform workspaces to manage multiple environments with the same configuration code.

📋 What You'll Learn

Create a Terraform configuration with a resource

Initialize Terraform workspaces for dev and prod

Use workspace-specific variables

Deploy resources separately in each workspace

💡 Why This Matters

🌍 Real World

Many companies use Terraform workspaces to manage different environments like development, staging, and production without duplicating code.

💼 Career

Understanding workspaces is essential for cloud engineers and DevOps professionals to maintain clean, scalable infrastructure deployments.

1

Create a basic Terraform configuration

Create a Terraform configuration file named main.tf with a resource aws_s3_bucket named my_bucket and set the bucket name to my-app-bucket.

Terraform

# Your code here to create aws_s3_bucket resource with bucket name 'my-app-bucket'

Hint

Define the aws_s3_bucket resource with the exact bucket name my-app-bucket.

2

Add workspace-specific bucket name variable

Add a variable bucket_name in variables.tf and update the aws_s3_bucket.my_bucket resource to use var.bucket_name for the bucket name.

Terraform

terraform {
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.0"
    }
  }
  required_version = ">= 1.0"
}

provider "aws" {
  region = "us-east-1"
}

variable "bucket_name" {
  type = string
}

resource "aws_s3_bucket" "my_bucket" {
  bucket = var.bucket_name
}

# Your code here to add variable 'bucket_name' and update bucket name usage

Hint

Define a variable named bucket_name and use it in the bucket resource.

3

Create workspace-specific variable files

Create two variable files: dev.tfvars with bucket_name = "my-app-bucket-dev" and prod.tfvars with bucket_name = "my-app-bucket-prod".

Terraform

# Create dev.tfvars with bucket_name = "my-app-bucket-dev"
# Create prod.tfvars with bucket_name = "my-app-bucket-prod"

Hint

Create two files named dev.tfvars and prod.tfvars with the exact bucket names.

4

Initialize and use Terraform workspaces

Use Terraform CLI commands to create two workspaces named dev and prod. Then select the dev workspace and apply the configuration using dev.tfvars. Finally, select the prod workspace and apply the configuration using prod.tfvars.

Terraform

# Run terraform workspace new dev
# Run terraform workspace new prod
# Run terraform workspace select dev
# Run terraform apply -var-file=dev.tfvars
# Run terraform workspace select prod
# Run terraform apply -var-file=prod.tfvars

Hint

Use the exact Terraform CLI commands to create and switch workspaces and apply configurations with the correct variable files.

Practice

1. What is the main purpose of using terraform workspaces?

easy

A. To store Terraform modules

B. To write Terraform code faster

C. To manage multiple environments like development and production with one configuration

D. To increase the speed of Terraform apply

Solution

1. Step 1: Understand workspace purpose

   Workspaces allow you to keep separate states for different environments using the same Terraform code.

2. Step 2: Compare options

   Options A, B, and C do not relate to managing environments or state separation.

3. Final Answer:

   To manage multiple environments like development and production with one configuration -> Option C

4. Quick Check:

   Workspaces = separate environment states [OK]

Hint: Workspaces separate states for different environments [OK]

Common Mistakes:

• Thinking workspaces speed up Terraform runs
• Confusing workspaces with modules
• Believing workspaces store code

2. Which command correctly switches to a workspace named testing?

easy

A. terraform workspace select testing

B. terraform switch workspace testing

C. terraform workspace switch testing

D. terraform use workspace testing

Solution

1. Step 1: Recall correct workspace switch syntax

   The correct command to switch workspaces is terraform workspace select [name].

2. Step 2: Validate options

   Options A, B, and D use incorrect command syntax not recognized by Terraform.

3. Final Answer:

   terraform workspace select testing -> Option A

4. Quick Check:

   Switch workspace = terraform workspace select [name] [OK]

Hint: Use 'terraform workspace select <name>' to switch [OK]

Common Mistakes:

• Using 'switch' instead of 'select'
• Mixing command order
• Adding extra words like 'workspace' twice

3. Given the commands below, what will be the output of terraform workspace show after these steps?

terraform workspace new dev
terraform workspace select dev
terraform workspace new prod
terraform workspace select prod
terraform workspace show

medium

A. prod

B. dev

C. default

D. Error: workspace not found

Solution

1. Step 1: Follow workspace creation and switching

   First, 'dev' workspace is created and switched to. Then 'prod' workspace is created and switched to.

2. Step 2: Check current workspace

   After switching to 'prod', running 'terraform workspace show' outputs the current workspace name, which is 'prod'.

3. Final Answer:

   prod -> Option A

4. Quick Check:

   Last switched workspace = prod [OK]

Hint: Last 'terraform workspace select' sets current workspace [OK]

Common Mistakes:

• Assuming default workspace remains active
• Confusing creation with switching
• Expecting error without reason

4. You run terraform workspace select staging but get an error saying the workspace does not exist. What should you do to fix this?

medium

A. Rename the workspace to default

B. Run terraform init again

C. Delete the current workspace and try again

D. Run terraform workspace new staging to create it first

Solution

1. Step 1: Understand error cause

   The error means the workspace 'staging' does not exist yet in Terraform state.

2. Step 2: Create the missing workspace

   Use terraform workspace new staging to create it before switching.

3. Final Answer:

   Run terraform workspace new staging to create it first -> Option D

4. Quick Check:

   Workspace must exist before select [OK]

Hint: Create workspace before using it [OK]

Common Mistakes:

• Trying to switch without creating workspace
• Reinitializing Terraform unnecessarily
• Deleting workspaces without cause

5. You want to manage three environments: dev, test, and prod using one Terraform configuration. Which approach best uses workspaces to achieve this safely?

hard

A. Use one workspace and manually change resource names for each environment

B. Create separate workspaces named dev, test, prod and switch before applying changes

C. Create three separate Terraform configurations for each environment

D. Use workspaces only for prod and dev, but not test

Solution

1. Step 1: Identify workspace use for multiple environments

   Workspaces allow managing multiple environment states with one config by switching between them.

2. Step 2: Evaluate options for safety and simplicity

   Create separate workspaces named dev, test, prod and switch before applying changes uses separate workspaces for each environment, which is safe and clean. Use one workspace and manually change resource names for each environment risks conflicts. Create three separate Terraform configurations for each environment duplicates code. Use workspaces only for prod and dev, but not test is inconsistent.

3. Final Answer:

   Create separate workspaces named dev, test, prod and switch before applying changes -> Option B

4. Quick Check:

   Separate workspaces = safe multi-env management [OK]

Hint: Use one workspace per environment for safety [OK]

Common Mistakes:

• Mixing environments in one workspace
• Duplicating configs unnecessarily
• Ignoring test environment