Skip to content

Commit dc756d7

Browse files
sreyasreya
committed
docs: add documentation for template update policies
1 parent ace188b commit dc756d7

9 files changed

+87
-0
lines changed

‎docs/images/templates/create-template-permissions.png

47.8 KB
Loading

‎docs/images/templates/general-settings.png

114 KB
Loading

‎docs/images/templates/permissions.png

33.1 KB
Loading

‎docs/images/workspace-automatic-updates.png

39.3 KB
Loading

‎docs/manifest.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,23 @@
210210
}
211211
]
212212
},
213+
{
214+
"title": "Administering templates",
215+
"description": "Configuration settings for template admins",
216+
"path": "./templates/configuration.md",
217+
"children": [
218+
{
219+
"title": "General settings",
220+
"description": "Configure name, display info, and update polices",
221+
"path": "./templates/general-settings.md"
222+
},
223+
{
224+
"title": "Permissions",
225+
"description": "Configure who can access a template",
226+
"path": "./templates/permissions.md"
227+
}
228+
]
229+
},
213230
{
214231
"title": "Open in Coder",
215232
"description": "Add an \"Open in Coder\" button to your repos",

‎docs/templates/configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Administering Templates
2+
3+
Templates offer a variety of configuration options to template admins.
4+
5+
<children>
6+
</children>

‎docs/templates/general-settings.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# General Settings
2+
3+
![General Settings](../images/templates/general-settings.png)
4+
5+
## Display Info
6+
7+
Display Info allows admins to modify how templates are displayed to users. This
8+
can be useful for showing a more user-friendly name in the UI along with a
9+
relevant icon and description.
10+
11+
## Operations
12+
13+
### Cancel in-progress jobs
14+
15+
Canceling in-progress jobs allows users to cancel ongoing workspace builds.
16+
While this can be helpful for cases where a build is unlikely to finish, it also
17+
carries the risk of potentially corrupting your workspace. The setting is
18+
disabled by default.
19+
20+
### Require automatic updates
21+
22+
Admins can require all workspaces update to the latest active template version
23+
when they're started. This can be used to enforce security patches or other
24+
important changes are quickly applied to all workspaces. This setting is not
25+
mandatory for template admins to ensure template iteration is still possible.
26+
27+
While this setting applies to both manual starts and
28+
[autostarts](../workspaces.md), promoting a template version that requires
29+
manual intervention by the user (such as mandatory new template paremeters) will
30+
result in autostart being disabled for all incompatible workspaces until a
31+
manual update is performed by the user.
32+
33+
This setting is an enterprise-only feature.

‎docs/templates/permissions.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Permissions
2+
3+
![Template Permissions](../images/templates/permissions.png)
4+
5+
Permissions allow you to control who can use and modify the template. Both
6+
individual user and groups can be added to the access list for a template.
7+
Members can be assigned either a `Use` role, granting use of the template to
8+
create workspaces, or `Admin`, allowing a user or members of a group to control
9+
all aspects of the template. This offers a way to elevate the privileges of
10+
ordinary users for specific templates without granting them the site-wide role
11+
of `Template Admin`.
12+
13+
By default the `Everyone` group is assigned to each template meaning any Coder
14+
user can use the template to create a workspace. To prevent this, disable the
15+
`Allow everyone to use the template` setting when creating a template.
16+
17+
![Create Template Permissions](../images/templates/create-template-permissions.png)
18+
19+
Permissions is an enterprise-only feature.

‎docs/workspaces.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,18 @@ workspace will run before Coder automatically stops it, regardless of any active
8181
connections. Use this setting to ensure that workspaces do not run in perpetuity
8282
when connections are left open inadvertently.
8383

84+
### Automatic Updates
85+
86+
It can be tedious to manually update a workspace everytime an update is pushed
87+
to a template. Users can choose to opt-in to automatic updates to update to the
88+
active template version whenever the workspace is started.
89+
90+
Note: If a template is updated such that new parameter inputs are required from
91+
the user, autostart will be disabled for the workspace until the user has
92+
manually updated the workspace.
93+
94+
![Automatic Updates](./images/workspace-automatic-updates.png)
95+
8496
## Updating workspaces
8597

8698
After updating the default version of the template that a workspace was created

0 commit comments

Comments
 (0)