Skip to content

Docs: sync upstream clickhouse-operator docs updates#209

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

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

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs upstream clickhouse-operator#228 by @arekborucki, which documents spec.clusterDomain in the Configuration guide.

cc @arekborucki for review.

Changes

  • products/kubernetes-operator/guides/configuration.mdx — added new ## Cluster domain section between the PVC <Note> and ## Pod configuration, copied verbatim from upstream.

Context

Upstream commit: 024dd86 — "docs: document spec.clusterDomain in configuration guide (#228)".

Pre-existing upstream/downstream drift (not addressed here)

While syncing, I noticed the downstream copies under products/kubernetes-operator/ are behind upstream docs/ on several files unrelated to PR #228. Flagging for awareness — these were not changed by this PR and were left alone:

  • guides/configuration.mdx — beyond the cluster-domain section, downstream has different memory values in a resources example (256Mi/1Gi vs upstream 512Mi/512Mi) and is missing the TLS cross-link and the entire ## External Secret section.
  • guides/introduction.mdx, install/helm.mdx, install/kubectl.mdx, install/olm.mdx, overview.mdx, reference/api-reference.mdx — differ from upstream.
  • guides/monitoring.mdx, guides/scaling.mdx, guides/tls.mdx — present upstream, missing downstream.

Per instructions, only the actual change from PR #228 was synced; the rest should be reconciled upstream-first or via a separate dedicated sync.

Validation

mint validate and mint broken-links timed out in this environment on the full repo (unrelated to this change). The edit is a localized additive section that mirrors upstream exactly.


Note

Low Risk
Documentation-only additive section mirroring upstream; no code or runtime behavior changes.

Overview
Adds a Cluster domain section to the ClickHouse Operator configuration guide, synced from upstream clickhouse-operator PR #228.

The new content explains that spec.clusterDomain (default cluster.local) on ClickHouseCluster and KeeperCluster controls the DNS suffix used for pod FQDNs in generated ClickHouse config—replica hosts in remote_servers and Keeper coordination endpoints. It includes a YAML example and a note to override only when kubelet uses a non-default --cluster-domain, and to keep the same value on both cluster types to avoid DNS failures.

Reviewed by Cursor Bugbot for commit c4242c1. 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, 3:22 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