Skip to content

Commit c4ee776

Browse files
Docs setup requirements compute (#1051)
* chore: update requirements doc to be current incl. cpu limits * chore: update requirements doc to be current incl. cpu limits * fix: conflicts v2 --------- Co-authored-by: Eric <ericpaulsen@coder.com>
1 parent 4f0fb7d commit c4ee776

File tree

1 file changed

+49
-12
lines changed

1 file changed

+49
-12
lines changed

setup/requirements.md

+49-12
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,35 @@ following resource minimums to ensure quality performance.
55

66
## Compute
77

8+
For the Coder control plane (which consists of the `coderd` pod and any
9+
additional replicas) allocate at least 2 CPU cores, 4 GB of RAM, and 20 GB of
10+
storage.
11+
12+
In addition to sizing the control plane node(s), you can configure the `coderd`
13+
pod's resource requests/limits and number of replicas in the [Helm
14+
chart](https://github.com/coder/enterprise-helm/blob/main/values.yaml). The
15+
current defaults for both CPU and memory are the following:
16+
17+
```yaml
18+
coderd:
19+
resources:
20+
requests:
21+
cpu: "250m"
22+
memory: "512Mi"
23+
limits:
24+
cpu: "500m"
25+
memory: "512Mi"
26+
```
27+
28+
By default, Coder is a single-replica deployment. For larger evaluations and
29+
production systems, consider increasing the number of nodes and using at least
30+
two to three coderd replicas to provide failover and load balancing
31+
capabilities.
32+
33+
If you expect roughly ten or more concurrent users, we recommend increasing
34+
these figures to improve platform performance (we also recommend regular
35+
performance testing in a staging environment).
36+
837
See [Scaling](./scaling.md) for more information.
938
1039
For **each** active developer using Coder, allocate additional resources. The
@@ -15,6 +44,11 @@ fits their usage:
1544
1645
![Workspace resource request](../assets/setup/resource-request.png)
1746
47+
Administrators can put limits aka [Resource Quotas at the
48+
Organization-level](../admin/organizations/manage#create-a-new-organization) to
49+
prevent developers from using excessive compute that is either cost prohibitive
50+
and/or destructive to the health of the Kubernetes cluster.
51+
1852
We also recommend [monitoring](../guides/admin/usage-monitoring.md) your usage
1953
to determine whether you should change your resource allocation. Accepting a
2054
utilization of RAM of around 50% and CPU of around 70% is a good way to balance
@@ -41,16 +75,19 @@ have these extensions enabled by running `kubectl get apiservices`):
4175

4276
## Browsers
4377

44-
Use an up-to-date browser to ensure that you can use all of Coder's features. We
45-
currently require the following versions _or newer_:
78+
Use an up-to-date browser to ensure that you can use all of Coder's features.
79+
Coder runs on the following browsers:
80+
81+
- Apple Safari
82+
- Google Chrome
83+
- Mozilla Firefox
84+
- Microsoft Edge
4685

47-
- Apple Safari 12.1
48-
- Google Chrome 66
49-
- Mozilla Firefox 57
50-
- Microsoft Edge 79
86+
> We have noticed periodic user interface issues with Apple Safari so if you
87+
> experience difficulties, please use another browser type.
5188

5289
If you're using [Remote IDEs](../workspaces/editors.md), allow pop-ups; Coder
53-
launches the Remote IDE in a pop-up window.
90+
launches the Web Terminal and Remote IDE in pop-up windows.
5491

5592
## Storage
5693

@@ -118,7 +155,9 @@ that the behavior is as expected.
118155

119156
## Licenses
120157

121-
The use of Coder deployments requires a license that's emailed to you.
158+
The use of Coder deployments requires a license that's emailed to you. Save as a
159+
JSON file and see [Setup](./configuration#providing-your-license) for how to
160+
add a license file into a Coder deployment.
122161

123162
### Restrictions
124163

@@ -127,8 +166,6 @@ Deployments using the free trial of Coder:
127166
- **Must** be able to reach and use an outbound internet connection (at minimum,
128167
your deployment must be able to access **licensor.coder.com**)
129168
- Cannot be deployed in an air-gapped network
130-
- Must use Coder v1.10.0 or later
131169

132-
> Coder's trial license does not work in an air-gapped environment. If your
133-
> organization is interested in evaluating Coder air-gapped, please contact
134-
> [sales@coder.com](mailto:sales@coder.com) to discuss license requirements.
170+
If you are an enterprise and require Coder to run in an air-gapped network,
171+
please contact sales@coder.com to discuss your project.

0 commit comments

Comments
 (0)