Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 14, 2025
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b5c8c4
missing or incompat. params
EdwardAngert Jul 9, 2025
927ac14
Update docs/admin/templates/extending-templates/parameters.md
EdwardAngert Jul 10, 2025
b729da2
Merge branch 'main' into 18370-immutable-params
EdwardAngert Jul 10, 2025
f4a91ad
Merge branch 'main' into 18370-immutable-params
EdwardAngert Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/admin/templates/extending-templates/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it might make sense to add something like this to the Required and optional parameters section above this one

parameters, the **Create workspace** button is disabled until the issues are resolved.

## Ephemeral parameters

Expand Down
Loading