Documentation Index
Fetch the complete documentation index at: https://docs.chkk.io/llms.txt
Use this file to discover all available pages before exploring further.
Coverage Matrix
| |
|---|
| Generate IaC Pull Requests | Available (Request Preview in Free Tier) |
| Curated Release Notes | to latest |
| Guided & Automated Safety Checks | to latest |
| |
| Rapid Upgrade Assessments | Available |
| Upgrade Templates & Plans | In-Place, Blue-Green |
| Upgrade Advisories | Available |
| Preverification | Available |
| |
| End-Of-Life (EOL) Information | Available |
| Version Incompatibility Information | Available |
| Operational Risk Detection | Available |
| |
| Supported Packages | Helm, Kustomize, Kube |
| Private Registries | Covered |
| Custom Built Images | Covered |
ClickHouse Operator Overview
ClickHouse Operator is an open-source controller for managing ClickHouse clusters declaratively. It provides storage, services, and configs from Custom Resources and automates day-2 ops such as rolling upgrades, scaling, and user management. Built-in Prometheus exporters expose database metrics, while optional ZooKeeper / ClickHouseKeeper integration enables high-availability replication. By centralizing these tasks, the operator enforces consistent configs and removes the need for bespoke scripts.
Chkk Coverage
Curated Release Notes
Chkk filters official ClickHouse Operator release notes, surfacing only changes that can impact your clusters. It flags new CR fields, deprecated options, and behavioral shifts—such as the 0.24.0 ClickHouseKeeper overhaul—so you can prepare in advance. Contextual summaries save you from parsing every upstream commit.
Preflight & Postflight Checks
Before an upgrade, Chkk’s preflight checks verify cluster and ClickHouse versions, validates CRDs, and scans existing ClickHouseInstallation manifests for deprecated fields. It ensures required CRD are updated first, preventing reconciliation errors. After the upgrade, Chkk’s postflight checks confirm the operator pod is healthy, CHI resources reconcile, and no ClickHouse pods crash or stall. Rapid feedback lets you remediate while the change window is still open.
Version Recommendations
Chkk tracks the operator’s release and support timeline, warning when your version nears end-of-life or misses critical fixes. It cross-checks compatibility with your Kubernetes version and ClickHouse server build. Guidance includes a stable target version plus the risks of staying put, helping you weigh security patches against upgrade effort.
Upgrade Templates
Upgrade Templates give step-by-step instructions for in-place and blue-green upgrades. They cover CRD application ordering, pausing reconciliations, image swaps, and health verification. For breaking releases, templates include extra tasks such as migrating Keeper data or updating config syntax. Each step is CI/CD-friendly with clear rollback points, cutting human error.
Preverification
Chkk can rehearse the entire upgrade in an isolated twin of your cluster. It applies the new CRDs and operator, then runs all reconciliations, exposing CRD conflicts, stricter validations, or resource spikes before they hit prod. Findings let you adjust manifests or resources ahead of time, ensuring the live rollout is drama-free.
Supported Packages
Whether you install via Helm, plain YAML, or OLM, Chkk parses your manifests and respects custom images or private registries. It can generate GitOps diffs or PR templates that show the exact manifest changes required. Even with a vendor-customized build, Chkk adapts its checks and guidance so upgrades integrate cleanly with your workflow.
Additional Resources
