-
Notifications
You must be signed in to change notification settings - Fork 894
docs: scaling Coder #5206
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
Closed
Closed
docs: scaling Coder #5206
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
fc8839d
docs: scaling Coder
bpmct a587e45
change icon
bpmct fdacfad
Update docs/admin/scale/index.md
bpmct 8cd6abb
Update docs/admin/scale/index.md
bpmct 7637f86
Update docs/admin/scale/index.md
bpmct c1de2b4
add prom link
bpmct e1b04a1
Merge branch 'bpmct/scale-docs' of github.com:coder/coder into bpmct/…
bpmct 1cf65aa
add plumbing for gke doc
bpmct 933beac
add limits/requests
bpmct b31e813
changes from feedback
bpmct b493aa9
change
bpmct File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
We regularly scale-test Coder against various reference architectures. Additionally, we provide a [scale testing utility](#scaletest-utility) which can be used in your own environment to give insight on how Coder scales with your deployment's specific templates, images, etc. | ||
|
||
## Reference Architectures | ||
|
||
| Environment | Users | Workspaces | Last tested | Status | | ||
| ----------------------------------------- | ----- | ---------- | ------------ | -------- | | ||
| [Google Kubernetes Engine (GKE)](#) | 100 | 200 | Nov 29, 2022 | Complete | | ||
| [AWS Elastic Kubernetes Service (EKS)](#) | 100 | 200 | Nov 29, 2022 | Complete | | ||
| [Google Compute Engine + Docker](#) | 1000 | 200 | Nov 29, 2022 | Complete | | ||
| [Google Compute Engine + VMs](#) | 1000 | 200 | Nov 29, 2022 | Complete | | ||
|
||
## 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. | ||
|
||
For example, this command will do the following: | ||
mtojek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- create 100 workspaces | ||
- establish a SSH connection to each workspace | ||
- run `sleep 3 && echo hello` on each workspace via the web terminal | ||
- close connections, attempt to delete all workspaces | ||
- return results (e.g. `99 succeeded, 1 failed to connect` ) | ||
bpmct marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```sh | ||
coder loadtest create-workspaces \ | ||
--count 100 \ | ||
bpmct marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--template "my-custom-template" \ | ||
--parameter image="my-custom-image" \ | ||
--run-command "sleep 3 && echo hello" \ | ||
--connect-timeout "10s" | ||
bpmct marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Run `coder scaletest --help` for all usage | ||
bpmct marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
|
||
> To avoid user outages and orphaned resources, we recommend running scale tests on a secondary "staging" environment. | ||
|
||
If a test fails, you can leverage Coder's [performance tracing](#) and [prometheus metrics](#) to identify bottlenecks during scale tests. Additionally, you can use your existing cloud monitoring stack to measure load, view server logs, etc. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a customer, I'd like to reproduce Coder's results, but the doc doesn't mention the used release version. It might be good to keep the version and date of performing load tests.