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.

Sign up for GitHub

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

docs: add workspace cleanup docs #11146

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
bf605fc
chore: add workspace cleanup docs
sreya Jun 12, 2023
a4598e1
minor stuff
sreya Oct 11, 2023
687232e
make fmt
sreya Oct 11, 2023
b828f80
word
sreya Oct 11, 2023
c459284
pr comments
sreya Oct 18, 2023
2c5f86b
Merge branch 'main' into jon/wsactiondocs
sreya Oct 18, 2023
4016d6a
fmt
sreya Oct 18, 2023
eb0d2c9
Merge branch 'main' into jon/wsactiondocs
sreya Oct 18, 2023
5c24ed2
Merge branch 'main' into jon/wsactiondocs
sreya Dec 12, 2023
83badc3
fmt
sreya Dec 12, 2023
7ea832d
Merge branch 'main' into jon/wsactiondocs
sreya Dec 12, 2023
cf7de63
Merge branch 'main' into jon/wsactiondocs
matifali Jan 3, 2024
689e056
removed experimental warnings
stirby Jan 16, 2024
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
Prev Previous commit
Next Next commit
minor stuff
  • Loading branch information
@sreya
sreya committed Oct 11, 2023
commit a4598e197a58e4e41f2813479444344225cee5fd
5 changes: 5 additions & 0 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,11 @@
"description": "Audit commands in workspaces with exectrace",
"path": "./templates/process-logging.md",
"state": "enterprise"
},
{
"title": "Workspace Scheduling",
"description": "Set workspace scheduling policies",
"path": "./templates/schedule.md"
}
]
},
Expand Down
16 changes: 9 additions & 7 deletions docs/templates/schedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,28 @@ permitted to run without user activity before it is automatically stopped
as well as the maximum duration it may remain in a started state before
it is forcibly stopped.

### User scheduling
## User scheduling

For templates where a uniform autostop duration is not appropriate, admins
may allow users to define their own autostart and autostop schedules.

## Failure Cleanup (alpha)
## Failure Cleanup

Failure cleanup defines how long a workspace is permitted to remain in the
failed state prior to being automatically stopped.
failed state prior to being automatically stopped. Failure Cleanup is
an enterprise-only feature.

## Dormancy Threshold (alpha)
## Dormancy Threshold

Dormancy Threshold defines how long a workspace is allowed 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. Inactive workspaces are stopped
during their transition to the dormant state if they are detected to be running.
during their transition to the dormant state if they are detected to be running. Dormancy Threshold is an enterprise-only feature.

## Dormancy Auto-Deletion (alpha)

## 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.
workspace is permitted to remain dormant before it is automatically deleted. Dormancy Auto-Deletion is an enterprise-only feature.