Skip to content

Docs: sync upstream clickhouse-operator docs updates#215

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/ba5d77d1
Open

Docs: sync upstream clickhouse-operator docs updates#215
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/ba5d77d1

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

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 documenting additionalVolumeClaimTemplates.
  • guides/introduction.mdx — fixes the cleanup kubectl wait/delete pvc selector to use the actual instance label (my-cluster-clickhouse).
  • guides/monitoring.mdxnew page (Prometheus metrics + health probes).
  • guides/scaling.mdxnew page (replicas/shards/Keeper quorum scaling).
  • guides/tls.mdxnew 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 — uses kubectl apply --server-side --force-conflicts, and documents the clickhouse-operator-stripped-crds.yaml variant 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 — adds AdditionalPort and NamedTemplateMeta types, additionalVolumeClaimTemplates/additionalPorts fields, and several description tweaks (PDB defaults, resources merge semantics, UpdateRevision field name).
  • navigation.json — registers the three new guide pages.

Conflicts / issues

  • reference/api-reference.mdx line 71 contains the literal text mounted at /var/lib/clickhouse/disks/<name> inside a Markdown table cell (not a code span). MDX parses <name> as an unclosed JSX tag, which causes mint broken-links / mint validate to 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 validate could 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> in api-reference.mdx until 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, and settings.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 cleanup kubectl label selectors to *-clickhouse. Navigation and overview link the new guides; api-reference adds AdditionalPort, JBOD PVC types, and related spec field descriptions.

Note: reference/api-reference.mdx still has bare disks/<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.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ 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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 2ece92c. Configure here.

@mintlify

mintlify Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview Jun 17, 2026, 11:18 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants