Skip to content

chore(docs): remove max_ttl docs #13077

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 2 commits into from
Apr 25, 2024
Merged

chore(docs): remove max_ttl docs #13077

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26a028d
removed MAX_TTL docs, updated template-level scheduling controls
stirby Apr 25, 2024
58edf01
fmt
stirby Apr 25, 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
19 changes: 12 additions & 7 deletions docs/templates/schedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,15 @@ You can also manage the lifecycle of failed or inactive workspaces.

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.
- [**Default autostop**](../workspaces.md#autostart-and-autostop): How long a
workspace runs without user activity before Coder automatically stops it.
- [**Autostop requirement**](../workspaces.md#autostop-requirement-enterprise):
Enforce mandatory workspace restarts to apply template updates regardless of
user activity.
- **Activity bump**: The duration of inactivity that must pass before a worksace
is automatically stopped.
- **Dormancy**: This allows automatic deletion of unused workspaces to reduce
spend on idle resources.

## Allow users scheduling

Expand All @@ -21,13 +26,13 @@ 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 (enterprise)

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 (enterprise)

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
Expand All @@ -37,7 +42,7 @@ 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 (enterprise)

Dormancy Auto-Deletion allows a template admin to dictate how long a workspace
is permitted to remain dormant before it is automatically deleted. Dormancy
Expand Down
12 changes: 0 additions & 12 deletions docs/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,18 +74,6 @@ coder_app.

![Autostop UI](./images/autostop.png)

### 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
Expand Down