Skip to content

Docs: sync upstream clickhouse-operator docs updates#216

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

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

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Sync docs/ updates from clickhouse/clickhouse-operator (commit 10a6f02) into products/kubernetes-operator/.

cc @pervakov-grigory for review (original author).

Changes

  • New guides added: guides/monitoring.mdx, guides/scaling.mdx, guides/tls.mdx.
  • guides/configuration.mdx — added Multi-disk (JBOD) storage, Cluster domain, and Server logging sections; updated default memory examples.
  • guides/introduction.mdx — corrected kubectl wait / kubectl delete pvc label selectors to use my-cluster-clickhouse.
  • install/helm.mdx — switched flag to --set manager.image.tag=<operator version>.
  • install/kubectl.mdx — switched to kubectl apply --server-side --force-conflicts; documented stripped-CRD variant for client-side apply.
  • install/olm.mdx — minor trailing-newline change.
  • overview.mdx — Monitoring link now points to the new guides/monitoring; added Scaling and TLS entries.
  • navigation.json — added monitoring, scaling, tls entries under guides.
  • reference/api-reference.mdx — added AdditionalPort, NamedTemplateMeta, PersistentVolumeClaimTemplate types; added additionalVolumeClaimTemplates and additionalPorts fields; reworded resources, podDisruptionBudget, updateRevision descriptions.

Context

Triggered by upstream merge 10a6f02 (test: use latest supported ClickHouse versions in tests (#234)), which carries the docs delta authored by Pervakov Grigorii.

Known issues (sync-as-is)

  • products/kubernetes-operator/reference/api-reference.mdx line 71 contains a literal <name> inside a Markdown table cell, which MDX parses as an unclosed JSX tag. mint broken-links reports:

    Syntax error - Unable to parse products/kubernetes-operator/reference/api-reference.mdx - 83:108-83:381: Expected a closing tag for <name> ... before the end of tableData
    This is present verbatim in the upstream file and should be fixed upstream (e.g. wrap in backticks: `<name>`) before re-syncing.

  • mint validate did not complete within the sandbox timeout (>5 min); only broken-links was run.

Note

Low Risk
Documentation-only changes with no runtime or security logic; the known MDX <name> parse issue may fail doc validation until fixed upstream or locally.

Overview
Syncs upstream ClickHouse Kubernetes Operator documentation into products/kubernetes-operator/, expanding configuration coverage and adding task-oriented guides.

New guides: monitoring.mdx (Prometheus/health endpoints, Helm ServiceMonitor, RBAC, sample alerts), scaling.mdx (replica/shard/Keeper scaling and status conditions), and tls.mdx (cert-manager walkthrough for ClickHouse and Keeper).

guides/configuration.mdx gains major sections on JBOD/additionalVolumeClaimTemplates, clusterDomain, externally managed credentials (externalSecret), additionalPorts, version probe/upgradeChannel, and settings.logger; default container memory examples are updated to 512Mi request/limit.

Install docs: Helm uses --set manager.image.tag; kubectl/custom installs document server-side apply and the stripped-CRD manifest for client-side apply.

Navigation/overview: Guides list Monitoring, Scaling, and TLS; reference/api-reference.mdx adds AdditionalPort, JBOD PVC types, and new spec fields with revised field descriptions.

Fixes: Introduction storage cleanup uses label my-cluster-clickhouse instead of mismatched selectors.

Note: api-reference.mdx still has a literal <name> in a table cell (upstream MDX issue) that can break mint broken-links until escaped.

Reviewed by Cursor Bugbot for commit 254d6ec. Bugbot is set up for automated code reviews on this repo. 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, 12:15 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.

0 participants