mirror of https://github.com/coder/coder.git
docs: add template autostop requirement docs (#11235)
* chore: template autostop requirement docs * fixup! chore: template autostop requirement docs * fixes from feedback. * fmt --------- Co-authored-by: Ben <me@bpmct.net>
This commit is contained in:
parent
30afe43f8a
commit
06f519d7f1
Binary file not shown.
After Width: | Height: | Size: 138 KiB |
|
@ -74,13 +74,71 @@ coder_app.
|
|||
|
||||
![Autostop UI](./images/autostop.png)
|
||||
|
||||
### Max lifetime (Enterprise)
|
||||
### Max lifetime (Deprecated, Enterprise)
|
||||
|
||||
Max lifetime is a template setting that determines the number of hours a
|
||||
workspace will run before Coder automatically stops it, regardless of any active
|
||||
connections. Use this setting to ensure that workspaces do not run in perpetuity
|
||||
when connections are left open inadvertently.
|
||||
|
||||
Max lifetime is deprecated in favor of template autostop requirements. Templates
|
||||
can choose to use a max lifetime or an autostop requirement during the
|
||||
deprecation period, but only one can be used at a time. Coder recommends using
|
||||
autostop requirements instead as they avoid restarts during work hours.
|
||||
|
||||
### Autostop requirement (Enterprise)
|
||||
|
||||
Autostop requirement is a template setting that determines how often workspaces
|
||||
using the template must automatically stop. Autostop requirement ignores any
|
||||
active connections, and ensures that workspaces do not run in perpetuity when
|
||||
connections are left open inadvertently.
|
||||
|
||||
Workspaces will apply the template autostop requirement on the given day in the
|
||||
user's timezone and specified quiet hours (see below). This ensures that
|
||||
workspaces will not be stopped during work hours.
|
||||
|
||||
The available options are "Days", which can be set to "Daily", "Saturday" or
|
||||
"Sunday", and "Weeks", which can be set to any number from 1 to 16.
|
||||
|
||||
"Days" governs which days of the week workspaces must stop. If you select
|
||||
"daily", workspaces must be automatically stopped every day at the start of the
|
||||
user's defined quiet hours. When using "Saturday" or "Sunday", workspaces will
|
||||
be automatically stopped on Saturday or Sunday in the user's timezone and quiet
|
||||
hours.
|
||||
|
||||
"Weeks" determines how many weeks between required stops. It cannot be changed
|
||||
from the default of 1 if you have selected "Daily" for "Days". When using a
|
||||
value greater than 1, workspaces will be automatically stopped every N weeks on
|
||||
the day specified by "Days" and the user's quiet hours. The autostop week is
|
||||
synchronized for all workspaces on the same template.
|
||||
|
||||
Autostop requirement is disabled when the template is using the deprecated max
|
||||
lifetime feature. Templates can choose to use a max lifetime or an autostop
|
||||
requirement during the deprecation period, but only one can be used at a time.
|
||||
|
||||
#### User quiet hours (Enterprise)
|
||||
|
||||
User quiet hours can be configured in the user's schedule settings page.
|
||||
Workspaces on templates with an autostop requirement will only be forcibly
|
||||
stopped due to the policy at the start of the user's quiet hours.
|
||||
|
||||
![User schedule settings](./images/user-quiet-hours.png)
|
||||
|
||||
Admins can define the default quiet hours for all users with the
|
||||
`--default-quiet-hours-schedule` flag or `CODER_DEFAULT_QUIET_HOURS_SCHEDULE`
|
||||
environment variable. The value should be a cron expression such as
|
||||
`CRON_TZ=America/Chicago 30 2 * * *` which would set the default quiet hours to
|
||||
2:30 AM in the America/Chicago timezone. The cron schedule can only have a
|
||||
minute and hour component. The default schedule is UTC 00:00. It is recommended
|
||||
to set the default quiet hours to a time when most users are not expected to be
|
||||
using Coder.
|
||||
|
||||
Admins can force users to use the default quiet hours with the
|
||||
[CODER_ALLOW_CUSTOM_QUIET_HOURS](./cli/server.md#allow-custom-quiet-hours)
|
||||
environment variable. Users will still be able to see the page, but will be
|
||||
unable to set a custom time or timezone. If users have already set a custom
|
||||
quiet hours schedule, it will be ignored and the default will be used instead.
|
||||
|
||||
### Automatic updates
|
||||
|
||||
> Automatic updates is part of an
|
||||
|
|
Loading…
Reference in New Issue