Workspace naming conventions in Terraform - Step-by-Step Execution

Process Flow - Workspace naming conventions

Start: Need to create workspace

↓

Choose naming pattern

↓

Apply naming rules

↓

Create workspace with name

↓

Use workspace in terraform commands

↓

Manage infrastructure per workspace

↓

End

This flow shows how to pick and apply a naming pattern to create and use Terraform workspaces consistently.

Execution Sample

Terraform

terraform workspace new dev-us-east-1
terraform workspace select dev-us-east-1
terraform apply

Create and select a workspace named 'dev-us-east-1' following naming conventions, then apply infrastructure changes.

Process Table

Step	Action	Workspace Name	Naming Rule Applied	Result
1	Create workspace	dev-us-east-1	env-region format	Workspace 'dev-us-east-1' created
2	Select workspace	dev-us-east-1	matches existing workspace	Workspace 'dev-us-east-1' selected
3	Apply terraform	dev-us-east-1	workspace used for state isolation	Infrastructure applied in 'dev-us-east-1' workspace
4	Create workspace	prod-eu-west-2	env-region format	Workspace 'prod-eu-west-2' created
5	Select workspace	prod-eu-west-2	matches existing workspace	Workspace 'prod-eu-west-2' selected
6	Apply terraform	prod-eu-west-2	workspace used for state isolation	Infrastructure applied in 'prod-eu-west-2' workspace
7	Attempt create workspace	default	reserved name	Error: invalid workspace name
8	Attempt create workspace	test	too generic, no region	Warning: naming convention not followed
9	End	-	-	Workspaces created and used following naming conventions

💡 Execution stops after creating and using valid workspaces and showing errors for invalid names.

Status Tracker

Variable	Start	After Step 1	After Step 4	After Step 7	Final
workspace_name	-	dev-us-east-1	prod-eu-west-2	default (invalid)	-

Key Moments - 3 Insights

Why can't I use the name 'default' for a workspace?

'default' is a reserved name in Terraform. Step 7 shows an error when trying to create it.

What happens if I use a generic name like 'test'?

Step 8 shows a warning because 'test' does not follow the recommended env-region pattern, which helps organize workspaces clearly.

Why do we include region in the workspace name?

Including region (like 'us-east-1') helps separate infrastructure states by location, as seen in steps 1 and 4.

Visual Quiz - 3 Questions

Look at the execution table, what workspace name was successfully created in step 4?

A Dev_US_East_1

B dev-us-east-1

C prod-eu-west-2

D test

💡 Hint

Check the 'Workspace Name' column in row for step 4.

At which step does Terraform reject a workspace name?

A Step 7

B Step 4

C Step 1

D Step 8

💡 Hint

Look for the row with 'Error: invalid workspace name' in the 'Result' column.

If you omit the region in the workspace name, what is the likely outcome according to the table?

A Workspace creation succeeds with no warnings

B Workspace creation succeeds but with a warning

C Workspace creation fails with error

D Terraform automatically adds the region

💡 Hint

See step 8 where 'test' workspace is created with a warning.

Concept Snapshot

Terraform workspace names should be lowercase, use hyphens, and follow env-region pattern.
Example: dev-us-east-1
This helps isolate infrastructure states by environment and region.
Invalid names cause errors; generic names cause warnings.
Use 'terraform workspace new <name>' to create and 'terraform workspace select <name>' to switch.

Full Transcript

This visual execution shows how Terraform workspace naming conventions work. We start by choosing a naming pattern that includes environment and region, like 'dev-us-east-1'. We create and select workspaces with these names. The execution table shows successful creation and selection of valid names, and errors or warnings when names don't follow rules. Variables track the workspace name changes. Key moments clarify why lowercase and hyphens are required, why including region matters, and why generic names cause warnings. The quiz tests understanding of these steps. The snapshot summarizes the naming rules and commands.