Skip to content

Commit ffffdb2

Browse files
stirbystirby
committed
Merge branch 'restructure' into web-rdp-docs
2 parents 5c94f87 + 2f14a08 commit ffffdb2

File tree

8 files changed

+47
-43
lines changed

8 files changed

+47
-43
lines changed

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

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,11 @@ Database:
9090

9191
## Available reference architectures
9292

93-
[Up to 1,000 users](../../architecture/1k-users.md)
93+
[Up to 1,000 users](./validated-architectures/1k-users.md)
9494

95-
[Up to 2,000 users](../../architecture/2k-users.md)
95+
[Up to 2,000 users](./validated-architectures/2k-users.md)
9696

97-
[Up to 3,000 users](../../architecture/3k-users.md)
97+
[Up to 3,000 users](./validated-architectures/3k-users.md)
9898

9999
## Hardware recommendation
100100

@@ -112,13 +112,14 @@ on the workload size to ensure deployment stability.
112112

113113
#### CPU and memory usage
114114

115-
Enabling [agent stats collection](../../cli.md#--prometheus-collect-agent-stats)
115+
Enabling
116+
[agent stats collection](../../reference/cli/README.md#--prometheus-collect-agent-stats)
116117
(optional) may increase memory consumption.
117118

118119
Enabling direct connections between users and workspace agents (apps or SSH
119120
traffic) can help prevent an increase in CPU usage. It is recommended to keep
120-
[this option enabled](../../cli.md#--disable-direct-connections) unless there
121-
are compelling reasons to disable it.
121+
[this option enabled](../../reference/cli/README.md#--disable-direct-connections)
122+
unless there are compelling reasons to disable it.
122123

123124
Inactive users do not consume Coder resources.
124125

@@ -148,18 +149,19 @@ Terminal (bidirectional), and Workspace events/logs (unidirectional).
148149
If the Coder deployment expects traffic from developers spread across the globe,
149150
be aware that customer-facing latency might be higher because of the distance
150151
between users and the load balancer. Fortunately, the latency can be improved
151-
with a deployment of Coder [workspace proxies](../workspace-proxies.md).
152+
with a deployment of Coder
153+
[workspace proxies](../networking/workspace-proxies.md).
152154

153155
**Node Autoscaling**
154156

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

159161
### Control plane: Workspace Proxies
160162

161-
When scaling [workspace proxies](../workspace-proxies.md), follow the same
162-
guidelines as for `coderd` above:
163+
When scaling [workspace proxies](../networking/workspace-proxies.md), follow the
164+
same guidelines as for `coderd` above:
163165

164166
- `1 vCPU x 2 GB memory` for every 250 users.
165167
- Disable autoscaling.

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ infrastructure. For scale-testing Kubernetes clusters we recommend to install
66
and use the dedicated Coder template,
77
[scaletest-runner](https://github.com/coder/coder/tree/main/scaletest/templates/scaletest-runner).
88

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

1212
## Recent scale tests
1313

1414
> Note: the below information is for reference purposes only, and are not
1515
> intended to be used as guidelines for infrastructure sizing. Review the
16-
> [Reference Architectures](../../architecture/validated-arch.md#node-sizing)
17-
> for hardware sizing recommendations.
16+
> [Reference Architectures](./validated-architectures/README.md#node-sizing) for
17+
> hardware sizing recommendations.
1818
1919
| Environment | Coder CPU | Coder RAM | Coder Replicas | Database | Users | Concurrent builds | Concurrent connections (Terminal/SSH) | Coder Version | Last tested |
2020
| ---------------- | --------- | --------- | -------------- | ----------------- | ----- | ----------------- | ------------------------------------- | ------------- | ------------ |
@@ -249,6 +249,7 @@ an annotation on the coderd deployment.
249249
## Troubleshooting
250250

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

‎docs/admin/scaling/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/manifest.json

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,16 @@
169169
"path": "./admin/infrastructure/validated-architectures/3k-users.md"
170170
}
171171
]
172+
},
173+
{
174+
"title": "Scale Testing",
175+
"description": "Ensure your deployment can handle your organization's needs",
176+
"path": "./admin/infrastructure/scale-testing.md"
177+
},
178+
{
179+
"title": "Scaling Utilities",
180+
"description": "Tools to help you scale your deployment",
181+
"path": "./admin/infrastructure/scale-utility.md"
172182
}
173183
]
174184
},
@@ -381,23 +391,6 @@
381391
"path": "./admin/security/secrets.md"
382392
}
383393
]
384-
},
385-
{
386-
"title": "Scaling",
387-
"description": "Scale your deployment to meet your organization's needs",
388-
"path": "./admin/scaling/README.md",
389-
"children": [
390-
{
391-
"title": "Scale Testing",
392-
"description": "Ensure your deployment can handle your organization's needs",
393-
"path": "./admin/scaling/scale-testing.md"
394-
},
395-
{
396-
"title": "Scaling Utilities",
397-
"description": "Tools to help you scale your deployment",
398-
"path": "./admin/scaling/scaling-utility.md"
399-
}
400-
]
401394
}
402395
]
403396
},

‎docs/start/coder-tour.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ is completely free and leverages our
66
[open source repository](https://github.com/coder/coder).
77

88
We'll use [Docker](https://docs.docker.com/engine) to manage the compute for a
9-
slim deployment to experiment with
10-
[workpsaces](../tutorials/workspaces/README.md) and
11-
[templates](../tutorials/templates/README.md).
9+
slim deployment to experiment with [workspaces](../user-guides/README.md) and
10+
[templates](../admin/templates/README.md).
1211

1312
Docker is not necessary for every Coder deployment and is only used here for
1413
simplicity.

‎docs/start/local-deploy.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ Coder deployment from our
55
[open source repository](https://github.com/coder/coder).
66

77
We'll use [Docker](https://docs.docker.com/engine) to manage the compute for a
8-
slim deployment to experiment with
9-
[workpsaces](../tutorials/workspaces/README.md) and
10-
[templates](../tutorials/templates/README.md).
8+
slim deployment to experiment with [workspaces](../user-guides/README.md) and
9+
[templates](../admin/templates/README.md).
1110

1211
Docker is not necessary for every Coder deployment and is only used here for
1312
simplicity.

‎docs/start/local-install.mnd

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎docs/user-guides/workspace-access.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Access your workspace
2+
3+
TODO:
4+
5+
- through the UI
6+
- coder ssh
7+
- ports
8+
- listening/shared ports
9+
- port forwarding
10+
- coder apps
11+
- VSCode
12+
- JetBrains
13+

0 commit comments

Comments
 (0)