Skip to content

Commit 37cfcf6

Browse files
committed
Refactor the page
1 parent f418ece commit 37cfcf6

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

docs/about/architecture.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# Architecture
22

3-
This document provides a high level overview of Coder's architecture.
3+
The Coder deployment model is flexible and offers various components that
4+
platform administrators can deploy and scale depending on the use cases. This
5+
page describes possible deployments, challenges, and risks associated with them.
46

5-
## Single region architecture
7+
Learn more about our [Reference Architectures](../admin/architectures/index.md)
8+
and platform scaling capabilities.
69

7-
![Architecture Diagram](../images/architecture-single-region.png)
8-
9-
## Multi-region architecture
10-
11-
![Architecture Diagram](../images/architecture-multi-region.png)
10+
## Components
1211

13-
## coderd
12+
### coderd
1413

1514
coderd is the service created by running `coder server`. It is a thin API that
1615
connects workspaces, provisioners and users. coderd stores its state in Postgres
@@ -24,7 +23,7 @@ It offers:
2423
- Workspace Web Applications (e.g easily access code-server)
2524
- Agent registration
2625

27-
## provisionerd
26+
### provisionerd
2827

2928
provisionerd is the execution context for infrastructure modifying providers. At
3029
the moment, the only provider is Terraform (running `terraform`).
@@ -33,7 +32,7 @@ By default, the Coder server runs multiple provisioner daemons.
3332
[External provisioners](../admin/provisioners.md) can be added for security or
3433
scalability purposes.
3534

36-
## Agents
35+
### Agents
3736

3837
An agent is the Coder service that runs within a user's remote workspace. It
3938
provides a consistent interface for coderd and clients to communicate with
@@ -50,7 +49,7 @@ Templates are responsible for
5049
[creating and running agents](../templates/index.md#coder-agent) within
5150
workspaces.
5251

53-
## Service Bundling
52+
### Service Bundling
5453

5554
While coderd and Postgres can be orchestrated independently, our default
5655
installation paths bundle them all together into one system service. It's
@@ -61,7 +60,7 @@ situations that necessitate decomposition:
6160
- Achieving greater availability and efficiency (horizontally scale individual
6261
services)
6362

64-
## Workspaces
63+
### Workspaces
6564

6665
At the highest level, a workspace is a set of cloud resources. These resources
6766
can be VMs, Kubernetes clusters, storage buckets, or whatever else Terraform
@@ -72,3 +71,17 @@ while those that don't are called _peripheral resources_.
7271

7372
Each resource may also be _persistent_ or _ephemeral_ depending on whether
7473
they're destroyed on workspace stop.
74+
75+
## Deployment models
76+
77+
### Single region architecture
78+
79+
![Architecture Diagram](../images/architecture-single-region.png)
80+
81+
<!-- Single VM, up to 100 users, Docker+sysbox container runtime -->
82+
83+
### Multi-region architecture
84+
85+
![Architecture Diagram](../images/architecture-multi-region.png)
86+
87+
<!-- Run multiple provisioners in each cloud, allowing Coder to deploy against it (zero trust) -->

0 commit comments

Comments
 (0)