Docs: sync upstream clickhouse-operator docs updates#208
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 8e88a4e. Configure here.
| labels: | ||
| severity: critical | ||
| annotations: | ||
| summary: 'No leader for the ClickHouse operator (HA deployment)' |
There was a problem hiding this comment.
Leader alert uses absent()
Medium Severity
The suggested ClickHouseOperatorNoLeader rule uses absent(leader_election_master_status{...}), which fires only when the metric series is missing entirely—not when leader election is enabled but no replica reports master status 1. It also tends to fire on deployments without leader election, where the metric never exists, despite the summary claiming “no leader” in HA.
Reviewed by Cursor Bugbot for commit 8e88a4e. Configure here.


Summary
Syncs
/docsupdates from clickhouse/clickhouse-operator@f55fbb7 ("docs: update AGENTS.md, do not run tests on pure documentation changes (#231)") intoproducts/kubernetes-operator/.cc @gerlowskija — original author was @pervakovgrigorii (
Pervakov Grigorii <pervakov.grigory@gmail.com>); please review.Changes
New guides:
guides/monitoring.mdx— Prometheus metrics and health probes for the operatorguides/scaling.mdx— Scale replicas, shards, and Keeper quorumguides/tls.mdx— End-to-end TLS with cert-managerUpdated:
navigation.json— adds monitoring/scaling/tls entries under Guidesoverview.mdx— links to the three new guides (fixes broken monitoring link)guides/configuration.mdx— adds External Secret section, TLS guide cross-link, bumps default operator memory to 512Miguides/introduction.mdx— corrects cleanupkubectlselectors to<name>-clickhouseinstall/helm.mdx— fixes Helm install command (--set manager.image.tag=…)install/kubectl.mdx— fixeskubectl applyto use-f dist/install.yamlinstall/olm.mdx— trailing newline onlyreference/api-reference.mdx— addsAdditionalPorttype andadditionalPortsfield onClickHouseClusterSpec; updatesResourcesand Keeper PDB descriptionsContext
Files were copied verbatim from upstream. No conflicts.
mint validatewas attempted but timed out on the full repo; the changed MDX files parse cleanly and follow existing frontmatter/link conventions. Per instructions, any issues should be fixed upstream first.Note
Low Risk
Documentation-only sync with no runtime or application code changes; risk is limited to doc accuracy and broken links if upstream content diverges.
Overview
Imports upstream documentation into
products/kubernetes-operator/, with the largest additions in the configuration guide and three new task guides.New guides cover operator Prometheus metrics and health probes (
monitoring.mdx), scaling replicas/shards and Keeper quorum (scaling.mdx), and end-to-end TLS with cert-manager (tls.mdx).navigation.jsonandoverview.mdxwire them into the sidebar and fix the monitoring link that previously pointed at the introduction page.guides/configuration.mdxgrows substantially:spec.externalSecret(Observe/Manage, required keys, status conditions),spec.additionalPorts(reserved ports/names, MySQL example), version probe andupgradeChannel,spec.settings.logger, updated default container memory (512Mi request/limit), and a cross-link to the TLS guide.Smaller fixes:
introduction.mdxcleanup commands use the-clickhouseinstance label;install/helm.mdxuses--set manager.image.tag;install/kubectl.mdxappliesdist/install.yamlwith-f;api-reference.mdxdocumentsAdditionalPort/additionalPortsand refreshes resources and Keeper PDB wording.Reviewed by Cursor Bugbot for commit 8e88a4e. Bugbot is set up for automated code reviews on this repo. Configure here.