Kuberhealthy Documentation
June 25, 2026 · View on GitHub
These guides cover installing, operating, and extending Kuberhealthy. You can write your own HealthChecks in any language to validate anything, including synthetic workflow simulation (end-to-end user flows). Start with CHECK_CREATION.md and the client libraries below.
The web interface at / shows HealthCheck status at a glance, /json provides a machine-readable summary, and /metrics is ready for Prometheus.
Client Libraries and Examples
| Language | Client |
|---|---|
| Go | github.com/kuberhealthy/kuberhealthy/v3/pkg/checkclient |
| Python | kuberhealthy |
| TypeScript | @kuberhealthy/kuberhealthy |
| JavaScript | @kuberhealthy/kuberhealthy |
| Rust | kuberhealthy |
| Ruby | kuberhealthy |
| Java | Maven / Gradle |
| Bash | Shell script helper |
AI assistant aids for check authoring:
These skills help draft v3-compatible checks, but the Kuberhealthy docs remain the canonical reference.
Documentation Index
| 📌 | Doc | Purpose |
|---|---|---|
| 📘 | Docs Index (this page) | Full documentation entrypoint. |
| ⚡ | Quickstart | Install, deploy a check, and verify. |
| 🚀 | Deploying Kuberhealthy | Deployment overview and rollout tips. |
| ⛵ | Helm Chart | Helm install, upgrade, and scrape settings. |
| 🌐 | ArgoCD Application | ArgoCD application manifest usage. |
| 🧱 | Kustomize Manifests | Base and overlay kustomize deployment. |
| 🧠 | How Kuberhealthy Works | Operator internals and flow. |
| 🔗 | HTTP API | Endpoints for UI, checks, and automation. |
| 🧪 | Run Once Checks | One-shot validation runs. |
| 🧩 | HealthCheck Creation | Building custom checks. |
| ✅ | HealthCheck Registry | Ready-to-apply check catalog. |
| 🎛️ | Configuration | Environment configuration variables. |
| 📈 | Metrics Catalog | Prometheus metrics and labels. |
| 🧲 | ServiceMonitor | Prometheus Operator ServiceMonitor guide. |
| 🧯 | Troubleshooting | Debugging steps and recovery. |
| 🏗️ | Build and Release | Build, tag, and release workflow. |
| 🗒️ | Release Notes | Version changes and upgrades. |
| 🧭 | Migrate to V3 | V2 to V3 migration guidance. |
| 🤝 | Contributing | Contribution workflow. |
| 🧑💻 | Contributors | People and acknowledgements. |
| 🏢 | Adopters | Organizations using Kuberhealthy. |
| 📜 | Code of Conduct | Community standards. |
| 🏛️ | Architecture | System design view. |
| 🔁 | Logic Flow | Runtime flow and control points. |
| 🔌 | Interfaces | Inputs, outputs, and APIs. |
| 🧱 | Structures | Key data structures. |
| ⚙️ | Configuration | Configuration details and defaults. |