Skip to content

docs: provide hardware recommendations for reference architectures #12534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 39 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Target load
  • Loading branch information
mtojek committed Mar 12, 2024
commit 894cddbcdffdc2dbeef64da39d1a5420acadf8cb
4 changes: 4 additions & 0 deletions docs/admin/architectures/1k-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ The 1,000 users architecture is designed to cover a wide range of workflows.
Examples of subjects that might utilize this architecture include medium-sized
tech startups, educational units, or small to mid-sized enterprises.

**Target load**: API: up to 180 RPS

**High Availability**: non-essential for small deployments

## Hardware recommendations

### Coderd nodes
Expand Down
6 changes: 4 additions & 2 deletions docs/admin/architectures/2k-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ seeking to accommodate their expanding user populations.
Users can be evenly distributed between 2 regions or be attached to different
clusters.

The High Available mode is disabled in this setup, but administrators may
consider enabling it.
**Target load**: API: up to 300 RPS

**High Availability**: The mode is _disabled_, but administrators may consider
enabling it for deployment reliability.

## Hardware recommendations

Expand Down
7 changes: 5 additions & 2 deletions docs/admin/architectures/3k-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@
The 3,000 users architecture targets large-scale enterprises, possibly with
on-premises network and cloud deployments.

Typically, such scale requires a fully-managed HA PostgreSQL service, and all
Coder observability features enabled for operational purposes.
**Target load**: API: up to 550 RPS

**High Availability**: Typically, such scale requires a fully-managed HA
PostgreSQL service, and all Coder observability features enabled for operational
purposes.

## Hardware recommendations

Expand Down
8 changes: 5 additions & 3 deletions docs/admin/architectures/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ Coder:

- Median CPU usage for _coderd_: 3 vCPU, peaking at 3.7 vCPU during dashboard
tests.
- Median API request rate: 350 req/s during dashboard tests, 250 req/s during
Web Terminal and workspace apps tests.
- Median API request rate: 350 RPS during dashboard tests, 250 RPS during Web
Terminal and workspace apps tests.
- 2000 agent API connections with latency: p90 at 60 ms, p95 at 220 ms.
- on average 2400 Web Socket connections during dashboard tests.

Expand Down Expand Up @@ -205,10 +205,12 @@ this option enabled unless there are compelling reasons to disable it.

Inactive users do not consume Coder resources.

#### HTTP API
#### HTTP API latency

API latency/response time average number of HTTP requests

depending on database perf

TODO

#### Scaling formula
Expand Down