docs: add documentation for template update policies (#11145)

This commit is contained in:
Jon Ayers
2023-12-11 19:05:25 -06:00
committed by GitHub
parent 3ce7b2ebe6
commit 45c07317c0
9 changed files with 101 additions and 0 deletions
+19
View File
@@ -81,6 +81,25 @@ workspace will run before Coder automatically stops it, regardless of any active
connections. Use this setting to ensure that workspaces do not run in perpetuity
when connections are left open inadvertently.
### Automatic updates
> Automatic updates is part of an
> [experimental feature](../contributing/feature-stages.md#experimental-features)
> and the behavior is subject to change. Use
> [GitHub issues](https://github.com/coder/coder) to leave feedback. This
> experiment must be specifically enabled with the
> `--experiments="template_update_policies"` option on your coderd deployment.
It can be tedious to manually update a workspace everytime an update is pushed
to a template. Users can choose to opt-in to automatic updates to update to the
active template version whenever the workspace is started.
Note: If a template is updated such that new parameter inputs are required from
the user, autostart will be disabled for the workspace until the user has
manually updated the workspace.
![Automatic Updates](./images/workspace-automatic-updates.png)
## Updating workspaces
After updating the default version of the template that a workspace was created