Skip to content

add cpu provisioning docs #430

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.

Sign up for GitHub

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 4 commits into from
Jun 24, 2021
Merged

add cpu provisioning docs #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
96d027a
add cpu provisioning docs
ericpaulsen Jun 23, 2021
cfbcb0d
lint
ericpaulsen Jun 23, 2021
c611ad2
Edit text and add screenshot
Jun 23, 2021
531d0d0
Update example
Jun 23, 2021
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
24 changes: 24 additions & 0 deletions admin/workspace-management/cpu-provisioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: CPU provisioning
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reminds me that we should think about whether we want to keep using the term provisioning and overprovisioning... I don't think it's common usage of the term. I understand the need to document what we currently have, though, so this is a good improvement, thank you!

description: Learn how to set the CPU provisioning
ratio.
---

Coder allows you to set the CPU provisioning ratio for each of your
organizations. The CPU provisioning ratio configures workspaces with a
guaranteed minimum capacity, while enabling them to use available capacity for
improved performance. The guaranteed minimum capacity is equivalent to the total
CPUs provisioned for a workspace divided by the provisioning ratio.

For example, let's say that you set a CPU provisioning ratio of 8:1. If a user
creates a workspace with 4 CPUs, then Coder will reserve 0.5 CPUs on the
underlying node, with a maximum limit of 4 CPUs.

## Changing the CPU provisioning ratio

1. Go to **Manage** > **Organizations** and select your organization.
1. At the top of your organization page, click **Actions** > **Edit**. Scroll
down to **CPU Provisioning Rate** and set the maximum ratio.
1. Click **Update**.

![Set CPU provisioning ratios](../../assets/admin/cpu-provisioning-ratios.png)
8 changes: 4 additions & 4 deletions admin/workspace-management/memory-overprovisioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Memory overprovisioning"
description: Learn how to overprovision memory requests from workspaces.
title: "Memory provisioning"
description: Learn how to provision memory requests from workspaces.
---

Coder allows you to set memory overprovisioning ratios for each of your
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.

## Step 1: Enabling memory overprovisioning
## Step 1: Enabling memory provisioning

A site admin/manager must complete these steps:

Expand Down
Binary file added assets/admin/cpu-provisioning-ratios.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,9 @@
{
"path": "./admin/workspace-management/memory-overprovisioning.md"
},
{
"path": "./admin/workspace-management/cpu-provisioning.md"
},
{
"path": "./admin/workspace-management/shutdown.md"
},
Expand Down