coder · johnstcn · Aug 3, 2023 · Aug 3, 2023 · Aug 3, 2023 · Aug 3, 2023
diff --git a/docs/admin/scale.md b/docs/admin/scale.md
@@ -1,4 +1,4 @@
-We scale-test Coder with the [same utility](#scaletest-utility) that can be used in your environment for insights into how Coder scales with your infrastructure.
+We scale-test Coder with [a built-in utility](#scaletest-utility) that can be used in your environment for insights into how Coder scales with your infrastructure.
 
 ## General concepts
 
@@ -17,43 +17,80 @@ Coder runs workspace operations in a queue. The number of concurrent builds will
 
 ## Infrastructure recommendations
 
+> Note: The below are guidelines for planning your infrastructure. Your mileage may vary depending on your templates, workflows, and users.
+
+When planning your infrastructure, we recommend you consider the following:
+
+1. CPU and memory requirements for `coderd`. We recommend allocating 1 CPU core and 2 GB RAM per `coderd` replica at minimum. See [Concurrent users](#concurrent-users) for more details.
+1. CPU and memory requirements for [external provisioners](../admin/provisioners.md#running-external-provisioners), if required. We recommend allocating 1 CPU core and 1 GB RAM per 5 concurrent workspace builds to external provisioners. Note that this may vary depending on the template used. See [Concurrent workspace builds](#concurrent-workspace-builds) for more details. By default, `coderd` runs 3 integrated provisioners.
+1. CPU and memory requirements for the database used by `coderd`. We recommend allocating an additional 1 CPU core to the database used by Coder for every 1000 active users.
+1. CPU and memory requirements for workspaces created by Coder. This will vary depending on users' needs. However, the Coder agent itself requires at minimum 0.1 CPU cores and 256 MB to run inside a workspace.
+
+### Concurrent users
+
+We recommend allocating 2 CPU cores and 4 GB RAM per `coderd` replica per 1000 active users.
+We also recommend allocating an additional 1 CPU core to the database used by Coder for every 1000 active users.
+Inactive users do not consume Coder resources, although workspaces configured to auto-start will consume resources when they are built.
+
+Users' primary mode of accessing Coder will also affect resource requirements.
+If users will be accessing workspaces primarily via Coder's HTTP interface, we recommend doubling the number of cores and RAM allocated per user.
+For example, if you expect 1000 users accessing workspaces via the web, we recommend allocating 4 CPU cores and 8 GB RAM.
+
+Users accessing workspaces via SSH will consume fewer resources, as SSH connections are not proxied through Coder.
+
 ### Concurrent workspace builds
 
-Workspace builds are CPU-intensive, as it relies on Terraform. Various [Terraform providers](https://registry.terraform.io/browse/providers) have different resource requirements. When tested with our [kubernetes](https://github.com/coder/coder/tree/main/examples/templates/kubernetes) template, `coderd` will consume roughly 8 cores per 30 concurrent workspace builds. For effective provisioning, our helm chart prefers to schedule [one coderd replica per-node](https://github.com/coder/coder/blob/main/helm/values.yaml#L110-L121).
+Workspace builds are CPU-intensive, as it relies on Terraform. Various [Terraform providers](https://registry.terraform.io/browse/providers) have different resource requirements.
+When tested with our [kubernetes](https://github.com/coder/coder/tree/main/examples/templates/kubernetes) template, `coderd` will consume roughly 0.25 cores per concurrent workspace build.
+For effective provisioning, our helm chart prefers to schedule [one coderd replica per-node](https://github.com/coder/coder/blob/main/helm/values.yaml#L110-L121).
 
-To support 120 concurrent workspace builds, for example:
+We recommend:
+
+- Running `coderd` on a dedicated set of nodes. This will prevent other workloads from interfering with workspace builds. You can use [node selectors](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector), or [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to achieve this.
+- Disabling autoscaling for `coderd` nodes. Autoscaling can cause interruptions for users, see [Autoscaling](#autoscaling) for more details.
+- (Enterprise-only) Running external provisioners instead of Coder's built-in provisioners (`CODER_PROVISIONER_DAEMONS=0`) will separate the load caused by workspace provisioning on the `coderd` nodes. For more details, see [External provisioners](../admin/provisioners.md#running-external-provisioners).
+- Alternatively, if increasing the number of integrated provisioner daemons in `coderd` (`CODER_PROVISIONER_DAEMONS>3`), allocate additional resources to `coderd` to compensate (approx. 0.25 cores and 256 MB per provisioner daemon).
+
+For example, to support 120 concurrent workspace builds:
 
 - Create a cluster/nodepool with 4 nodes, 8-core each (AWS: `t3.2xlarge` GCP: `e2-highcpu-8`)
 - Run coderd with 4 replicas, 30 provisioner daemons each. (`CODER_PROVISIONER_DAEMONS=30`)
 - Ensure Coder's [PostgreSQL server](./configure.md#postgresql-database) can use up to 2 cores and 4 GB RAM
 
 ## Recent scale tests
 
-| Environment        | Users | Concurrent builds | Concurrent connections (Terminal/SSH) | Coder Version | Last tested  |
-| ------------------ | ----- | ----------------- | ------------------------------------- | ------------- | ------------ |
-| Kubernetes (GKE)   | 1200  | 120               | 10,000                                | `v0.14.2`     | Jan 10, 2022 |
-| Docker (Single VM) | 500   | 50                | 10,000                                | `v0.13.4`     | Dec 20, 2022 |
+> Note: the below information is for reference purposes only, and are not intended to be used as guidelines for infrastructure sizing.
+
+| Environment      | Coder CPU | Coder RAM | Database         | Users | Concurrent builds | Concurrent connections (Terminal/SSH) | Coder Version | Last tested  |
+| ---------------- | --------- | --------- | ---------------- | ----- | ----------------- | ------------------------------------- | ------------- | ------------ |
+| Kubernetes (GKE) | 3 cores   | 12 GB     | db-f1-micro      | 200   | 3                 | 200 (40KB/s web terminal each)        | `v0.24.1`     | Jun 26, 2023 |
+| Kubernetes (GKE) | 4 cores   | 8 GB      | db-custom-1-3840 | 1500  | 20                | 1,500                                 | `v0.24.1`     | Jun 27, 2023 |
+| Kubernetes (GKE) | 2 cores   | 4 GB      | db-custom-1-3840 | 500   | 20                | 500 (640KB/s SSH each)                | `v0.27.2`     | Jul 27, 2023 |
 
 ## Scale testing utility
 
-Since Coder's performance is highly dependent on the templates and workflows you support, we recommend using our scale testing utility against your own environments.
+Since Coder's performance is highly dependent on the templates and workflows you support, you may wish to use our internal scale testing utility against your own environments.
+
+> Note: This utility is intended for internal use only. It is not subject to any compatibility guarantees, and may cause interruptions for your users.
+> To avoid potential outages and orphaned resources, we recommend running scale tests on a secondary "staging" environment.
+> Run it against a production environment at your own risk.
+
+### Workspace Creation
 
 The following command will run our scale test against your own Coder deployment. You can also specify a template name and any parameter values.
 
 ```sh
-coder scaletest create-workspaces \
+coder exp scaletest create-workspaces \
     --count 1000 \
     --template "kubernetes" \
     --concurrency 0 \
     --cleanup-concurrency 0 \
     --parameter "home_disk_size=10" \
     --run-command "sleep 2 && echo hello"
 
-# Run `coder scaletest create-workspaces --help` for all usage
+# Run `coder exp scaletest create-workspaces --help` for all usage
 ```
 
-> To avoid potential outages and orphaned resources, we recommend running scale tests on a secondary "staging" environment.
-
 The test does the following:
 
 1. create `1000` workspaces
@@ -64,6 +101,32 @@ The test does the following:
 
 Concurrency is configurable. `concurrency 0` means the scaletest test will attempt to create & connect to all workspaces immediately.
 
+If you wish to leave the workspaces running for a period of time, you can specify `--no-cleanup` to skip the cleanup step.
+You are responsible for deleting these resources later.
+
+### Traffic Generation
+
+Given an existing set of workspaces created previously with `create-workspaces`, the following command will generate traffic similar to that of Coder's web terminal against those workspaces.
+
+```sh
+coder exp scaletest workspace-traffic \
+    --byes-per-tick 128 \
+    --tick-interval 100ms \
+    --concurrency 0
+```
+
+To generate SSH traffic, add the `--ssh` flag.
+
+### Cleanup
+
+The scaletest utility will attempt to clean up all workspaces it creates. If you wish to clean up all workspaces, you can run the following command:
+
+```sh
+coder exp scaletest cleanup
+```
+
+This will delete all workspaces and users with the prefix `scaletest-`.
+
 ## Autoscaling
 
 We generally do not recommend using an autoscaler that modifies the number of coderd replicas. In particular, scale