Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Commit 455a63a

Browse files
authored
chore: update docs with autostart days of week and timezone (#1250)
1 parent a998335 commit 455a63a

File tree

12 files changed

+46
-7
lines changed

12 files changed

+46
-7
lines changed

admin/organizations/manage.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,32 @@ Provide a **name** and (optionally) a **description** for this organization. If
1313
you want this to become a **Default organization**, make sure to check the box
1414
for this.
1515

16+
You can control the
17+
[auto-start behaviour](../../workspaces/lifecycle.md#auto-start) for workspaces
18+
in this organization. You can configure:
19+
20+
- **Autostart Days of Week**: configures on which days of the week workspaces in
21+
the organization may automatically start. If you do not want workspaces to
22+
auto-start in the organization _at all_, you can simply deselect all weekdays
23+
here.
24+
- **Workspace Shutdown Behavior**: The number of hours a workspace may be idle
25+
before Coder stops it automatically to help free up resources.
26+
- **User-controlled workspace shutdown behavior**: Whether end-users can set the
27+
desired workspace shutdown behavior. If disabled, Coder uses the
28+
organization's default setting.
29+
1630
You can also control how Coder manages resources for workspaces in this
1731
organization. You can set the:
1832

1933
- **CPU Provisioning Rate**: sets the ratio of virtual CPUs to physical CPUs; if
2034
you set a higher ratio, you can schedule a larger number of workspaces per
2135
node, though it will also lead to greater CPU contention.
22-
- **Workspace Shutdown Behavior**: The number of hours a workspace may be idle
23-
before Coder stops it automatically to help free up resources.
24-
- **User-controlled workspace shutdown behavior**: Whether end-users can set the
25-
desired workspace shutdown behavior. If disabled, Coder uses the
26-
organization's default setting.
36+
- **Memory Provisioning Rate**: sets the ratio of requested versus maximum RAM
37+
allocated to workspaces. If you set a higher ratio, you can schedule a larger
38+
number of workspaces per node, though it will lead to greater memory
39+
contention. See
40+
[memory overprovisioning](../workspace-management/memory-overprovisioning.md)
41+
for more information.
2742

2843
Finally, you can set **Resource Quotas**. These are limits on the number of
2944
**CPUs** and **GPUs**, as well as the amount of **memory** and **disk space**

admin/workspace-management/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ Administrative users can modify a variety of workspace-related behaviors.
1717
- You can modify the [workspace shutdown behavior](shutdown.md) on a
1818
per-organization basis to optimize resource usage.
1919

20+
- You can configure the autostart days of week on a per-organization basis to
21+
minimize unnecessary resource consumption.
22+
2023
- You can [install multiple IDEs](installing-jetbrains.md) onto your image so
2124
that users have alternatives to the default option (VS Code).
2225

admin/workspace-management/memory-overprovisioning.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Coder allows you to set memory provisioning ratios for each of your
44
organizations. By changing this ratio, you can change the number of workspaces
55
that fit onto a single Kubernetes node.
66

7+
> **Note:** This may cause the Linux Kernel to terminate user workloads if there
8+
> is insufficient system memory available. You can read more about this topic
9+
> [here](https://www.kernel.org/doc/gorman/html/understand/understand016.html).
10+
711
## Step 1: Enabling memory provisioning
812

913
A site admin/manager must complete these steps:

assets/admin/create-an-org.png

1.27 KB
Loading

assets/admin/edit-an-org.png

-989 Bytes
Loading
-50.3 KB
Loading
-11.4 KB
Loading
-80.3 KB
Loading
58.8 KB
Loading

workspaces/autostart.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Your workspace must be:
1515
days)
1616
- Off (auto-start doesn't work when workspaces are _on_ to prevent the
1717
triggering of a rebuild while you're working)
18+
- The current day of week must be allowed for auto-start by your organization.
1819

1920
Coder may trigger auto-start up to 5 minutes before your scheduled time to
2021
ensure all queued workspaces are ready on time.
@@ -28,6 +29,12 @@ ensure all queued workspaces are ready on time.
2829

2930
![Set auto-start time](../assets/workspaces/set_autostart_time.png)
3031

32+
You can also set your local timezone. This ensures that your workspace will
33+
start at the correct time if you experience seasonal Daylight Savings Time
34+
(DST) changes.
35+
36+
![Set auto-start timezone](../assets/workspaces/set_autostart_timezone.png)
37+
3138
1. Select the workspaces for which you want to enable auto-start and save.
3239

3340
![Select workspaces to auto-start](../assets/workspaces/autostart_save_preferences.png)

0 commit comments

Comments
 (0)