Document the Kubernetes/Helm installation - #36
Conversation
|
Hello, could you change branch to the release2.0. There is the changed |
The chart in helm/incidentrelay had no documentation page: the only mention was a short section in the README, and getting-started listed Docker, RPM and systemd as the available methods. Add getting-started/kubernetes.md covering what the chart deploys, how values map onto incidentrelay.conf, the SQLite and PostgreSQL setups, migrations and web scaling, probes, ingress, workers and uninstall caveats. Mirror it into docs/ru and link it from the installation dispatchers, the mkdocs nav and the README.
1ce1315 to
bace86a
Compare
|
Rebased both PRs onto Heads-up on translations: the English page is here, but I had to drop the Russian mirror. The RU text is preserved in this branch's history if it's useful later: Is |
|
I don't think so, to reduce conflict resolution. I'll translate the remaining documentation after the merge. |
2 participants
Problem
The Helm chart in
helm/incidentrelayhas no documentation page. The only mention is a short section in the README, anddocs/getting-started/lists Docker, RPM and systemd as the available installation methods — Kubernetes is absent from the nav, from the installation dispatcher and from the getting-started table.Change
New page
getting-started/kubernetes.md:INCIDENTRELAY_SERVICEconfigmap is rendered intoincidentrelay.conf, plusexistingConfigSecretand thechecksum/configcaveat that comes with it/healthzand/readyzsemantics, ingress, first admin user, workers, custom voice providershelm uninstallremoves the chart-created PVC along with the SQLite databaseLinked from the installation dispatcher, the getting-started table, the mkdocs nav and the README.
Merge order
The page documents the Slack Socket Mode worker, which is added to the chart in #35. Merge #35 first — until then the
slacksection describes a component the chart does not ship, andslack.enabledis not a valid value.Everything else on the page describes the chart as it is on
release/2.0today.Notes
Rebased from
mainontorelease/2.0as requested. The Russian mirror that existed onmainwas dropped along the way, sincedocs/ruis not present on this branch.Two rough edges operators will hit are described rather than worked around: the log volume is an
emptyDir, and the application logs to files rather than stdout, sokubectl logsshows only the entrypoint banner.No application or chart code is touched.