Skip to content

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 13 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/template-scheduling.png
Copy link
Member

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.

Copy link
Member

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.

Copy link
Collaborator Author

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.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,11 @@
"title": "Permissions",
"description": "Configure who can access a template",
"path": "./templates/permissions.md"
},
{
"title": "Workspace Scheduling",
"description": "Configure when workspaces start, stop, and delete",
"path": "./templates/schedule.md"
}
]
},
Expand Down Expand Up @@ -256,6 +261,11 @@
"path": "./templates/process-logging.md",
"state": "enterprise"
},
{
"title": "Workspace Scheduling",
"description": "Set workspace scheduling policies",
"path": "./templates/schedule.md"
},
{
"title": "Icons",
"description": "Coder includes icons for popular cloud providers and programming languages for you to use",
Expand Down
44 changes: 44 additions & 0 deletions docs/templates/schedule.md
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 screen](../images/template-scheduling.png)

## 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.