Skip to content

Commit 1cf65aa

Browse files
committed
add plumbing for gke doc
1 parent e1b04a1 commit 1cf65aa

File tree

4 files changed

+64
-7
lines changed

4 files changed

+64
-7
lines changed

docs/admin/scale/docker.md

Whitespace-only changes.

docs/admin/scale/gke.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Scaling Coder on Google Kubernetes Engine (GKE)
2+
3+
This is a reference architecture for Coder on [Google Kubernetes Engine](#). We regurily load test these environments with a standard [kubernetes example](https://github.com/coder/coder/tree/main/examples/templates/kubernetes) template.
4+
5+
> Performance and ideal node sizing depends on many factors, including workspace image and the [workspace sizes](https://github.com/coder/coder/issues/3519) you wish to give developers. Use Coder's [scale testing utility](./index.md#scale-testing-utility) to test your own deployment.
6+
7+
## 50 users
8+
9+
### Cluster configuration
10+
11+
- **Autoscaling profile**: `optimize-utilization`
12+
13+
- **Node pools**
14+
- Default
15+
- **Operating system**: `Ubuntu with containerd`
16+
- **Instance type**: `e2-highcpu-8`
17+
- **Min nodes**: `1`
18+
- **Max nodes**: `4`
19+
20+
### Coder settings
21+
22+
- **Replica count**: `1`
23+
- **Provisioner daemons**: `30`
24+
- **Template**: [kubernetes example](https://github.com/coder/coder/tree/main/examples/templates/kubernetes)
25+
26+
## 100 users
27+
28+
For deployments with 100+ users, we recommend running the Coder server in a separate node pool via taints, tolerations, and nodeselectors.
29+
30+
### Cluster configuration
31+
32+
- **Node pools**
33+
- Coder server
34+
- **Instance type**: `e2-highcpu-4`
35+
- **Operating system**: `Ubuntu with containerd`
36+
- **Autoscaling profile**: `optimize-utilization`
37+
- **Min nodes**: `2`
38+
- **Max nodes**: `4`
39+
- Workspaces
40+
- **Instance type**: `e2-highcpu-16`
41+
- **Node**: `Ubuntu with containerd`
42+
- **Autoscaling profile**: `optimize-utilization`
43+
- **Min nodes**: `3`
44+
- **Max nodes**: `10`
45+
46+
### Coder settings
47+
48+
- **Replica count**: `4`
49+
- **Provisioner daemons**: `25`
50+
- **Template**: [kubernetes example](https://github.com/coder/coder/tree/main/examples/templates/kubernetes)

docs/admin/scale/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ We regularly scale-test Coder against various reference architectures. Additiona
22

33
## Reference Architectures
44

5-
| Environment | Users | Workspaces | Last tested | Status |
6-
| ----------------------------------------- | ----- | ---------- | ------------ | -------- |
7-
| [Google Kubernetes Engine (GKE)](#) | 100 | 200 | Nov 29, 2022 | Complete |
8-
| [AWS Elastic Kubernetes Service (EKS)](#) | 100 | 200 | Nov 29, 2022 | Complete |
9-
| [Google Compute Engine + Docker](#) | 1000 | 200 | Nov 29, 2022 | Complete |
10-
| [Google Compute Engine + VMs](#) | 1000 | 200 | Nov 29, 2022 | Complete |
5+
| Environment | Users | Last tested | Status |
6+
| ------------------------------------------------- | ------------- | ------------ | -------- |
7+
| [Google Kubernetes Engine (GKE)](./gke.md) | 50, 100, 1000 | Nov 29, 2022 | Complete |
8+
| [AWS Elastic Kubernetes Service (EKS)](./eks.md) | 50, 100, 1000 | Nov 29, 2022 | Complete |
9+
| [Google Compute Engine + Docker](./gce-docker.md) | 15, 50 | Nov 29, 2022 | Complete |
10+
| [Google Compute Engine + VMs](./gce-vms.md) | 1000 | Nov 29, 2022 | Complete |
1111

1212
## Scale testing utility
1313

docs/manifest.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,14 @@
257257
"title": "Scaling Coder",
258258
"description": "Reference architecture and load testing tools",
259259
"icon_path": "./images/icons/scale.svg",
260-
"path": "./admin/scale/index.md"
260+
"path": "./admin/scale/index.md",
261+
"children": [
262+
{
263+
"title": "GKE",
264+
"description": "Learn how to scale Coder on GKE",
265+
"path": "./admin/scale/gke.md"
266+
}
267+
]
261268
},
262269
{
263270
"title": "Audit Logs",

0 commit comments

Comments
 (0)