Skip to content

chore: update docs with autostart days of week and timezone #1250

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 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 1 commit into from
Apr 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 20 additions & 5 deletions admin/organizations/manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,32 @@ Provide a **name** and (optionally) a **description** for this organization. If
you want this to become a **Default organization**, make sure to check the box
for this.

You can control the
[auto-start behaviour](../../workspaces/lifecycle.md#auto-start) for workspaces
in this organization. You can configure:

- **Autostart Days of Week**: configures on which days of the week workspaces in
the organization may automatically start. If you do not want workspaces to
auto-start in the organization _at all_, you can simply deselect all weekdays
here.
- **Workspace Shutdown Behavior**: The number of hours a workspace may be idle
before Coder stops it automatically to help free up resources.
- **User-controlled workspace shutdown behavior**: Whether end-users can set the
desired workspace shutdown behavior. If disabled, Coder uses the
organization's default setting.

You can also control how Coder manages resources for workspaces in this
organization. You can set the:

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

Finally, you can set **Resource Quotas**. These are limits on the number of
**CPUs** and **GPUs**, as well as the amount of **memory** and **disk space**
Expand Down
3 changes: 3 additions & 0 deletions admin/workspace-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ Administrative users can modify a variety of workspace-related behaviors.
- You can modify the [workspace shutdown behavior](shutdown.md) on a
per-organization basis to optimize resource usage.

- You can configure the autostart days of week on a per-organization basis to
minimize unnecessary resource consumption.

- You can [install multiple IDEs](installing-jetbrains.md) onto your image so
that users have alternatives to the default option (VS Code).

Expand Down
4 changes: 4 additions & 0 deletions admin/workspace-management/memory-overprovisioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Coder allows you to set memory provisioning ratios for each of your
organizations. By changing this ratio, you can change the number of workspaces
that fit onto a single Kubernetes node.

> **Note:** This may cause the Linux Kernel to terminate user workloads if there
> is insufficient system memory available. You can read more about this topic
> [here](https://www.kernel.org/doc/gorman/html/understand/understand016.html).

## Step 1: Enabling memory provisioning

A site admin/manager must complete these steps:
Expand Down
Binary file modified assets/admin/create-an-org.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/admin/edit-an-org.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/workspaces/autostart_save_preferences.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/workspaces/enable-autostart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/workspaces/set_autostart_time.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/workspaces/set_autostart_timezone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions workspaces/autostart.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Your workspace must be:
days)
- Off (auto-start doesn't work when workspaces are _on_ to prevent the
triggering of a rebuild while you're working)
- The current day of week must be allowed for auto-start by your organization.

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

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

You can also set your local timezone. This ensures that your workspace will
start at the correct time if you experience seasonal Daylight Savings Time
(DST) changes.

![Set auto-start timezone](../assets/workspaces/set_autostart_timezone.png)

1. Select the workspaces for which you want to enable auto-start and save.

![Select workspaces to auto-start](../assets/workspaces/autostart_save_preferences.png)
Expand Down
6 changes: 6 additions & 0 deletions workspaces/lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ Users can configure a workspace
which sets the time when Coder will rebuild and start their workspaces. Users
typically set this time to coincide with the start of their working day.

Organizations can also configure the days of week on which workspaces are
permitted to start automatically. For example, if users tend to not start their
workspaces on Saturday or Sunday, organization managers can exclude these days
by
[editing the organization](../admin/organizations/manage.md#editing-an-organization).

## Auto-off

Organizations can set an
Expand Down
8 changes: 6 additions & 2 deletions workspaces/preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,9 @@ the Coder CLI:

## Auto-start

Auto-start allows you to set the time when Coder automatically starts and builds
your workspaces. See [auto-start](autostart.md) for more information.
Auto-start allows you to set:

- The time when Coder automatically starts and builds your workspaces.
- Your preferred timezone.

See [auto-start](autostart.md) for more information.