From 02198aa0823f54e4360d9b14eac8e04dade89e7f Mon Sep 17 00:00:00 2001 From: Mark Milligan Date: Sun, 17 Jul 2022 07:22:15 -0500 Subject: [PATCH 1/3] chore: update requirements doc to be current incl. cpu limits --- setup/requirements.md | 43 ++++++++++++++++++++++++++----------------- 1 file changed, 26 insertions(+), 17 deletions(-) diff --git a/setup/requirements.md b/setup/requirements.md index 6c57d25ea..54b4fbe3e 100644 --- a/setup/requirements.md +++ b/setup/requirements.md @@ -22,25 +22,30 @@ resources: cpu: "250m" memory: "512Mi" limits: - cpu: "250m" + cpu: "500m" memory: "512Mi" ``` -By default, Coder is a single-replica deployment. For production systems, -consider using at least three replicas to provide failover and load balancing -capabilities. +By default, Coder is a single-replica deployment. For larger evaluations and +production systems, consider increasing the number of nodes and using at least +two to three replicas to provide failover and load balancing capabilities. If you expect roughly ten or more concurrent users, we recommend increasing these figures to improve platform performance (we also recommend regular performance testing in a staging environment). For **each** active developer using Coder, allocate additional resources. The -specific amount required per developer varies, though we recommend starting with -4 CPUs and 16 GB of RAM, then iterating as needed. Developers are free to +specific amount required per developer varies, though we recommend each workspace have +4 CPUs and 4 GB of RAM, then iterating as needed. Developers are free to request the resource allocation that fits their usage: ![Workspace resource request](../assets/setup/resource-request.png) +Administrators can put limits aka [Resource Quotas at the +Organization-level](../admin/organizations/manage#create-a-new-organization) to +prevent developers from using excessive compute that is either cost prohibitive +and/or destructive to the health of the Kubernetes cluster. + We also recommend [monitoring](../guides/admin/usage-monitoring.md) your usage to determine whether you should change your resource allocation. Accepting a utilization of RAM of around 50% and CPU of around 70% is a good way to balance @@ -67,16 +72,19 @@ have these extensions enabled by running `kubectl get apiservices`): ## Browsers -Use an up-to-date browser to ensure that you can use all of Coder's features. We -currently require the following versions _or newer_: +Use an up-to-date browser to ensure that you can use all of Coder's features. +Coder runs on the following browsers: + +- Apple Safari +- Google Chrome +- Mozilla Firefox +- Microsoft Edge -- Apple Safari 12.1 -- Google Chrome 66 -- Mozilla Firefox 57 -- Microsoft Edge 79 +> We have noticed periodic user interface issues with Apple Safari so if you +> experience difficulties, please use another browser type. If you're using [Remote IDEs](../workspaces/editors.md), allow pop-ups; Coder -launches the Remote IDE in a pop-up window. +launches the Web Terminal and Remote IDE in pop-up windows. ## Storage @@ -144,7 +152,9 @@ that the behavior is as expected. ## Licenses -The use of Coder deployments requires a license that's emailed to you. +The use of Coder deployments requires a license that's emailed to you. Save as a +json file and see [Setup](./configuration#providing-your-license) for how to +add a license file into a Coder deployment. ### Restrictions @@ -153,7 +163,6 @@ Deployments using the free trial of Coder: - **Must** be able to reach and use an outbound internet connection (at minimum, your deployment must be able to access **licensor.coder.com**) - Cannot be deployed in an air-gapped network -- Must use Coder v1.10.0 or later -The above requirements do not apply to potential customers engaged in our -evaluation program. +If you are an enterprise and require Coder to run in an air-gapped network, +please contact sales@coder.com to discuss your project. From 42fda13aef8f3a9b847e4e2b118f125535d38aa8 Mon Sep 17 00:00:00 2001 From: Mark Milligan Date: Sun, 17 Jul 2022 07:25:19 -0500 Subject: [PATCH 2/3] chore: update requirements doc to be current incl. cpu limits --- setup/requirements.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/setup/requirements.md b/setup/requirements.md index 54b4fbe3e..de0a09cb7 100644 --- a/setup/requirements.md +++ b/setup/requirements.md @@ -13,22 +13,25 @@ additional replicas) allocate at least 2 CPU cores, 4 GB of RAM, and 20 GB of storage. In addition to sizing the control plane node(s), you can configure the `coderd` -pod's resource requests/limits and number of replicas in the Helm chart. The +pod's resource requests/limits and number of replicas in the [Helm +chart](https://github.com/coder/enterprise-helm/blob/main/values.yaml). The current defaults for both CPU and memory are the following: ```yaml -resources: - requests: - cpu: "250m" - memory: "512Mi" - limits: - cpu: "500m" - memory: "512Mi" +coderd: + resources: + requests: + cpu: "250m" + memory: "512Mi" + limits: + cpu: "500m" + memory: "512Mi" ``` By default, Coder is a single-replica deployment. For larger evaluations and production systems, consider increasing the number of nodes and using at least -two to three replicas to provide failover and load balancing capabilities. +two to three coderd replicas to provide failover and load balancing +capabilities. If you expect roughly ten or more concurrent users, we recommend increasing these figures to improve platform performance (we also recommend regular From 8fb9a908b9c4b74fdb5db493cea6faf8a42f7e6b Mon Sep 17 00:00:00 2001 From: Eric Date: Wed, 15 Mar 2023 17:58:07 +0000 Subject: [PATCH 3/3] fix: conflicts v2 --- setup/requirements.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/setup/requirements.md b/setup/requirements.md index 9d3825c40..a31a67964 100644 --- a/setup/requirements.md +++ b/setup/requirements.md @@ -156,7 +156,7 @@ that the behavior is as expected. ## Licenses The use of Coder deployments requires a license that's emailed to you. Save as a -json file and see [Setup](./configuration#providing-your-license) for how to +JSON file and see [Setup](./configuration#providing-your-license) for how to add a license file into a Coder deployment. ### Restrictions @@ -167,11 +167,5 @@ Deployments using the free trial of Coder: your deployment must be able to access **licensor.coder.com**) - Cannot be deployed in an air-gapped network -<<<<<<< HEAD If you are an enterprise and require Coder to run in an air-gapped network, please contact sales@coder.com to discuss your project. -======= -> Coder's trial license does not work in an air-gapped environment. If your -> organization is interested in evaluating Coder air-gapped, please contact -> [sales@coder.com](mailto:sales@coder.com) to discuss license requirements. ->>>>>>> main