railiance-cluster/docs/README.md
codex c6f4ab536f
All checks were successful
CI Smoke / host-smoke (push) Successful in 0s
CI Smoke / container-smoke (push) Successful in 2s
Add rail-kubernetes compatibility shim
2026-07-26 02:21:19 +02:00

41 lines
1.5 KiB
Markdown

# railiance-cluster Docs
This directory mixes two kinds of material:
- stable S2 cluster-substrate docs that belong in `railiance-cluster`
- transitional workload-contract docs that are temporarily hosted here until
`rail-kubernetes` exists
Use the sections below to keep those concerns separate.
## S2 Substrate Docs
- [Operator runbook](operator-runbook.md)
- [Backup and restore](backup-restore.md)
- [Kubeconfig](kubeconfig.md)
- [First host](first_host.md)
## Published Boundary Docs
- [rail-kubernetes extraction map](rail-kubernetes-extraction-map.md)
- [rail-kubernetes substrate profile](rail-kubernetes-substrate-profile.md)
- [rail-kubernetes compatibility shim](rail-kubernetes-compatibility-shim.md)
## Transitional Workload-Contract Docs
These docs describe the generic workload-on-Kubernetes contract. They are still
hosted in this repo for compatibility, but canonical ownership now lives in
`rail-kubernetes` and the cluster repo should keep only temporary copies or
pointer docs during the migration window.
- [Deployment lifecycle](deployment-lifecycle.md)
- [Railiance app.toml contract](app-toml-contract.md)
- [Railiance overlay repo pattern](overlay-repo-pattern.md)
- [Canary Helm template](canary-helm-template.md)
- [Stage 2 deploy and observe](stage2-deploy-observe.md)
- [Promote, rollback, and onboarding](promote-rollback-onboarding.md)
- [Railiance run command](railiance-run-command.md)
## Incidents
- [2026-03-10 - pgpool CrashLoopBackOff on PostgreSQL HA failover](incidents/2026-03-10-pgpool-missing-secret.md)