Skip to content

Commit 8fc6a76

Browse files
committed
docs: upcoming scheduling behavior
1 parent bbb0fab commit 8fc6a76

File tree

5 files changed

+29
-19
lines changed

5 files changed

+29
-19
lines changed
94.7 KB
Loading
237 KB
Loading
170 KB
Loading

docs/templates/index.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,18 @@ coder templates create <template-name>
6969
> [examples/](https://github.com/coder/coder/tree/main/examples/templates)
7070
> directory in the repo.
7171
72-
## Configure Max Workspace Autostop
72+
## Template policies (enterprise)
7373

74-
To control cost, specify a maximum time to live flag for a template in hours or
75-
minutes.
74+
By default, developers have unlimited workspace usage and can use any template version. Template policies allows you to:
7675

77-
```sh
78-
coder templates create my-template --default-ttl 4h
79-
```
76+
- Guarantee developers are using the most recent template version.
77+
- Auto-stop workspaces after 3 hours of inactivity.
78+
- Mandate stopping/restarting of workspaces, regardless of activity status.
79+
- Disable workspace auto-start.
80+
81+
Learn more about [workspace auto-stop](../workspaces.md#workspace-auto-stop)
82+
83+
<!-- TODO: Add the dashboard screenshots. We can remove the "most recent version" bullet point once we finish template version policies -->
8084

8185
## Customize templates
8286

docs/workspaces.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,33 @@ information, see [Resource Persistence](./templates/resource-persistence.md).
3737
3838
When a workspace is deleted, all of the workspace's resources are deleted.
3939

40-
## Workspace scheduling
40+
## Workspace auto-stop
4141

42-
By default, workspaces are manually turned on/off by the user. However, a schedule
43-
can be defined on a per-workspace basis to automate the workspace start/stop.
42+
In Coder, workspaces can auto-stop when the user is not actively using the workspace. By default, Coder recognizing the following actions as activity and will keep the workspace online:
4443

45-
![Scheduling UI](./images/schedule.png)
44+
- Open SSH connections (VS Code Extension, JetBrains Gateway, `coder ssh`)
45+
- Open tunnels (`coder port-forward`)
46+
- Open WebSockets (web terminal, [web IDEs](./ides/web-ides.md) such as code-server and JupyterLab)
4647

47-
### Autostart
48+
> [Custom activity](#TODO) can be registered via Coder's REST API, such as an ongoing data science pipeline.
4849
49-
The autostart feature automates the workspace build at a user-specified time
50-
and day(s) of the week. In addition, users can select their preferred timezone.
50+
<!-- TODO. Document this. We may want to move to a custom activity section. See coder/coder[#8064](https://github.com/coder/coder/issues/8064) and coder/coder#5629 -->
5151

52-
![Autostart UI](./images/autostart.png)
52+
Your workspace's auto-stop behavior can be seen in the dashboard. Template settings in Coder determine if users can alter their workspace schedules.
5353

54-
### Autostop
54+
![TODO: use real screenshot](./images/workspaces/stops-after-3-hours.png)
5555

56-
The autostop feature shuts off workspaces after given number of hours in the "on"
57-
state. If Coder detects workspace connection activity, the autostop timer is bumped up
58-
one hour. IDE, SSH, Port Forwarding, and coder_app activity trigger this bump.
56+
### Max workspace lifetime (enterprise)
5957

60-
![autostop UI](./images/autostop.png)
58+
Workspaces may also have a max lifetime, which enforces a stop or restart even if you are actively using your workspace.
59+
60+
![TODO: use real screenshot](./images/workspaces/approaching-stop.png)
61+
62+
To avoid interruptions, users can establish their "quiet hours", which are by default set from midnight to 4 AM, during which these actions occur. Users can also extend the deadline by up to 3 hours if they are in the middle of important work.
63+
64+
![TODO: use real screenshot](./images/workspaces/quiet-hours.png)
65+
66+
Admin controls around workspace auto-stop are an enterprise feature. [Learn more here](./admin/template)
6167

6268
## Updating workspaces
6369

0 commit comments

Comments
 (0)