Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit87820a2

Browse files
authored
docs: reorganize scaling docs (#13574)
* refactor scaling docs* manifest* make fmt* fix 404s* fix 404s pt 2* fix manifest
1 parentc01d6fd commit87820a2

File tree

7 files changed

+56
-50
lines changed

7 files changed

+56
-50
lines changed

‎docs/admin/architectures/validated-arch.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Many customers operate Coder in complex organizational environments, consisting
44
of multiple business units, agencies, and/or subsidiaries. This can lead to
5-
numerous Coder deployments,caused by discrepancies in regulatory compliance,
6-
datasovereignty, and level of funding across groups. The Coder Validated
5+
numerous Coder deployments,due to discrepancies in regulatory compliance, data
6+
sovereignty, and level of funding across groups. The Coder Validated
77
Architecture (CVA) prescribes a Kubernetes-based deployment approach, enabling
88
your organization to deploy a stable Coder instance that is easier to maintain
99
and troubleshoot.

‎docs/admin/provisioners.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ sometimes benefits to running external provisioner daemons:
1818

1919
-**Reduce server load**: External provisioners reduce load and build queue
2020
times from the Coder server. See
21-
[Scaling Coder](./scale.md#concurrent-workspace-builds) for more details.
21+
[Scaling Coder](scaling/scale-utility.md#recent-scale-tests) for more details.
2222

2323
Each provisioner can run a single
24-
[concurrent workspace build](./scale.md#concurrent-workspace-builds). For
25-
example, running 30 provisioner containers will allow 30 users to start
24+
[concurrent workspace build](scaling/scale-testing.md#control-plane-provisionerd).
25+
Forexample, running 30 provisioner containers will allow 30 users to start
2626
workspaces at the same time.
2727

2828
Provisioners are started with the

‎docs/admin/architectures/scale-testing.md‎renamed to ‎docs/admin/scaling/scale-testing.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
1-
##Scale Testing
1+
#Scale Testing
22

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

8-
A dedicated Kubernetes cluster for Coder isKubernetes cluster specifically
9-
configured to host andmanage Coder workloads. Kubernetes provides container
10-
orchestrationcapabilities, allowing Coder to efficiently deploy, scale, and
11-
manage workspacesacross a distributed infrastructure. This ensures high
12-
availability, faulttolerance, and scalability for Coder deployments. Coder is
13-
deployed on thiscluster using the
8+
A dedicated Kubernetes cluster for Coder isrecommended to configure, host and
9+
manage Coder workloads. Kubernetes provides container orchestration
10+
capabilities, allowing Coder to efficiently deploy, scale, and manage workspaces
11+
across a distributed infrastructure. This ensures high availability, fault
12+
tolerance, and scalability for Coder deployments. Coder is deployed on this
13+
cluster using the
1414
[Helm chart](../../install/kubernetes.md#install-coder-with-helm).
1515

16+
##Methodology
17+
1618
Our scale tests include the following stages:
1719

1820
1. Prepare environment: create expected users and provision workspaces.
@@ -33,7 +35,7 @@ Our scale tests include the following stages:
3335

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

36-
###Infrastructure and setup requirements
38+
##Infrastructure and setup requirements
3739

3840
The scale tests runner can distribute the workload to overlap single scenarios
3941
based on the workflow configuration:
@@ -60,7 +62,7 @@ The test is deemed successful if users did not experience interruptions in their
6062
workflows,`coderd` did not crash or require restarts, and no other internal
6163
errors were observed.
6264

63-
###Traffic Projections
65+
##Traffic Projections
6466

6567
In our scale tests, we simulate activity from 2000 users, 2000 workspaces, and
6668
2000 agents, with two items of workspace agent metadata being sent every 10
@@ -88,11 +90,11 @@ Database:
8890

8991
##Available reference architectures
9092

91-
[Up to 1,000 users](1k-users.md)
93+
[Up to 1,000 users](../architectures/1k-users.md)
9294

93-
[Up to 2,000 users](2k-users.md)
95+
[Up to 2,000 users](../architectures/2k-users.md)
9496

95-
[Up to 3,000 users](3k-users.md)
97+
[Up to 3,000 users](../architectures/3k-users.md)
9698

9799
##Hardware recommendation
98100

@@ -151,8 +153,8 @@ with a deployment of Coder [workspace proxies](../workspace-proxies.md).
151153
**Node Autoscaling**
152154

153155
We recommend disabling the autoscaling for`coderd` nodes. Autoscaling can cause
154-
interruptions for user connections, see[Autoscaling](../scale.md#autoscaling)
155-
for more details.
156+
interruptions for user connections, see
157+
[Autoscaling](scale-utility.md#autoscaling)for more details.
156158

157159
###Control plane: Workspace Proxies
158160

‎docs/admin/scale.md‎renamed to ‎docs/admin/scaling/scale-utility.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1+
#Scale Tests and Utilities
2+
13
We scale-test Coder with[a built-in utility](#scale-testing-utility) that can
24
be used in your environment for insights into how Coder scales with your
35
infrastructure. For scale-testing Kubernetes clusters we recommend to install
46
and use the dedicated Coder template,
57
[scaletest-runner](https://github.com/coder/coder/tree/main/scaletest/templates/scaletest-runner).
68

7-
Learn more about[Coder’s architecture](architectures/architecture.md) and our
8-
[scale-testing methodology](architectures/scale-testing.md).
9+
Learn more about[Coder’s architecture](../architectures/architecture.md) and
10+
our[scale-testing methodology](scale-testing.md).
911

1012
##Recent scale tests
1113

1214
>Note: the below information is for reference purposes only, and are not
1315
>intended to be used as guidelines for infrastructure sizing. Review the
14-
>[Reference Architectures](architectures/validated-arch.md#node-sizing) for
16+
>[Reference Architectures](../architectures/validated-arch.md#node-sizing) for
1517
>hardware sizing recommendations.
1618
1719
| Environment| Coder CPU| Coder RAM| Coder Replicas| Database| Users| Concurrent builds| Concurrent connections (Terminal/SSH)| Coder Version| Last tested|
@@ -247,6 +249,6 @@ an annotation on the coderd deployment.
247249
##Troubleshooting
248250

249251
If a load test fails or if you are experiencing performance issues during
250-
day-to-day use, you can leverage Coder's[Prometheus metrics](./prometheus.md)
252+
day-to-day use, you can leverage Coder's[Prometheus metrics](../prometheus.md)
251253
to identify bottlenecks during scale tests. Additionally, you can use your
252254
existing cloud monitoring stack to measure load, view server logs, etc.

‎docs/manifest.json‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,30 @@
336336
"path":"./admin/README.md",
337337
"icon_path":"./images/icons/wrench.svg",
338338
"children": [
339+
{
340+
"title":"Architecture",
341+
"description":"Learn about validated and reference architectures for Coder",
342+
"path":"./admin/architectures/architecture.md",
343+
"icon_path":"./images/icons/container.svg",
344+
"children": [
345+
{
346+
"title":"Validated Architecture",
347+
"path":"./admin/architectures/validated-arch.md"
348+
},
349+
{
350+
"title":"Up to 1,000 users",
351+
"path":"./admin/architectures/1k-users.md"
352+
},
353+
{
354+
"title":"Up to 2,000 users",
355+
"path":"./admin/architectures/2k-users.md"
356+
},
357+
{
358+
"title":"Up to 3,000 users",
359+
"path":"./admin/architectures/3k-users.md"
360+
}
361+
]
362+
},
339363
{
340364
"title":"Authentication",
341365
"description":"Learn how to set up authentication using GitHub or OpenID Connect",
@@ -389,34 +413,12 @@
389413
{
390414
"title":"Scaling Coder",
391415
"description":"Learn how to use load testing tools",
392-
"path":"./admin/scale.md",
393-
"icon_path":"./images/icons/scale.svg"
394-
},
395-
{
396-
"title":"Architecture",
397-
"description":"Learn about validated and reference architectures for Coder",
398-
"path":"./admin/architectures/architecture.md",
416+
"path":"./admin/scaling/scale-testing.md",
399417
"icon_path":"./images/icons/scale.svg",
400418
"children": [
401419
{
402-
"title":"Validated Architecture",
403-
"path":"./admin/architectures/validated-arch.md"
404-
},
405-
{
406-
"title":"Scale Testing",
407-
"path":"./admin/architectures/scale-testing.md"
408-
},
409-
{
410-
"title":"Up to 1,000 users",
411-
"path":"./admin/architectures/1k-users.md"
412-
},
413-
{
414-
"title":"Up to 2,000 users",
415-
"path":"./admin/architectures/2k-users.md"
416-
},
417-
{
418-
"title":"Up to 3,000 users",
419-
"path":"./admin/architectures/3k-users.md"
420+
"title":"Scaling Utility",
421+
"path":"./admin/scaling/scale-utility.md"
420422
}
421423
]
422424
},

‎docs/platforms/aws.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ We recommend keeping the default instance type (`t2.xlarge`, 4 cores and 16 GB
2727
memory) if you plan on provisioning Docker containers as workspaces on this EC2
2828
instance. Keep in mind this platforms is intended for proof-of-concept
2929
deployments and you should adjust your infrastructure when preparing for
30-
production use. See:[Scaling Coder](../admin/scale.md)
30+
production use. See:[Scaling Coder](../admin/scaling/scale-testing.md)
3131

3232
Be sure to add a keypair so that you can connect over SSH to further
3333
[configure Coder](../admin/configure.md).

‎docs/platforms/gcp.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ We recommend keeping the default instance type (`e2-standard-4`, 4 cores and 16
2323
GB memory) if you plan on provisioning Docker containers as workspaces on this
2424
VM instance. Keep in mind this platforms is intended for proof-of-concept
2525
deployments and you should adjust your infrastructure when preparing for
26-
production use. See:[Scaling Coder](../admin/scale.md)
26+
production use. See:[Scaling Coder](../admin/scaling/scale-testing.md)
2727

2828
<videoautoplayplaysinlineloop>
2929
<sourcesrc="https://github.com/coder/coder/blob/main/docs/images/platforms/gcp/launch.mp4?raw=true"type="video/mp4">

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp