Skip to content

docs: describe operational readiness #12723

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 8 commits into from
Mar 25, 2024
Merged

docs: describe operational readiness #12723

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3820346
docs: describe operational readiness
mtojek Mar 22, 2024
ce16dfe
Agenda
mtojek Mar 22, 2024
e0b3eca
Merge branch 'main' into 12426-operational-excellence
mtojek Mar 22, 2024
bbe1338
TODOs done
mtojek Mar 22, 2024
ef1806b
Cian's feedback
mtojek Mar 25, 2024
0aac70f
make no j
mtojek Mar 25, 2024
0d45c2c
make no j
mtojek Mar 25, 2024
d8c5708
comment
mtojek Mar 25, 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
Cian's feedback
  • Loading branch information
@mtojek
mtojek committed Mar 25, 2024
commit ef1806b29dc81a5e90fc3dc2444fd3f11fb1a53e
16 changes: 12 additions & 4 deletions docs/admin/architectures/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,18 +357,26 @@ in the

### Configuration

1. Create `values.yaml` and add it to a version control system.
1. Determine the necessary environment variables.
1. Identify the required Helm values for configuration.
1. Create `values.yaml` and add it to a version control system. _Note:_ it is
highly recommended that you create a custom `values.yaml` as opposed to
copying the entire default values.
1. Determine the necessary environment variables.

### Template configuration

1. Establish a dedicated user account for the _Template Administrator_.
1. Maintain Coder templates using version control.
1. Consider implementing a GitOps workflow to automatically push new template
versions to Coder.
1. Consider implementing a GitOps workflow to automatically push new template.
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 upon workspace startup.

### Deployment

1. Leverage automation tooling to automate deployment and upgrades of Coder.

### Observability

1. Enable the Prometheus endpoint (environment variable:
Expand Down