Skip to content

Commit 59654fd

Browse files
committed
subpages
1 parent 46f3dc2 commit 59654fd

File tree

5 files changed

+73
-44
lines changed

5 files changed

+73
-44
lines changed

docs/admin/architectures/1k-users.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Reference Architecture: up to 1,000 users
2+
3+
The 1,000 users architecture is designed to cover a wide range of workflows.
4+
Examples of subjects that might utilize this architecture include medium-sized
5+
tech startups, educational units, or small to mid-sized enterprises.
6+
7+
## Hardware recommendations
8+
9+
### Coderd nodes
10+
11+
| Users | Cluster capacity | Replicas | GCP | AWS | Azure |
12+
| ----------- | ------------------- | -------- | --------------- | ---------- | ----------------- |
13+
| Up to 1,000 | 2 vCPU, 8 GB memory | 2 | `n1-standard-2` | `t3.large` | `Standard_D2s_v3` |

docs/admin/architectures/2k-users.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Reference Architecture: up to 2,000 users
2+
3+
In the 2,000 users architecture, there is a moderate increase in traffic,
4+
suggesting a growing user base or expanding operations. This setup is
5+
well-suited for mid-sized companies experiencing growth or for universities
6+
seeking to accommodate their expanding user populations.
7+
8+
Users can be evenly distributed between 2 regions or be attached to different
9+
clusters.
10+
11+
The High Available mode is disabled in this setup, but administrators may
12+
consider enabling it.
13+
14+
## Hardware recommendations
15+
16+
### Coderd nodes
17+
18+
| Users | Cluster capacity | Replicas | GCP | AWS | Azure |
19+
| ----------- | -------------------- | -------- | --------------- | ----------- | ----------------- |
20+
| Up to 2,000 | 4 vCPU, 16 GB memory | 2 | `n1-standard-4` | `t3.xlarge` | `Standard_D4s_v3` |

docs/admin/architectures/3k-users.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Reference Architecture: up to 3,000 users
2+
3+
The 3,000 users architecture targets large-scale enterprises, possibly with
4+
on-premises network and cloud deployments.
5+
6+
Typically, such scale requires a fully-managed HA PostgreSQL service, and all
7+
Coder observability features enabled for operational purposes.
8+
9+
## Hardware recommendations
10+
11+
### Coderd nodes
12+
13+
| Users | Cluster capacity | Replicas | GCP | AWS | Azure |
14+
| ----------- | -------------------- | -------- | --------------- | ----------- | ----------------- |
15+
| Up to 3,000 | 8 vCPU, 32 GB memory | 4 | `n1-standard-4` | `t3.xlarge` | `Standard_D4s_v3` |

docs/admin/reference-architectures.md renamed to docs/admin/architectures/index.md

Lines changed: 4 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Reference architectures
1+
# Reference Architectures
22

33
This document provides prescriptive solutions and reference architectures to
44
support successful deployments of up to 2000 users and outlines at a high-level
@@ -174,32 +174,11 @@ Database:
174174

175175
## Available reference architectures
176176

177-
### Up to 1,000 users
177+
[Up to 1,000 users](1k-users.md)
178178

179-
The 1,000 users architecture is designed to cover a wide range of workflows.
180-
Examples of subjects that might utilize this architecture include medium-sized
181-
tech startups, educational units, or small to mid-sized enterprises.
179+
[Up to 2,000 users](2k-users.md)
182180

183-
### Up to 2,000 users
184-
185-
In the 2,000 users architecture, there is a moderate increase in traffic,
186-
suggesting a growing user base or expanding operations. This setup is
187-
well-suited for mid-sized companies experiencing growth or for universities
188-
seeking to accommodate their expanding user populations.
189-
190-
Users can be evenly distributed between 2 regions or be attached to different
191-
clusters.
192-
193-
The High Available mode is disabled in this setup, but administrators may
194-
consider enabling it.
195-
196-
### Up to 3,000 users
197-
198-
The 3,000 users architecture targets large-scale enterprises, possibly with
199-
on-premises network and cloud deployments.
200-
201-
Typically, such scale requires a fully-managed HA PostgreSQL service, and all
202-
Coder observability features enabled for operational purposes.
181+
[Up to 3,000 users](3k-users.md)
203182

204183
## Hardware recommendation
205184

@@ -239,24 +218,6 @@ provisionerd x users API latency/response time average number of HTTP requests
239218

240219
TODO
241220

242-
#### Up to 1,000 users
243-
244-
| Users | Cluster capacity | Replicas | GCP | AWS | Azure |
245-
| ----------- | ------------------- | -------- | --------------- | ---------- | ----------------- |
246-
| Up to 1,000 | 2 vCPU, 8 GB memory | 2 | `n1-standard-2` | `t3.large` | `Standard_D2s_v3` |
247-
248-
#### Up to 2,000 users
249-
250-
| Users | Cluster capacity | Replicas | GCP | AWS | Azure |
251-
| ----------- | -------------------- | -------- | --------------- | ----------- | ----------------- |
252-
| Up to 2,000 | 4 vCPU, 16 GB memory | 2 | `n1-standard-4` | `t3.xlarge` | `Standard_D4s_v3` |
253-
254-
#### Up to 3,000 users
255-
256-
| Users | Cluster capacity | Replicas | GCP | AWS | Azure |
257-
| ----------- | -------------------- | -------- | --------------- | ----------- | ----------------- |
258-
| Up to 3,000 | 8 vCPU, 32 GB memory | 4 | `n1-standard-4` | `t3.xlarge` | `Standard_D4s_v3` |
259-
260221
### Workspaces
261222

262223
TODO

docs/manifest.json

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -375,10 +375,30 @@
375375
},
376376
{
377377
"title": "Scaling Coder",
378-
"description": "Reference architecture and load testing tools",
378+
"description": "Learn how to use load testing tools",
379379
"path": "./admin/scale.md",
380380
"icon_path": "./images/icons/scale.svg"
381381
},
382+
{
383+
"title": "Reference Architectures",
384+
"description": "Learn about reference architectures for Coder",
385+
"path": "./admin/architectures/index.md",
386+
"icon_path": "./images/icons/scale.svg",
387+
"children": [
388+
{
389+
"title": "Up to 1,000 users",
390+
"path": "./admin/architectures/1k-users.md"
391+
},
392+
{
393+
"title": "Up to 2,000 users",
394+
"path": "./admin/architectures/2k-users.md"
395+
},
396+
{
397+
"title": "Up to 3,000 users",
398+
"path": "./admin/architectures/3k-users.md"
399+
}
400+
]
401+
},
382402
{
383403
"title": "External Provisioners",
384404
"description": "Run provisioners isolated from the Coder server",

0 commit comments

Comments
 (0)