- Notifications
You must be signed in to change notification settings - Fork1k
docs: add workspace cleanup docs#11146
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
bf605fc
a4598e1
687232e
b828f80
c459284
2c5f86b
4016d6a
eb0d2c9
5c24ed2
83badc3
7ea832d
cf7de63
689e056
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. @stirby could you update screenshot as it's no more alpha. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. @sreya we needed to update the screenshot to remove Alpha labels. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. We'd need to remove the tags in the product first since they're still there. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Workspace Scheduling | ||
You can configure a template to control how workspaces are started and stopped. | ||
You can also manage the lifecycle of failed or inactive workspaces. | ||
 | ||
## Schedule | ||
Template [admins](../admin/users.md) may define these default values: | ||
- **Default autostop**: How long a workspace runs without user activity before | ||
Coder automatically stops it. | ||
- **Max lifetime**: The maximum duration a workspace stays in a started state | ||
before Coder forcibly stops it. | ||
## Allow users scheduling | ||
For templates where a uniform autostop duration is not appropriate, admins may | ||
allow users to define their own autostart and autostop schedules. Admins can | ||
restrict the days of the week a workspace should automatically start to help | ||
manage infrastructure costs. | ||
## Failure cleanup | ||
Failure cleanup defines how long a workspace is permitted to remain in the | ||
failed state prior to being automatically stopped. Failure cleanup is an | ||
enterprise-only feature. | ||
## Dormancy threshold | ||
Dormancy Threshold defines how long Coder allows a workspace to remain inactive | ||
before being moved into a dormant state. A workspace's inactivity is determined | ||
by the time elapsed since a user last accessed the workspace. A workspace in the | ||
dormant state is not eligible for autostart and must be manually activated by | ||
the user before being accessible. Coder stops workspaces during their transition | ||
to the dormant state if they are detected to be running. Dormancy Threshold is | ||
an enterprise-only feature. | ||
## Dormancy auto-deletion | ||
Dormancy Auto-Deletion allows a template admin to dictate how long a workspace | ||
is permitted to remain dormant before it is automatically deleted. Dormancy | ||
Auto-Deletion is an enterprise-only feature. |