From 341114a020148bcaf82c0031a3164e69070e3725 Mon Sep 17 00:00:00 2001 From: Stephen Kirby <58410745+stirby@users.noreply.github.com> Date: Thu, 25 Apr 2024 16:13:42 -0500 Subject: [PATCH] chore(docs): remove max_ttl docs (#13077) * removed MAX_TTL docs, updated template-level scheduling controls * fmt --- docs/templates/schedule.md | 19 ++++++++++++------- docs/workspaces.md | 12 ------------ 2 files changed, 12 insertions(+), 19 deletions(-) diff --git a/docs/templates/schedule.md b/docs/templates/schedule.md index e355d4ca27..d03c850004 100644 --- a/docs/templates/schedule.md +++ b/docs/templates/schedule.md @@ -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 @@ -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 @@ -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 diff --git a/docs/workspaces.md b/docs/workspaces.md index 01f534fae7..52a1317a82 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -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