Official documentation for Kubeowler — a Kubernetes cluster health checking tool. Documentation is organized by audience and topic, following common open-source doc conventions.
| Document |
Description |
| Installation |
Supported environments, install from release binary, node inspector DaemonSet, Docker, and production deployment |
| Docker and Kubernetes |
Image build, container run, CronJob example, and RBAC for running Kubeowler in cluster |
| Document |
Description |
| CLI Reference |
kubeowler check options, examples, and output formats (MD, JSON, CSV, HTML) |
| Document |
Description |
| Data Collection |
How Kubeowler connects to the cluster, runs module-based inspections, collects node inspector output, and generates the report |
Per-node inspection is provided by an optional DaemonSet that runs a script on each node. Kubeowler aggregates its JSON output into the report.
| Document |
Description |
| Build and Deploy |
Build and push the node-inspector image, deploy the DaemonSet, integrate with Kubeowler |
| Node Inspection Schema |
JSON structure and field definitions of the DaemonSet script output |
| Collection vs. Report Usage |
Fields that are collected and parsed but not yet displayed in the report |
| Limitations |
DaemonSet constraints, host visibility, and data-source caveats |
| Document |
Description |
| Development Guide |
Project structure, adding inspection types, scoring weights, report extension, contribution workflow |
| Development Environment |
Linux dev setup: proxy, system dependencies, Rust install, build and run (including enterprise and offline) |
| Build and Test |
Rust toolchain, clone, build, test, format and clippy, multi-arch and cross builds |
| Go Migration Plan |
Architecture plan for rebuilding Kubeowler in Go (phases, module mapping, dependencies, timeline) |
| Document |
Description |
| Troubleshooting |
Dependencies and build, network and proxy, runtime, logging and debugging |
Inspection findings use issue codes (e.g. NODE-001, POD-003). Detailed descriptions (summary, severity, symptoms, resolution, references) are in docs/issues/. Index: issues/README.md.