Skip to content

Commit ee2c576

Browse files
bpmctmatifali
authored andcommitted
infrastructure landing page
1 parent 03f5a93 commit ee2c576

File tree

3 files changed

+25
-10
lines changed

3 files changed

+25
-10
lines changed

docs/admin/infrastructure/README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
# Infrastructure
22

3-
Guides for setting up and scaling Coder infrastructure.
3+
Learn how to spin up & manage Coder infrastructure.
44

55
## Architecture
66

7-
Coder is a self-hosted platform that runs on your own infrastructure. For large deployments, we recommend running the control plane on Kubernetes. Workspaces can be run as VMs or Kubernetes pods. The control plane (`coderd`) runs in a single region. However, workspace proxies, provisioners, and workspaces can run across regions or even cloud providers for the optimal developer experience.
7+
Coder is a self-hosted platform that runs on your own servers. For large deployments, we recommend running the control plane on Kubernetes. Workspaces can be run as VMs or Kubernetes pods. The control plane (`coderd`) runs in a single region. However, workspace proxies, provisioners, and workspaces can run across regions or even cloud providers for the optimal developer experience.
88

9-
Learn more about Coder's architecture and concepts: [Concepts](./architecture.md)
9+
Learn more about Coder's [architecture, concepts, and dependencies](./architecture.md).
10+
11+
## Reference Architectures
12+
13+
We publish [reference architectures](./reference/README.md) that include best practices around Coder configuration, infrastructure sizing, autoscaling, and operational readiness for different deployment sizes (e.g. `Up to 2000 users`).
14+
15+
## Scale Tests
16+
17+
Use our [scale test utility](./scale-tests.md) that can be run on your Coder deployment to simulate user activity and measure performance.
18+
19+
## Monitoring
20+
21+
See our dedicated [Monitoring](./monitoring.md) section for details around monitoring your Coder deployment via a bundled Grafana dashboard, health check, and/or within your own observibility stack via Prometheus metrics.

docs/admin/monitoring/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Monitoring Coder

docs/manifest.json

+9-7
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@
138138
"path": "./admin/infrastructure/README.md",
139139
"children": [
140140
{
141-
"title": "Architecture Diagram",
141+
"title": "Architecture",
142142
"description": "Learn about Coder's architecture",
143143
"path": "./admin/infrastructure/architecture.md"
144144
},
@@ -164,11 +164,6 @@
164164
{
165165
"title": "Scale Tests",
166166
"path": "./admin/infrastructure/scale-tests.md"
167-
},
168-
{
169-
"title": "Health Check",
170-
"description": "Learn about Coder's automated health checks",
171-
"path": "./admin/infrastructure/health-check.md"
172167
}
173168
]
174169
},
@@ -267,7 +262,14 @@
267262
{
268263
"title": "Monitoring",
269264
"description": "Configure security policy and audit your deployment",
270-
"path": "./admin/security/README.md"
265+
"path": "./admin/security/README.md",
266+
"children": [
267+
{
268+
"title": "Health Check",
269+
"description": "Learn about Coder's automated health checks",
270+
"path": "./admin/monitoring/health-check.md"
271+
}
272+
]
271273
},
272274
{
273275
"title": "Security",

0 commit comments

Comments
 (0)