Skip to content

Docs: sync upstream clickhouse-operator docs updates#213

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

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

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs /docs from clickhouse/clickhouse-operator into products/kubernetes-operator/ in this repo.

cc @GrigoryPervakov for review (author of the triggering upstream commit 124b588 — "feat: add crds as a separate release artifact, build stripped crds to fit client-side apply", PR #232).

Changes

  • install/kubectl.mdx — switch the manifest install to kubectl apply --server-side --force-conflicts, document the new clickhouse-operator-stripped-crds.yaml artifact for client-side-apply environments, and fix the make build-installer step to use kubectl apply -f (was -k).
  • navigation.json + overview.mdx — add new guides: Monitoring, Scaling, Securing with TLS.
  • guides/monitoring.mdx, guides/scaling.mdx, guides/tls.mdx — new pages from upstream.
  • guides/configuration.mdx — adds Cluster domain section, bumps example Keeper memory limits to 512Mi, adds end-to-end TLS cross-reference.
  • guides/introduction.mdx — corrects post-delete kubectl wait / kubectl delete pvc label selectors to my-cluster-clickhouse.
  • install/helm.mdx — fixes the operator-version Helm flag to --set manager.image.tag=....
  • install/olm.mdx — minor whitespace.
  • reference/api-reference.mdx — adds AdditionalPort type, adds additionalPorts field on ClickHouseClusterSpec, refreshes resources and podDisruptionBudget descriptions, and corrects updateRevision naming in KeeperClusterStatus.

Context

The triggering commit only touched install/kubectl.mdx, but the local copy of /docs had drifted from upstream across several other files (likely un-synced prior upstream PRs). Per the sync instructions, all upstream /docs content was copied over exactly as-is — any issues should be fixed upstream first. No conflicts encountered. mint validate / mint broken-links timed out on this large repo and could not be completed; please re-run in CI if needed.


Note

Low Risk
Documentation-only sync with corrected install examples and new guide pages; no runtime or application code changes.

Overview
Brings the Kubernetes Operator docs in this repo in line with upstream clickhouse/clickhouse-operator /docs, with no product-code changes—only MDX, navigation, and reference updates.

New guides — Adds Monitoring (Prometheus/health endpoints, Helm ServiceMonitor, RBAC, sample alerts), Scaling (replicas/shards, schema sync, Keeper quorum and status conditions), and Securing with TLS (cert-manager walkthrough, Keeper encryption). navigation.json and overview.mdx link these pages; the overview no longer points monitoring at the introduction guide.

Configuration guide — Documents spec.clusterDomain, spec.externalSecret (keys, Observe/Manage, ExternalSecretValid), spec.additionalPorts (reserved ports, MySQL example), version probe / upgradeChannel, and spec.settings.logger. Example default container memory is 512Mi (request and limit); TLS section cross-links the new TLS guide.

Install fixeskubectl install uses server-side apply and documents clickhouse-operator-stripped-crds.yaml for client-side-only clusters; custom builds use kubectl apply -f dist/install.yaml. Helm version pin is --set manager.image.tag= (replacing the broken manager.container.tag / --set-json example).

Smaller edits — Introduction cleanup uses label my-cluster-clickhouse for wait/delete PVC. API reference adds AdditionalPort / additionalPorts, updates container resources merge behavior and Keeper PDB wording, and fixes updateRevision description on KeeperClusterStatus.

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

@mintlify

mintlify Bot commented Jun 16, 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 16, 2026, 4:52 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