Docs: sync upstream clickhouse-operator docs updates#215
Conversation
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 2ece92c. Configure here.
| summary: 'p99 reconcile latency for {{ $labels.controller }} > 30s' | ||
|
|
||
| - alert: ClickHouseOperatorNoLeader | ||
| expr: absent(leader_election_master_status{name="d4ceba06.clickhouse.com"}) == 1 |
There was a problem hiding this comment.
Leader alert uses absent metric
Medium Severity
The suggested ClickHouseOperatorNoLeader rule fires only when leader_election_master_status is entirely missing, not when the series exists but no replica reports master status 1. A failed election with all zeros would not trigger this critical alert.
Reviewed by Cursor Bugbot for commit 2ece92c. Configure here.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|


Summary
Syncs Kubernetes Operator docs from upstream
clickhouse/clickhouse-operator@0d0d4a6("feat: add JBOD additional PVC support for ClickHouse replicas (#136)").cc @matanper for review (original author of the upstream docs changes).
Changes
Updated under
products/kubernetes-operator/:guides/configuration.mdx— adds new "Multi-disk (JBOD) storage" section documentingadditionalVolumeClaimTemplates.guides/introduction.mdx— fixes the cleanupkubectl wait/delete pvcselector to use the actual instance label (my-cluster-clickhouse).guides/monitoring.mdx— new page (Prometheus metrics + health probes).guides/scaling.mdx— new page (replicas/shards/Keeper quorum scaling).guides/tls.mdx— new page (end-to-end TLS with cert-manager).install/helm.mdx— switches the upgrade override flag from--set-json="manager.container.tag=…"to--set manager.image.tag=….install/kubectl.mdx— useskubectl apply --server-side --force-conflicts, and documents theclickhouse-operator-stripped-crds.yamlvariant for environments limited to client-side apply.install/olm.mdx— trailing newline only.overview.mdx— adds Monitoring/Scaling/TLS guide links to the "Next steps" list.reference/api-reference.mdx— addsAdditionalPortandNamedTemplateMetatypes,additionalVolumeClaimTemplates/additionalPortsfields, and several description tweaks (PDB defaults, resources merge semantics,UpdateRevisionfield name).navigation.json— registers the three new guide pages.Conflicts / issues
reference/api-reference.mdxline 71 contains the literal textmounted at /var/lib/clickhouse/disks/<name>inside a Markdown table cell (not a code span). MDX parses<name>as an unclosed JSX tag, which causesmint broken-links/mint validateto fail with:Expected a closing tag for '<name>' ... before the end of 'tableData'. Per the sync instructions, the file is copied verbatim — this needs to be fixed upstream (e.g. wrap<name>in backticks or escape the angle brackets) before this PR can pass validation.mint validatecould not complete a full pass in the sandbox due to the above syntax error blocking MDX parsing of that one file; all other files were copied byte-for-byte from upstream.Note
Low Risk
Documentation-only changes with no runtime or auth logic; the main risk is docs build failure from the unescaped
<name>inapi-reference.mdxuntil that MDX issue is fixed.Overview
This PR syncs
products/kubernetes-operator/with upstream operator docs, with the largest updates in the configuration guide and API reference.The configuration guide adds coverage for multi-disk (JBOD) via
additionalVolumeClaimTemplates,clusterDomain, externally managed secrets (externalSecret), extra Service ports (additionalPorts), version probe / upgrade channel, andsettings.logger, and it updates the documented default container memory to 512Mi.New guide pages document operator Prometheus metrics and health probes, scaling ClickHouse replicas/shards and Keeper quorum (including status conditions), and TLS setup with cert-manager end to end.
Install docs switch Helm version pinning to
--set manager.image.tag, document server-side apply for large manifests (plus the stripped-CRD variant), and the introduction fixes cleanupkubectllabel selectors to*-clickhouse. Navigation and overview link the new guides; api-reference addsAdditionalPort, JBOD PVC types, and related spec field descriptions.Note:
reference/api-reference.mdxstill has baredisks/<name>in a table cell, which can break MDX validation until escaped or backtick-wrapped.Reviewed by Cursor Bugbot for commit 2ece92c. Bugbot is set up for automated code reviews on this repo. Configure here.