From 5897c9590ceae12ebd7c621ef09e81c34a0b6fa7 Mon Sep 17 00:00:00 2001 From: Judith Malnick Date: Wed, 8 Dec 2021 09:45:18 -0800 Subject: [PATCH] Clarify background on unique names in TFC --- website/docs/cli/cloud/migrating.html.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/website/docs/cli/cloud/migrating.html.md b/website/docs/cli/cloud/migrating.html.md index 70da1b540..91b50c0bb 100644 --- a/website/docs/cli/cloud/migrating.html.md +++ b/website/docs/cli/cloud/migrating.html.md @@ -22,13 +22,14 @@ backend](/docs/language/settings/backends/index.html)), Terraform will ask your that state to Terraform Cloud. This process is interactive and self-documenting, and resembles moving between state backends. -You may also be prompted to rename your workspaces during the migration, to either give a name to +Terraform may also prompt you to rename your workspaces during the migration, to either give a name to the unnamed `default` workspace (Terraform Cloud requires all workspaces to have a name) or give -your workspace names more contextual information. Unlike typical Terraform workspaces representing -an environment associated with a particular configuration (e.g. production, staging, development), -Terraform Cloud workspaces are named uniquely across all configurations used within an organization. -Because of this, you'll be given an opportunity to rename the working directory's workspaces -according to a pattern relative to their existing names. A typical strategy to start with is +your workspace names more contextual information. Unlike Terraform CLI-only workspaces, which represent +multiple environments associated with the same configuration (e.g. production, staging, development), +Terraform Cloud workspaces can represent totally independent configurations, and must have unique names within the Terraform Cloud organization. + +Because of this, Terraform will prompt you to rename the working directory's workspaces +according to a pattern relative to their existing names, which can indicate the fact that these specific workspaces share configuration. A typical strategy to start with is `--` (e.g. `networking-prod-us-east`, `networking-staging-us-east`). For more information on workspace naming, see [Workspace Naming](/docs/cloud/workspaces/naming.html) in the Terraform Cloud documentation.