-
Notifications
You must be signed in to change notification settings - Fork 905
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
bf605fc
chore: add workspace cleanup docs
sreya a4598e1
minor stuff
sreya 687232e
make fmt
sreya b828f80
word
sreya c459284
pr comments
sreya 2c5f86b
Merge branch 'main' into jon/wsactiondocs
sreya 4016d6a
fmt
sreya eb0d2c9
Merge branch 'main' into jon/wsactiondocs
sreya 5c24ed2
Merge branch 'main' into jon/wsactiondocs
sreya 83badc3
fmt
sreya 7ea832d
Merge branch 'main' into jon/wsactiondocs
sreya cf7de63
Merge branch 'main' into jon/wsactiondocs
matifali 689e056
removed experimental warnings
stirby File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The 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 comment
The 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 comment
The 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.