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
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 101 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

View File

@ -210,6 +210,23 @@
}
]
},
{
"title": "Administering templates",
"description": "Configuration settings for template admins",
"path": "./templates/configuration.md",
"children": [
{
"title": "General settings",
"description": "Configure name, display info, and update polices",
"path": "./templates/general-settings.md"
},
{
"title": "Permissions",
"description": "Configure who can access a template",
"path": "./templates/permissions.md"
}
]
},
{
"title": "Open in Coder",
"description": "Add an \"Open in Coder\" button to your repos",

6
docs/templates/configuration.md vendored Normal file
View File

@ -0,0 +1,6 @@
# Administering Templates
Templates offer a variety of configuration options to template admins.
<children>
</children>

40
docs/templates/general-settings.md vendored Normal file
View File

@ -0,0 +1,40 @@
# General Settings
![General Settings](../images/templates/general-settings.png)
## Display Info
Display Info allows admins to modify how templates are displayed to users. This
can be useful for showing a more user-friendly name in the UI along with a
relevant icon and description.
## Operations
### Cancel in-progress jobs
Canceling in-progress jobs allows users to cancel ongoing workspace builds.
While this can be helpful for cases where a build is unlikely to finish, it also
carries the risk of potentially corrupting your workspace. The setting is
disabled by default.
### Require automatic updates
> Requiring automatic updates is in an
> [experimental state](../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.
Admins can require all workspaces update to the latest active template version
when they're started. This can be used to enforce security patches or other
important changes are quickly applied to all workspaces. This setting is not
mandatory for template admins to ensure template iteration is still possible.
While this setting applies to both manual starts and
[autostarts](../workspaces.md), promoting a template version that requires
manual intervention by the user (such as mandatory new template parameters) will
result in autostart being disabled for all incompatible workspaces until a
manual update is performed by the user.
This setting is an enterprise-only feature.

19
docs/templates/permissions.md vendored Normal file
View File

@ -0,0 +1,19 @@
# Permissions
![Template Permissions](../images/templates/permissions.png)
Permissions allow you to control who can use and modify the template. Both
individual user and groups can be added to the access list for a template.
Members can be assigned either a `Use` role, granting use of the template to
create workspaces, or `Admin`, allowing a user or members of a group to control
all aspects of the template. This offers a way to elevate the privileges of
ordinary users for specific templates without granting them the site-wide role
of `Template Admin`.
By default the `Everyone` group is assigned to each template meaning any Coder
user can use the template to create a workspace. To prevent this, disable the
`Allow everyone to use the template` setting when creating a template.
![Create Template Permissions](../images/templates/create-template-permissions.png)
Permissions is an enterprise-only feature.

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