Skip to content

docs: use scale testing utility #12643

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 23 commits into from
Mar 22, 2024
Merged

docs: use scale testing utility #12643

merged 23 commits into from
Mar 22, 2024

Conversation

mtojek
Copy link
Member

@mtojek mtojek commented Mar 18, 2024

Related: #12426
Preview: https://github.com/coder/coder/blob/12426-own-scale-tests/docs/admin/scale.md

This PR updates the Scaling Coder page with recent changes in scaletest-runner.

Changes:

  • remove/deduplicate outdated content
  • update instructions for coder scaletest switches
  • describe the scaletest runner Coder template including parameters
  • describe test clusters we used for scale testing
  • add paragraph on observability

@mtojek mtojek self-assigned this Mar 18, 2024
@mtojek mtojek changed the title docs: run scale testing utility docs: use scale testing utility Mar 18, 2024
@mtojek mtojek marked this pull request as ready for review March 21, 2024 14:28
@mtojek mtojek requested review from mafredri and johnstcn March 21, 2024 14:28
Comment on lines 156 to 157
Depending on the traffic projections, operators can deploy different sample
clusters to perform scale tests. It is recommended to learn how to operate the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workspace template doesn't control the cluster size; this is up to operators to control.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrased the paragraph 👍

Comment on lines 149 to 155
node_affinity {
required_during_scheduling_ignored_during_execution {
node_selector_term {
match_expressions {
key = "cloud.google.com/gke-nodepool"
operator = "In"
values = ["big-workspaces", "big-workspaces2"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to make this a parameter instead so it's easier to control the node affinity key/value.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I verified this, and it looks like we need to add the parameter to scaletest-runner, and then modify the scaletest create-workspaces to accept the parameter. It sounds to me more like a follow-up?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBH it could just be hard-coded in the template but folks who just use the template as-is are likely going to run into issues. Maybe add a note about having to edit the node affinity to match your environment.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, I added a template variable and dropped a note in docs.

@mtojek mtojek requested a review from johnstcn March 22, 2024 10:12
@mtojek mtojek enabled auto-merge (squash) March 22, 2024 11:31
@mtojek mtojek merged commit a7d9d87 into main Mar 22, 2024
@mtojek mtojek deleted the 12426-own-scale-tests branch March 22, 2024 11:33
@github-actions github-actions bot locked and limited conversation to collaborators Mar 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants