Skip to content

Commit 6267964

Browse files
stirbymatifali
stirby
authored and
matifali
committed
in flight admin-workspace changes
1 parent 9b55009 commit 6267964

File tree

3 files changed

+42
-30
lines changed

3 files changed

+42
-30
lines changed

‎docs/admin/workspaces/README.md

+39-7
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ auditing.md
1212

1313
Coder manages Workspaces, which are user-facing virtualized development environments. Each workspace is defined by a [template](../templates/README.md), owned by a single user, and can be individually modified with parameters and scheduling.
1414

15-
Coder allows workpsaces to be hosted on either VMs or containers, and is unopionated on which compute you choose to maximize flexibility.
15+
Coder allows workspaces to be hosted on either VMs or containers and is not opinionated on which compute you choose to maximize flexibility.
1616

1717
![Example workspace view](../../images/user-guides/workspace-list-ui.png)
1818

@@ -38,17 +38,49 @@ The following filters are supported:
3838
[WorkspaceStatus documentation](https://pkg.go.dev/github.com/coder/coder/codersdk#WorkspaceStatus).
3939

4040

41-
## Updating workspaces
41+
## Updating
4242

43-
### Bulk updates
43+
After updating the default version of the template that a workspace was created
44+
from, you can update the workspace.
4445

45-
### Workspace update policies
46+
<!-- TODO: Update screenshot -->
4647

47-
## Multiple workspace agents
48+
![Updating a workspace](../../images/workspace-update.png)
4849

49-
## Workspace scheduling
50+
If the workspace is running, Coder stops it, updates it, then starts the workspace again.
5051

52+
### Updating via the CLI
5153

54+
Update a workspace through the command line:
5255

53-
TODO: Write index
56+
```shell
57+
coder update <workspace-name>
58+
```
59+
### Automatic updates
5460

61+
It can be tedious to manually update a workspace every time an update is pushed
62+
to a template. Users can choose to opt-in to automatic updates to update to the
63+
active template version whenever the workspace is started.
64+
65+
Note: If a template is updated such that new parameter inputs are required from
66+
the user, autostart will be disabled for the workspace until the user has
67+
manually updated the workspace.
68+
69+
![Automatic Updates](../../images/workspace-automatic-updates.png)
70+
71+
### Update policies
72+
73+
Template admins can require workspaces be on the latest version before starting. When this is enabled, you will be presented with an "Update and Start" button in the UI. Workspaces that start on connect will automatically update on the first out-of-date connection.
74+
75+
76+
<!-- TODO: Link force update policies -->
77+
78+
## Bulk operations (enterprise)
79+
80+
Enterprise admins may apply bulk operations (update, delete, start, stop) in the **Workspaces** tab. Select the workspaces you'd like to modify with the checkboxes on the left, then use the top-right **Actions** dropdown to apply the operation.
81+
82+
The start and stop operations can only be applied to a set of workspaces which are all in the same state. For update and delete, the user will be prompted for confirmation before any action is taken.
83+
84+
![Bulk workspace actions](../../images/user-guides/workspace-bulk-actions.png)
85+
86+
<!-- TODO: Children or next steps -->

‎docs/admin/workspaces/lifecycle.md

Whitespace-only changes.

‎docs/user-guides/README.md

+3-23
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ coder show <workspace-name>
4848
After updating the default version of the template that a workspace was created
4949
from, you can update the workspace.
5050

51-
![Updating a workspace](../../images/workspace-update.png)
51+
<!-- TODO: Update screenshot -->
52+
53+
![Updating a workspace](../images/workspace-update.png)
5254

5355
If the workspace is running, Coder stops it, updates it, then starts the
5456
workspace again.
@@ -59,29 +61,7 @@ On the command line:
5961
coder update <workspace-name>
6062
```
6163

62-
### Automatic updates
63-
64-
It can be tedious to manually update a workspace everytime an update is pushed
65-
to a template. Users can choose to opt-in to automatic updates to update to the
66-
active template version whenever the workspace is started.
67-
68-
Note: If a template is updated such that new parameter inputs are required from
69-
the user, autostart will be disabled for the workspace until the user has
70-
manually updated the workspace.
71-
72-
![Automatic Updates](./images/workspace-automatic-updates.png)
73-
74-
### Update policies
75-
76-
Template admins can require workspaces be on the latest version before starting. When this is enabled, you will be presented with an "Update and Start" button in the UI. Workspaces that start on connect will automatically update on the first out-of-date connection.
77-
78-
## Bulk operations (enterprise)
79-
80-
Enterprise users may apply bulk operations (update, delete, start, stop) in the **Workspaces** tab.
81-
82-
Select the workspaces you'd like to modify with the checkboxes on the left, then use the top-right **Actions** dropdown to apply the operation.
8364

84-
![Bulk workspace actions](../images/user-guides/workspace-bulk-actions.png)
8565

8666
## Next steps
8767

0 commit comments

Comments
 (0)