Workspace naming conventions in Terraform - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a workspace in Terraform?

A workspace in Terraform is a separate instance of your infrastructure state. It allows you to manage multiple environments (like development, staging, production) using the same configuration but with isolated states.

beginner

Why use naming conventions for Terraform workspaces?

Naming conventions help keep workspaces organized and easy to identify. They reduce confusion, prevent mistakes like deploying to the wrong environment, and make collaboration smoother.

beginner

Give an example of a simple workspace naming convention.

A simple naming convention could be: environment-purpose. For example, dev-webapp for the development environment of a web application, or prod-db for the production database.

intermediate

What characters should you avoid in Terraform workspace names?

Avoid spaces, special characters, and uppercase letters. Use only lowercase letters, numbers, and hyphens (-) to keep names simple and compatible.

intermediate

How does consistent workspace naming improve team collaboration?

Consistent names make it easy for everyone to understand which environment they are working on. It reduces errors, speeds up onboarding, and helps automate scripts that depend on workspace names.

What is the main purpose of Terraform workspaces?

A To manage multiple isolated infrastructure states

B To store Terraform configuration files

C To run Terraform commands faster

D To create backups of infrastructure

Terraform workspaces allow you to manage multiple isolated states, such as different environments, using the same configuration.

Which of the following is a good workspace name?

A Prod-WebApp

B dev_webapp

C dev-webapp

D Dev WebApp

Use lowercase letters and hyphens only. 'dev-webapp' follows the best practice for workspace naming.

Why should you avoid spaces in workspace names?

A They are hard to remember

B They make names too long

C They slow down Terraform

D They cause errors in Terraform commands

Spaces can cause errors or require extra handling in command-line tools like Terraform.

What does a workspace name like 'staging-api' tell you?

A It is the production API environment

B It is the staging environment for the API

C It is a backup workspace

D It is a test workspace for the database

'staging-api' indicates the workspace is for the staging environment of the API service.

How does a naming convention help automation?

A By allowing scripts to identify environments easily

B By making workspace names unpredictable

C By hiding workspace names from users

D By increasing the number of workspaces

Consistent naming lets automation scripts detect and use the correct workspace without manual input.

Explain why using a clear workspace naming convention is important in Terraform.

Think about how names help you and your team avoid confusion.

Describe a simple and effective workspace naming convention you could use.

Combine environment and project with a dash.