mirror of
https://github.com/coder/coder.git
synced 2025-07-23 21:32:07 +00:00
docs: add documentation for template update policies (#10804)
Co-authored-by: Ben Potter <ben@coder.com>
This commit is contained in:
6
docs/templates/configuration.md
vendored
Normal file
6
docs/templates/configuration.md
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
# Administering Templates
|
||||
|
||||
Templates offer a variety of configuration options to template admins.
|
||||
|
||||
<children>
|
||||
</children>
|
33
docs/templates/general-settings.md
vendored
Normal file
33
docs/templates/general-settings.md
vendored
Normal file
@ -0,0 +1,33 @@
|
||||
# General Settings
|
||||
|
||||

|
||||
|
||||
## 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 (Enterprise)
|
||||
|
||||
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
19
docs/templates/permissions.md
vendored
Normal file
@ -0,0 +1,19 @@
|
||||
# Permissions (Enterprise)
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
Permissions is an enterprise-only feature.
|
Reference in New Issue
Block a user