opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add note about incompatible immutable parameters behavior to parameters doc (#18814)

Browse Source 
closes #18370 

workspace creation page checks for

1. required parameters
2. incompatible immutable parameters

and if there's an issue, disables the **Create workspace** button until
it's resolved


[preview](https://coder.com/docs/@18370-immutable-params/admin/templates/extending-templates/parameters#mutability)

---------

Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
Edward Angert
2025-07-14 11:43:43 +00:00
committed by GitHub
co-authored by EdwardAngert
parent 3126f21d87
commit 78af5e0f53
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin/templates/extending-templates/parameters.md
+4 -5
View File
@@ -207,8 +207,8 @@ data "coder_parameter" "dotfiles_url" {
Immutable parameters can only be set in these situations:
- Creating a workspace for the first time.
- Updating a workspace to a new template version. This sets the initial value
for required parameters.
- Updating a workspace to a new template version.
This sets the initial value for required parameters.
The idea is to prevent users from modifying fragile or persistent workspace
resources like volumes, regions, and so on.
@@ -224,9 +224,8 @@ data "coder_parameter" "region" {
}
```
You can modify a parameter's `mutable` attribute state anytime. In case of
emergency, you can temporarily allow for changing immutable parameters to fix an
operational issue, but it is not advised to overuse this opportunity.
If a required parameter is empty or if the workspace creation page detects an incompatibility between selected
parameters, the **Create workspace** button is disabled until the issues are resolved.
## Ephemeral parameters