mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
chore: undeprecate the workspace rename flag and clarify potential issues (#21669)
This undeprecates the `allow-workspace-renames` flag. IIUC, the 'danger' with using this flag is that the workspace name might have been used in the definition of some other terraform resources within template code, so a rename could cause problems such as with persistent disks. for https://github.com/coder/coder/issues/21628 --------- Signed-off-by: Callum Styan <callumstyan@gmail.com>
This commit is contained in:
+10
-7
@@ -3095,13 +3095,16 @@ Write out the current server config as YAML to stdout.`,
|
||||
YAML: "webTerminalRenderer",
|
||||
},
|
||||
{
|
||||
Name: "Allow Workspace Renames",
|
||||
Description: "DEPRECATED: Allow users to rename their workspaces. Use only for temporary compatibility reasons, this will be removed in a future release.",
|
||||
Flag: "allow-workspace-renames",
|
||||
Env: "CODER_ALLOW_WORKSPACE_RENAMES",
|
||||
Default: "false",
|
||||
Value: &c.AllowWorkspaceRenames,
|
||||
YAML: "allowWorkspaceRenames",
|
||||
Name: "Allow Workspace Renames",
|
||||
Description: "Allow users to rename their workspaces. " +
|
||||
"WARNING: Renaming a workspace can cause Terraform resources that depend on the " +
|
||||
"workspace name to be destroyed and recreated, potentially causing data loss. " +
|
||||
"Only enable this if your templates do not use workspace names in resource identifiers, or if you understand the risks.",
|
||||
Flag: "allow-workspace-renames",
|
||||
Env: "CODER_ALLOW_WORKSPACE_RENAMES",
|
||||
Default: "false",
|
||||
Value: &c.AllowWorkspaceRenames,
|
||||
YAML: "allowWorkspaceRenames",
|
||||
},
|
||||
// Healthcheck Options
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user