Skip to content

Commit 69c79b3

Browse files
author
Katie Horne
authored
chore: add screenshot to clarify resource requests (#537)
1 parent 37347e3 commit 69c79b3

File tree

2 files changed

+20
-17
lines changed

2 files changed

+20
-17
lines changed

assets/setup/resource-request.png

186 KB
Loading

setup/requirements.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,15 @@ to help you estimate:
1919
1 GB of RAM per developer
2020

2121
These estimates can vary based on actual usage within a workspace. We recommend
22-
starting with 4 CPUs and 16 GB of RAM, then iterating as needed.
22+
starting with 4 CPUs and 16 GB of RAM, then iterating as needed. Developers are
23+
free to request the resource allocation that fits their usage:
24+
25+
![Workspace resource request](../assets/setup/resource-request.png)
2326

2427
We also recommend [monitoring](../guides/admin/usage-monitoring.md) your usage
2528
to determine whether you should change your resource allocation. Accepting a
26-
utilization of RAM of around 50% and CPU of around 70% is a good way to
27-
balance performance with cost.
29+
utilization of RAM of around 50% and CPU of around 70% is a good way to balance
30+
performance with cost.
2831

2932
### Throughput
3033

@@ -60,37 +63,37 @@ launches the Remote IDE in a pop-up window.
6063

6164
## Storage
6265

63-
Coder requires the use of a [persistent
64-
volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) in your
65-
Kubernetes cluster to store [workspaces](../workspaces/index.md) data. More
66-
specifically, the persistent volume claim (PVC) requires the block storage type
67-
(the PVC is created when you create the workspace to mount the requested block
68-
storage).
66+
Coder requires the use of a
67+
[persistent volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
68+
in your Kubernetes cluster to store [workspaces](../workspaces/index.md) data.
69+
More specifically, the persistent volume claim (PVC) requires the block storage
70+
type (the PVC is created when you create the workspace to mount the requested
71+
block storage).
6972

7073
Files stored in the `/home` directory of a workspace are persisted in the PVC.
71-
All files that live *outside* of the `/home` directory are written to the node's
74+
All files that live _outside_ of the `/home` directory are written to the node's
7275
disk storage (the node's disk storage is shared across all workspaces on that
7376
node). If there's insufficient node disk storage, Coder cannot create new
7477
workspaces (and, in some cases, workspaces may be evicted from the node). To
7578
avoid this, we recommend creating nodes with a disk size of at least 100 GiB.
7679

77-
Additionally, you must enable [dynamic volume
78-
provisioning](https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/#enabling-dynamic-provisioning)
80+
Additionally, you must enable
81+
[dynamic volume provisioning](https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/#enabling-dynamic-provisioning)
7982
so that Coder can mount the PVC to the workspace (if you're using a custom
8083
`StorageClass`, be sure that it supports DVP. Otherwise, Coder cannot provision
8184
workspaces.
8285

8386
## Database
8487

85-
Coder requires a [PostgreSQL](https://www.postgresql.org) database to
86-
store metadata related to your deployment.
88+
Coder requires a [PostgreSQL](https://www.postgresql.org) database to store
89+
metadata related to your deployment.
8790

8891
By default, Coder deploys a TimescaleDB internal to your Kubernetes cluster.
8992
This is included for evaluation purposes _only_, and it is _not_ backed up. For
9093
production deployments, we recommend using a PostgreSQL database _external_ to
91-
your cluster. You can connect Coder to your external database by [modifying the
92-
Helm chart](../guides/admin/helm-charts.md) with information regarding your
93-
PostgreSQL instance.
94+
your cluster. You can connect Coder to your external database by
95+
[modifying the Helm chart](../guides/admin/helm-charts.md) with information
96+
regarding your PostgreSQL instance.
9497

9598
Coder requires, at minimum, PostgreSQL 11 with the `contrib` package installed.
9699

0 commit comments

Comments
 (0)