docs: add auto-start/stop (#4728)

* docs: add auto-start/stop

* feedback

Co-authored-by: Ben Potter <ben@coder.com>

Co-authored-by: Ben Potter <ben@coder.com>
This commit is contained in:
Eric Paulsen
2022-10-24 15:32:05 -04:00
committed by GitHub
parent a82f05a0a0
commit 54261b6e8b
4 changed files with 23 additions and 1 deletions

BIN
docs/images/auto-start.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 241 KiB

BIN
docs/images/auto-stop.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 123 KiB

BIN
docs/images/schedule.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

View File

@ -24,7 +24,7 @@ Coder [supports multiple IDEs](ides.md) for use with your workspaces.
Workspaces in Coder are started and stopped, often based on whether there was
any activity or if there was a [template
update](./templates.md#manage-templates) available.
update](./templates.md#start/stop) available.
Resources are often destroyed and re-created when a workspace is restarted,
though the exact behavior depends on the template's definitions. For more
@ -40,6 +40,28 @@ resources](./templates.md#persistent-vs-ephemeral-resources).
When a workspace is deleted, all of the workspace's resources are deleted.
## Workspace scheduling
By default, workspaces are manually turned on/off by the user. However, a schedule
can be defined on a per-workspace basis to automate the workspace start/stop.
![Scheduling UI](./images/schedule.png)
### Auto-start
The auto-start feature automates the workspace build at a user-specified time
and day(s) of the week. In addition, users can select their preferred timezone.
![Auto-start UI](./images/auto-start.png)
### Auto-stop
The auto-stop feature shuts off workspaces after given number of hours in the "on"
state. If Coder detects workspace connection activity, the auto-stop timer is bumped up
one hour. IDE, SSH, Port Forwarding, and coder_app activity trigger this bump.
![auto-stop UI](./images/auto-stop.png)
## Updating workspaces
Use the following command to update a workspace to the latest template version.