Workspace naming conventions in Terraform - Mini Project: Build & Apply

Workspace Naming Conventions in Terraform

📖 Scenario: You are managing infrastructure using Terraform. To keep your environments organized, you want to create workspaces with clear and consistent names.Think of workspaces like folders for different projects or environments, such as development, testing, and production.

🎯 Goal: Create Terraform workspace names following a specific naming convention to separate environments clearly.

📋 What You'll Learn

Create a Terraform workspace list with exact names

Add a prefix variable for workspace names

Use a loop to generate full workspace names with the prefix

Output the final list of workspace names

💡 Why This Matters

🌍 Real World

Naming workspaces clearly helps teams avoid confusion and manage multiple environments safely.

💼 Career

Understanding workspace naming conventions is essential for infrastructure as code and collaboration in cloud engineering roles.

1

Create a list of workspace environment names

Create a Terraform variable called environments with the exact list of strings: ["dev", "test", "prod"].

Terraform

# Create a variable called environments with ["dev", "test", "prod"]
# Your code here

Hint

Use variable block with default set to the list.

2

Add a prefix variable for workspace names

Add a Terraform variable called prefix with the exact string value "teamA-".

Terraform

variable "environments" {
  type    = list(string)
  default = ["dev", "test", "prod"]
}

# Add a variable called prefix with value "teamA-"
# Your code here

Hint

Use a variable block with default set to "teamA-".

3

Generate full workspace names with prefix

Create a Terraform local variable called workspace_names that uses a for expression to combine var.prefix and each item in var.environments into a list of full workspace names.

Terraform

variable "environments" {
  type    = list(string)
  default = ["dev", "test", "prod"]
}

variable "prefix" {
  type    = string
  default = "teamA-"
}

# Create local.workspace_names combining prefix and environments
# Your code here

Hint

Use a for expression inside locals to concatenate strings.

4

Output the final list of workspace names

Create a Terraform output called workspaces that outputs the value of local.workspace_names.

Terraform

variable "environments" {
  type    = list(string)
  default = ["dev", "test", "prod"]
}

variable "prefix" {
  type    = string
  default = "teamA-"
}

locals {
  workspace_names = [for env in var.environments : "${var.prefix}${env}"]
}

# Create output workspaces with value local.workspace_names
# Your code here

Hint

Use an output block with value set to local.workspace_names.

Practice

1.

What is the main purpose of using workspace names in Terraform?

easy

A. To store Terraform code files

B. To organize different environments like development and production

C. To define cloud provider credentials

D. To create virtual machines automatically

Solution

1. Step 1: Understand workspace role

   Workspaces in Terraform separate different environments or states, like dev and prod.

2. Step 2: Match purpose to options

   Only To organize different environments like development and production describes organizing environments, which is the workspace's main use.

3. Final Answer:

   To organize different environments like development and production -> Option B

4. Quick Check:

   Workspace names = environment organization [OK]

Hint: Workspaces separate environments, not code or credentials [OK]

Common Mistakes:

• Confusing workspace with code storage
• Thinking workspace manages credentials
• Assuming workspace creates resources directly

2.

Which of the following workspace names follows best naming conventions in Terraform?

terraform workspace new ?

easy

A. staging-1

B. dev_environment

C. Prod-Env

D. TestEnv

Solution

1. Step 1: Review naming rules

   Best practice is lowercase letters, hyphens allowed, no underscores or uppercase.

2. Step 2: Check each option

   staging-1 uses lowercase and hyphen, fitting the rules. Others use uppercase or underscores.

3. Final Answer:

   staging-1 -> Option A

4. Quick Check:

   Lowercase + hyphen = staging-1 [OK]

Hint: Use lowercase and hyphens, avoid underscores and capitals [OK]

Common Mistakes:

• Using uppercase letters
• Using underscores instead of hyphens
• Including spaces or special characters

3.

What will happen if you run the command terraform workspace select prod-env but the workspace prod-env does not exist?

medium

A. Terraform shows an error saying workspace not found

B. Terraform deletes the current workspace

C. Terraform switches to the default workspace

D. Terraform creates a new workspace named prod-env automatically

Solution

1. Step 1: Understand workspace select behavior

   The select command switches to an existing workspace; it does not create one.

2. Step 2: Check command outcome

   If the workspace does not exist, Terraform returns an error message.

3. Final Answer:

   Terraform shows an error saying workspace not found -> Option A

4. Quick Check:

   Select non-existent workspace = error [OK]

Hint: Select only switches; create with 'terraform workspace new' [OK]

Common Mistakes:

• Assuming select creates workspace
• Thinking Terraform switches to default silently
• Believing workspace gets deleted

4.

Identify the error in this workspace creation command:

terraform workspace new Dev_Env

medium

A. Workspace names cannot contain uppercase letters

B. Workspace names must start with a number

C. Workspace names must be longer than 10 characters

D. Workspace names cannot contain underscores

Solution

1. Step 1: Check naming rules for characters

   Workspace names should use lowercase letters and hyphens; underscores are not recommended.

2. Step 2: Analyze the command

   The name 'Dev_Env' contains an underscore, which breaks the naming convention.

3. Final Answer:

   Workspace names cannot contain underscores -> Option D

4. Quick Check:

   Underscores disallowed in workspace names [OK]

Hint: Avoid underscores; use hyphens instead [OK]

Common Mistakes:

• Thinking uppercase letters are forbidden (they are discouraged but allowed)
• Believing names must start with numbers
• Assuming length restrictions apply

5.

You want to create workspaces for three environments: development, testing, and production. Which set of workspace names follows best practices for naming conventions?

hard

A. dev, test_env, production

B. development, testing, production

C. dev-01, test-01, prod-01

D. Dev, Test, Prod

Solution

1. Step 1: Review naming best practices

   Use lowercase letters, hyphens allowed, no underscores or uppercase letters.

2. Step 2: Evaluate each option

   dev-01, test-01, prod-01 uses lowercase and hyphens with numbers, fitting best practices. dev, test_env, production uses underscore, B is long but valid, D uses uppercase.

3. Step 3: Choose best consistent and clear naming

   dev-01, test-01, prod-01 is concise, consistent, and follows all rules.

4. Final Answer:

   dev-01, test-01, prod-01 -> Option C

5. Quick Check:

   Lowercase + hyphens + numbers = best practice [OK]

Hint: Use lowercase, hyphens, and numbers for clarity [OK]

Common Mistakes:

• Using uppercase letters
• Using underscores
• Choosing inconsistent naming styles