Skip to content

Docs: sync upstream clickhouse-operator docs updates#235

Closed
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/18ad1fff
Closed

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

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs the latest /docs content from clickhouse/clickhouse-operator into products/kubernetes-operator/ in this Mintlify site.

Changes

  • New guides (copied from upstream):
    • guides/monitoring.mdx — Prometheus metrics and health probes
    • guides/scaling.mdx — scale replicas, shards, and Keeper quorum
    • guides/tls.mdx — end-to-end TLS with cert-manager
  • Updated guides / overview / install / reference:
    • overview.mdx — new links to monitoring, scaling, TLS guides
    • install/kubectl.mdx — switches to --server-side --force-conflicts apply; adds stripped-CRDs variant for client-side apply
    • install/helm.mdx — Helm value renamed from manager.container.tag to manager.image.tag
    • install/olm.mdx — trailing newline tweak
    • guides/introduction.mdx — corrects kubectl wait / kubectl delete pvc selectors to use the -clickhouse suffix
    • guides/configuration.mdx — adds Multi-disk (JBOD) storage section documenting additionalVolumeClaimTemplates
    • reference/api-reference.mdx — adds AdditionalPort, CABundleSelector types and additionalVolumeClaimTemplates field
  • navigation.json — adds the three new guide pages (monitoring, scaling, tls) under the Guides group, mirroring upstream docs/navigation.json.

Context

Triggered by merge of ClickHouse/clickhouse-operator@15cdb35 (CI-only change), which carried with it the accumulated docs work from recent upstream PRs (#222 scaling, #223 tls, #228 clusterDomain, #230 mintlify fetch, #136 JBOD, #237 caBundle, #238 default user password). Files are copied verbatim from upstream — any required fixes should land upstream first.

Known issues / conflicts

  • MDX syntax error in reference/api-reference.mdx (upstream). The new additionalVolumeClaimTemplates row in the ClickHouseClusterSpec table embeds the literal <name> in a markdown table cell, which MDX parses as an unclosed JSX tag and breaks mint broken-links / mint validate:

    error Syntax error - Unable to parse products/kubernetes-operator/reference/api-reference.mdx
          Expected a closing tag for `<name>` before the end of `tableData`
    

    Per the sync policy, the file is copied as-is and should be fixed upstream (e.g. escape as &lt;name&gt; or wrap in backticks) before this PR is merged, otherwise the page will fail to render.

cc @arekborucki @GrigoryPervakov for review — primary authors of the upstream docs changes being synced.


Note

Medium Risk
Documentation-only, but the unescaped <name> in api-reference.mdx can fail Mintlify build/validation and block publishing until fixed upstream or patched here.

Overview
This PR imports the latest upstream clickhouse-operator documentation into products/kubernetes-operator/ (verbatim sync), expanding what the Mintlify site covers for install, configuration, and day‑2 operations.

New guides add dedicated pages for operator monitoring (Prometheus/health probes), scaling (replicas, shards, Keeper quorum), and TLS (cert-manager walkthrough).

The configuration guide grows substantially with new sections on JBOD / additionalVolumeClaimTemplates, clusterDomain, externalSecret, additionalPorts, version probe / upgradeChannel, expanded default user password and server logging, plus refreshed TLS and default container memory values. Introduction fixes kubectl label selectors for pod/PVC cleanup (-clickhouse suffix).

Install docs document kubectl apply --server-side --force-conflicts (and a stripped-CRDs fallback) and rename the Helm pin to manager.image.tag. Overview and navigation.json link the new guides. api-reference.mdx adds AdditionalPort, CABundleSelector, JBOD templates, and related field/description updates.

Merge blocker: upstream api-reference.mdx still embeds literal <name> in a table cell (JBOD mount path), which breaks MDX parsing until escaped upstream.

Reviewed by Cursor Bugbot for commit af67e0c. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jun 19, 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 19, 2026, 3:04 PM

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.

1 participant