Skip to content

docs: update reference architecture: glossary, scale tests methodology #12438

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.

Sign up for GitHub

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 20 commits into from
Mar 8, 2024
Merged

docs: update reference architecture: glossary, scale tests methodology #12438

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
bce5e87
Glossary WIP
mtojek Mar 6, 2024
00c6e15
Provisioner
mtojek Mar 6, 2024
e0a31b4
Glossary done
mtojek Mar 6, 2024
eac4e04
WIP Scale tests methodology
mtojek Mar 6, 2024
49e44a2
Traffic projections
mtojek Mar 7, 2024
31f440b
WIP
mtojek Mar 7, 2024
f105ac8
Fixes
mtojek Mar 7, 2024
4151036
Cian's feedback
mtojek Mar 7, 2024
6d0cc8a
Cian's feedback
mtojek Mar 7, 2024
4b6a3d4
Cian's feedback
mtojek Mar 7, 2024
55b2160
WIP
mtojek Mar 8, 2024
c953d7e
Overlap scenarios
mtojek Mar 8, 2024
47c50df
WIP
mtojek Mar 8, 2024
a3bfbb6
WIP
mtojek Mar 8, 2024
ce7f8a3
WIP
mtojek Mar 8, 2024
92ce63e
WIP
mtojek Mar 8, 2024
4540f96
Reword registry
mtojek Mar 8, 2024
dccaa84
WIP
mtojek Mar 8, 2024
c707d52
WIP
mtojek Mar 8, 2024
d3f5afc
Last one
mtojek Mar 8, 2024
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
WIP
  • Loading branch information
@mtojek
mtojek committed Mar 8, 2024
commit ce7f8a30f7d568d604aab8c82f799f1131563ac9
27 changes: 15 additions & 12 deletions docs/admin/reference-architectures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,15 @@ to streamline template creation by extracting commonly used functionalities such
as web IDEs, third-party integrations, and helper scripts into reusable
components.

The Registry is hosted service and it is not available for air-gapped
The Registry is a hosted service and it is not available for air-gapped
deployments.

## Scale tests methodology
## Scale-testing methodology

Scaling Coder involves careful planning and testing to ensure it can handle more
load without compromising service. This process encompasses infrastructure
setup, traffic projections, and aggressive testing to identify and mitigate
potential bottlenecks.
Scaling Coder involves planning and testing to ensure it can handle more load
without compromising service. This process encompasses infrastructure setup,
traffic projections, and aggressive testing to identify and mitigate potential
bottlenecks.

A dedicated cluster for Coder is Kubernetes cluster specifically configured to
host and manage Coder workloads. Kubernetes provides container orchestration
Expand All @@ -101,18 +101,21 @@ Our scale tests include the following stages:

1. Prepare environment: create expected users and provision workspaces.

2. Dashboard evaluation: verify the responsiveness and stability of Coder
dashboards under varying load conditions. This is achieved by simulating user
interactions using instances of headless Chromium browsers.

3. SSH connections: establish user connections with agents, verifying their
2. SSH connections: establish user connections with agents, verifying their
ability to echo back received content.

3. Web Terminal: verify the PTY connection used for communication with Web
Terminal.

4. Workspace application traffic: assess the handling of user connections with
specific workspace apps, confirming their capability to echo back received
content effectively.

5. Cleanup: delete workspaces and users created in step 1.
5. Dashboard evaluation: verify the responsiveness and stability of Coder
dashboards under varying load conditions. This is achieved by simulating user
interactions using instances of headless Chromium browsers.

6. Cleanup: delete workspaces and users created in step 1.

### Infrastructure and setup requirements

Expand Down