synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): add example scenario for parameter updates (#9298)

Browse Source
This commit is contained in:
Cian Johnston
2023-08-24 10:35:20 +01:00
committed by GitHub
parent 52ea23355a
commit 970072f61d
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/templates/parameters.md vendored
View File

@ -118,6 +118,21 @@ It prevents workspace users from becoming trapped with outdated template
versions, ensuring they can smoothly update their workspace without any versions, ensuring they can smoothly update their workspace without any
hindrances. hindrances.
Example:
- Bob creates a workspace using the `python-dev` template. This template has a
parameter `image_tag`, and Bob selects `1.12`.
- Later, the template author Alice is notified of a critical vulnerability in a
package installed in the `python-dev` template, which affects the image tag
`1.12`.
- Alice remediates this vulnerability, and pushes an updated template version
that replaces option `1.12` with `1.13` for the `image_tag` parameter. She
then notifies all users of that template to update their workspace
immediately.
- Bob saves their work, and selects the `Update` option in the UI. As their
workspace uses the now-invalid option `1.12`, for the `image_tag` parameter,
they are prompted to select a new value for `image_tag`.
## Required and optional parameters ## Required and optional parameters
A parameter is considered to be _required_ if it doesn't have the `default` A parameter is considered to be _required_ if it doesn't have the `default`