Skip to content

docs: move architecture to top level #13722

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.

Sign up for GitHub

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 6 commits into from
Jul 1, 2024
Merged

docs: move architecture to top level #13722

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f2f1eee
docs: move architecture to top level
ericpaulsen Jun 28, 2024
dff74b8
make fmt
ericpaulsen Jun 28, 2024
cd81212
fix 404s
ericpaulsen Jun 28, 2024
48b136c
fix 404s pt 2
ericpaulsen Jun 28, 2024
34869e2
Merge branch 'main' into reorg-arch
matifali Jun 28, 2024
d6a7b7f
fix manifest
ericpaulsen Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix 404s
  • Loading branch information
@ericpaulsen
ericpaulsen committed Jun 28, 2024
commit cd81212dbe032cf1bfde640cff1c5dfd49425f72
52 changes: 26 additions & 26 deletions docs/architecture/validated-arch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ by default.

### User

A [user](../users.md) is an individual who utilizes the Coder platform to
A [user](../admin/users.md) is an individual who utilizes the Coder platform to
develop, test, and deploy applications using workspaces. Users can select
available templates to provision workspaces. They interact with Coder using the
web interface, the CLI tool, or directly calling API methods.

### Workspace

A [workspace](../../workspaces.md) refers to an isolated development environment
A [workspace](../workspaces.md) refers to an isolated development environment
where users can write, build, and run code. Workspaces are fully configurable
and can be tailored to specific project requirements, providing developers with
a consistent and efficient development environment. Workspaces can be
Expand All @@ -82,20 +82,20 @@ Coder templates and deployed on resources created by provisioners.

### Template

A [template](../../templates/index.md) in Coder is a predefined configuration
for creating workspaces. Templates streamline the process of workspace creation
by providing pre-configured settings, tooling, and dependencies. They are built
by template administrators on top of Terraform, allowing for efficient
management of infrastructure resources. Additionally, templates can utilize
Coder modules to leverage existing features shared with other templates,
enhancing flexibility and consistency across deployments. Templates describe
provisioning rules for infrastructure resources offered by Terraform providers.
A [template](../templates/index.md) in Coder is a predefined configuration for
creating workspaces. Templates streamline the process of workspace creation by
providing pre-configured settings, tooling, and dependencies. They are built by
template administrators on top of Terraform, allowing for efficient management
of infrastructure resources. Additionally, templates can utilize Coder modules
to leverage existing features shared with other templates, enhancing flexibility
and consistency across deployments. Templates describe provisioning rules for
infrastructure resources offered by Terraform providers.

### Workspace Proxy

A [workspace proxy](../workspace-proxies.md) serves as a relay connection option
for developers connecting to their workspace over SSH, a workspace app, or
through port forwarding. It helps reduce network latency for geo-distributed
A [workspace proxy](../admin/workspace-proxies.md) serves as a relay connection
option for developers connecting to their workspace over SSH, a workspace app,
or through port forwarding. It helps reduce network latency for geo-distributed
teams by minimizing the distance network traffic needs to travel. Notably,
workspace proxies do not handle dashboard connections or API calls.

Expand Down Expand Up @@ -212,11 +212,11 @@ resource "kubernetes_deployment" "coder" {

For sizing recommendations, see the below reference architectures:

- [Up to 1,000 users](1k-users.md)
- [Up to 1,000 users](./1k-users.md)

- [Up to 2,000 users](2k-users.md)
- [Up to 2,000 users](./2k-users.md)

- [Up to 3,000 users](3k-users.md)
- [Up to 3,000 users](./3k-users.md)

### Networking

Expand Down Expand Up @@ -297,7 +297,7 @@ considerations:
active users.
- Enable High Availability mode for database engine for large scale deployments.

If you enable [database encryption](../encryption.md) in Coder, consider
If you enable [database encryption](../admin/encryption.md) in Coder, consider
allocating an additional CPU core to every `coderd` replica.

#### Resource utilization guidelines
Expand All @@ -320,26 +320,26 @@ could affect workspace users experience once the platform is live.

### Helm Chart Configuration

1. Reference our [Helm chart values file](../../../helm/coder/values.yaml) and
1. Reference our [Helm chart values file](../../helm/coder/values.yaml) and
identify the required values for deployment.
1. Create a `values.yaml` and add it to your version control system.
1. Determine the necessary environment variables. Here is the
[full list of supported server environment variables](../../cli/server.md).
[full list of supported server environment variables](../cli/server.md).
1. Follow our documented
[steps for installing Coder via Helm](../../install/kubernetes.md).
[steps for installing Coder via Helm](../install/kubernetes.md).

### Template configuration

1. Establish dedicated accounts for users with the _Template Administrator_
role.
1. Maintain Coder templates using
[version control](../../templates/change-management.md).
[version control](../templates/change-management.md).
1. Consider implementing a GitOps workflow to automatically push new template
versions into Coder from git. For example, on Github, you can use the
[Update Coder Template](https://github.com/marketplace/actions/update-coder-template)
action.
1. Evaluate enabling
[automatic template updates](../../templates/general-settings.md#require-automatic-updates-enterprise)
[automatic template updates](../templates/general-settings.md#require-automatic-updates-enterprise)
upon workspace startup.

### Observability
Expand All @@ -351,13 +351,13 @@ could affect workspace users experience once the platform is live.
leverage pre-configured dashboards, alerts, and runbooks for monitoring
Coder. This includes integrations between Prometheus, Grafana, Loki, and
Alertmanager.
1. Review the [Prometheus response](../prometheus.md) and set up alarms on
1. Review the [Prometheus response](../admin/prometheus.md) and set up alarms on
selected metrics.

### User support

1. Incorporate [support links](../appearance.md#support-links) into internal
documentation accessible from the user context menu. Ensure that hyperlinks
are valid and lead to up-to-date materials.
1. Incorporate [support links](../admin/appearance.md#support-links) into
internal documentation accessible from the user context menu. Ensure that
hyperlinks are valid and lead to up-to-date materials.
1. Encourage the use of `coder support bundle` to allow workspace users to
generate and provide network-related diagnostic data.