Commit 859b4f3
authored
docs: add health check, readiness, and liveness endpoints guide (#281)
Document the liveness, readiness, and detailed health probes exposed by
self-hosted Plane (Commercial Edition) services, and how to consume them.
- New page: self-hosting/manage/health-checks.md covering the primary API
probes (/api/live/, /api/ready/, /api/health/), per-service endpoints
(pi, live, silo, flux, node-runner) and the Go monitor prober, with curl
examples, exact JSON responses, status codes, and the 5s result cache.
- Add "use in your infrastructure" examples: Kubernetes liveness/readiness
probes, Docker Compose healthchecks, and external uptime/LB guidance,
based on Plane's actual Helm and Compose probe configs.
- Note the edition split: Community Edition exposes only the root / check;
the dedicated probes are Commercial Edition.
- Wire the page into the Self-hosting > Manage sidebar.1 parent 3b1d721 commit 859b4f3
2 files changed
Lines changed: 541 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
386 | 386 | | |
387 | 387 | | |
388 | 388 | | |
| 389 | + | |
389 | 390 | | |
390 | 391 | | |
391 | 392 | | |
| |||
0 commit comments