mirror of
https://github.com/coder/coder.git
synced 2026-09-22 05:05:20 +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:
+5
-3
@@ -15,9 +15,11 @@ SUBCOMMANDS:
|
||||
|
||||
OPTIONS:
|
||||
--allow-workspace-renames bool, $CODER_ALLOW_WORKSPACE_RENAMES (default: false)
|
||||
DEPRECATED: Allow users to rename their workspaces. Use only for
|
||||
temporary compatibility reasons, this will be removed in a future
|
||||
release.
|
||||
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.
|
||||
|
||||
--cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir])
|
||||
The directory to cache temporary files. If unspecified and
|
||||
|
||||
+4
-2
@@ -575,8 +575,10 @@ userQuietHoursSchedule:
|
||||
# change their quiet hours schedule and the site default is always used.
|
||||
# (default: true, type: bool)
|
||||
allowCustomQuietHours: true
|
||||
# DEPRECATED: Allow users to rename their workspaces. Use only for temporary
|
||||
# compatibility reasons, this will be removed in a future release.
|
||||
# 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.
|
||||
# (default: false, type: bool)
|
||||
allowWorkspaceRenames: false
|
||||
# Configure how emails are sent.
|
||||
|
||||
Reference in New Issue
Block a user