Skip to content

Commit bbe1338

Browse files
committed
TODOs done
1 parent e0b3eca commit bbe1338

File tree

1 file changed

+27
-16
lines changed

1 file changed

+27
-16
lines changed

docs/admin/architectures/index.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -351,32 +351,43 @@ that the service is reliable, secure, and easily scales accordingly to user-base
351351
needs. Operational readiness is crucial because it helps prevent issues that
352352
could affect workspace users experience once the platform is live.
353353

354-
### Configuration
355-
356-
#### Helm values
357-
358-
TODO
354+
Learn about Coder design principles and architectural best practices described
355+
in the
356+
[Well-Architected Framework](https://coder.com/blog/coder-well-architected-framework).
359357

360-
#### Environment variables
358+
### Configuration
361359

362-
TODO
360+
1. Create `values.yaml` and add it to a version control system.
361+
1. Determine the necessary environment variables.
362+
1. Identify the required Helm values for configuration.
363363

364364
### Template configuration
365365

366-
TODO managed via CI/CD
366+
1. Establish a dedicated user account for the _Template Administrator_.
367+
1. Maintain Coder templates using version control.
368+
1. Consider implementing a GitOps workflow to automatically push new template
369+
versions to Coder.
370+
1. Evaluate enabling automatic template updates upon workspace startup.
367371

368372
### Observability
369373

370-
TODO Prometheus, Grafana, logging
374+
1. Enable the Prometheus endpoint (environment variable:
375+
`CODER_PROMETHEUS_ENABLE`).
376+
1. Deploy a visual monitoring system such as Grafana for metrics visualization.
377+
1. Deploy a centralized logs aggregation solution to collect and monitor
378+
application logs.
379+
1. Review the [Prometheus response](../prometheus.md) and set up alarms on
380+
selected metrics.
371381

372382
### Database backups
373383

374-
TODO link scripts if we have any
375-
376-
### Support links
377-
378-
TODO
384+
1. Prepare internal scripts for dumping and restoring databases.
385+
1. Schedule regular database backups, especially before release upgrades.
379386

380-
### Troubleshooting agent
387+
### User support
381388

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

0 commit comments

Comments
 (0)