Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a1f4626

Browse files
docs: clarify workspace scheduling priority and autostop requirement behavior
- Add priority section to template schedule docs explaining how autostop requirements take precedence over user settings - Add note to user guide about autostop requirement overrides - Add FAQ section addressing common scheduling confusion - Include specific scenarios showing when requirements vs user settings apply Fixes confusion around when workspaces shut down when both template autostop requirements and user autostop settings are configured. Co-authored-by: matifali <[email protected]>
1 parent 118bf98 commit a1f4626

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

docs/admin/templates/managing-templates/schedule.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,25 @@ Autostop requirement is disabled when the template is using the deprecated max
9393
lifetime feature. Templates can choose to use a max lifetime or an autostop
9494
requirement during the deprecation period, but only one can be used at a time.
9595

96+
### Priority and interaction with user settings
97+
98+
When both template-level autostop requirements and user-configurable autostop are enabled:
99+
100+
- **Autostop requirement always takes precedence** - This sets the maximum deadline that cannot be extended by user settings
101+
- **User autostop settings act as minimums** - Users can set shorter autostop durations but cannot exceed the requirement
102+
- **The earliest deadline wins** - The system will use whichever shutdown time comes first
103+
104+
#### Example scenarios
105+
106+
**Scenario 1**: Template requires daily stops, user sets 7-day autostop
107+
- **Result**: Workspace stops daily during quiet hours (requirement takes precedence)
108+
109+
**Scenario 2**: Template requires weekly stops, user sets 2-day autostop
110+
- **Result**: Workspace stops after 2 days of inactivity (user setting is shorter)
111+
112+
**Scenario 3**: Template requires daily stops, user disables autostop
113+
- **Result**: Workspace still stops daily during quiet hours (requirement cannot be overridden)
114+
96115
## User quiet hours
97116

98117
> [!NOTE]

docs/user-guides/workspace-scheduling.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ workspace if you're still using it. It will wait for the user to become inactive
3939
before checking connections again (1 hour by default). Template admins can
4040
modify this duration with the **activity bump** template setting.
4141

42+
> [!NOTE]
43+
> If your template administrator has configured an "Autostop Requirement", your workspace may shut down more frequently than your configured autostop duration. The autostop requirement ensures compliance and template updates by enforcing mandatory shutdowns during your quiet hours, regardless of your personal autostop settings.
44+
4245
![Autostop UI](../images/workspaces/autostop.png)
4346

4447
## Activity detection
@@ -140,3 +143,21 @@ determines how long workspaces will remain in the dormant state before automatic
140143

141144
Licensed admins may also configure failure cleanup, which will automatically
142145
delete workspaces that remain in a `failed` state for too long.
146+
147+
## Frequently Asked Questions
148+
149+
**Q: Why did my workspace shut down even though I set a 7-day autostop?**
150+
151+
A: Your template likely has an autostop requirement (daily, weekly, etc.) that takes precedence over user settings. Autostop requirements are enforced by template administrators to ensure compliance and apply template updates. Check with your administrator about the template's scheduling policies.
152+
153+
**Q: Can I prevent the autostop requirement from shutting down my workspace?**
154+
155+
A: No, autostop requirements cannot be overridden by users as they are enforced for compliance and updates. However, you can configure your quiet hours to ensure shutdowns happen at convenient times for you in your timezone.
156+
157+
**Q: When exactly will my workspace shut down if there's an autostop requirement?**
158+
159+
A: Workspaces with autostop requirements will shut down at the start of your configured quiet hours on the days specified by the template (e.g., daily, weekly). This ensures shutdowns don't happen during your working hours.
160+
161+
**Q: What happens if I set a shorter autostop duration than the template requirement?**
162+
163+
A: Your workspace will shut down based on whichever deadline comes first. For example, if the template requires weekly stops but you set a 2-day autostop, your workspace will stop after 2 days of inactivity.

0 commit comments

Comments
 (0)