- Notifications
You must be signed in to change notification settings - Fork926
docs: upcoming auto-stop behavior#8117
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -69,14 +69,37 @@ coder templates create <template-name> | ||
| > [examples/](https://github.com/coder/coder/tree/main/examples/templates) | ||
| > directory in the repo. | ||
| ##Template policies (enterprise) | ||
| By default, developers have unlimited workspace usage and can use any template version. Template policies allows you to: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Should add something about how developers have full control of their workspace schedules without policy. The policy is just the enforcement layer. It reads to me like the community edition doesn't have scheduling at all. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Yeah, I agree. I will rephrase There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Can't a developer use only the active version of a template? Only admins can create workspaces from any version. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. We plan on making the behavior configurable per-template. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. But restricting users to only use the active template is a good double-check if we do something likethis | ||
| - Auto-stop workspaces after 3 hours of inactivity. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. nit: these clauses shouldn't end with periods since they're not complete sentences | ||
| - Require workspaces to be restarted frequently to ensure they use the most recent template version. | ||
| - Disable workspace auto-start. | ||
| ### Stop policy | ||
| Stop policies require workspaces be stopped (or restarted), regardless of activity: | ||
| - Daily (Restart on next quiet hours) | ||
| - Weekly (Restart on weekends) | ||
| - Custom (Every 2 weeks) | ||
bpmct marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| ```text | ||
| Every [2] [Weeks] on [Friday] | ||
| or | ||
| Every [2] [Days] | ||
| or | ||
| Every [4] [Weeks] on [Saturday] | ||
| ``` | ||
| - Never | ||
| Stops occur during a user's [quiet hours](../workspaces.md#quiet-hours), which prevent interruptions. If a user is still using their workspace, they can postpone a restart up to 3 hours. | ||
bpmct marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| Learn more about [workspace auto-stop](../workspaces.md#workspace-auto-stop) | ||
| <!-- TODO: Add the dashboard screenshots. We can remove the "most recent version" bullet point once we finish template version policies --> | ||
| ## Customize templates | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -37,27 +37,50 @@ information, see [Resource Persistence](./templates/resource-persistence.md). | ||
| When a workspace is deleted, all of the workspace's resources are deleted. | ||
| ## Workspaceauto-stop | ||
| In Coder, workspaces can auto-stop when the user is not actively using the workspace. By default, Coder recognizes the following actions as activity and will keep the workspace online: | ||
| - Open SSH connections (VS Code Extension, JetBrains Gateway, `coder ssh`) | ||
| - Open tunnels (`coder port-forward`) | ||
| - Open WebSockets (web terminal, [web IDEs](./ides/web-ides.md) such as code-server and JupyterLab) | ||
| > [Custom activity](#TODO) can be registered via Coder's REST API, such as an ongoing data science pipeline. | ||
| <!-- TODO. Document this. We may want to move to a custom activity section. See coder/coder[#8064](https://github.com/coder/coder/issues/8064) and coder/coder#5629 --> | ||
| Your workspace's auto-stop behavior can be seen in the dashboard. Template settings in Coder determine if users can alter their workspace schedules. | ||
|  | ||
| ### Max workspace lifetime (enterprise) | ||
| Workspaces may also have a max lifetime, which enforces a stop or restart even if you are actively using your workspace. | ||
|  | ||
| #### Quiet hours | ||
| To avoid interruptions, users can establish their "quiet hours", which are by default set from midnight to 4 AM, during which these actions occur. Users can also extend the deadline by up to 3 hours if they are in the middle of important work. | ||
bpmct marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| Example: | ||
| ```text | ||
| Quiet hours: 12- 4:00 AM | ||
| 11:30AM: User is notified their workspace is about to stop | ||
| user bumps | ||
| user bumps | ||
| user bumps | ||
| 4 AM: workspace stops | ||
| ``` | ||
|  | ||
| <!-- NOTE: This will be in the "Account settings" page --> | ||
| Admin controls around workspace auto-stop are an enterprise feature. [Learn more here](./admin/template) | ||
| ## Updating workspaces | ||