Skip to content

Docs: sync upstream clickhouse-operator docs updates - #116324

Merged
Blargian merged 1 commit into
masterfrom
mintlify/b02dc523
Aug 25, 2026
Merged

Docs: sync upstream clickhouse-operator docs updates#116324
Blargian merged 1 commit into
masterfrom
mintlify/b02dc523

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Changelog category (leave one):

  • Documentation (changelog entry is not required)

Summary

Re-syncs the Kubernetes Operator docs under docs/products/kubernetes-operator/ to exactly match the upstream clickhouse-operator repo /docs (verbatim copy, upstream as source of truth).

Changes

  • guides/configuration.mdx: matches upstream. Removes a duplicated ## Cluster domain {#cluster-domain} section (duplicate anchor) and a stale Multi-disk (JBOD) storage subsection that upstream moved to the storage guide (already synced there). Picks up upstream's updated wording about the headless and per-replica internal Services.
  • guides/monitoring.mdx, guides/tls.mdx: restored upstream link targets and heading-based step formatting.
  • install/kubectl.mdx: restored upstream <Step> + ### heading formatting (downstream copy had been converted to <Step title=... id=...>).
  • overview.mdx: removed a downstream-only "GitHub Repository" bullet that does not exist upstream.

Conflicts / issues to fix upstream

  • Broken anchors reintroduced: upstream links to /reference/settings/server-settings/settings#prometheus (monitoring.mdx) and /reference/settings/server-settings/settings#openssl (tls.mdx, 2×). On this site, settings.mdx is a short index page; those anchors live at /reference/settings/server-settings/settings/other#prometheus and .../other#openssl. The downstream copies had this fixed; this PR reverts to the upstream (broken-anchor) form. Fix the links upstream, then re-sync.
  • Downstream-only content dropped: the overview.mdx GitHub Repository bullet and the <Steps> formatting in tls.mdx/kubectl.mdx existed only downstream. If they should be kept, add them upstream first.

Context

Triggered by ClickHouse/clickhouse-operator#301, which changed only test/CI files. The drift above is pre-existing and was reconciled as part of this sync.

cc @GrigoryPervakov for review.


Workflow [PR]
Sync PR [sync-upstream/pr/116324]

Version info

  • Merged into: 26.9.1.98 (included in 26.9 and later)

@clickhouse-gh

clickhouse-gh Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Workflow [PR], commit [17084d4]

Summary:


AI Review

Summary

This PR re-syncs the Kubernetes Operator docs from upstream and removes a fair amount of downstream-only divergence. I found one documentation regression in the clusterDomain section: the new text no longer explicitly documents how the setting affects ClickHouse replica hostnames, so the most common ClickHouseCluster / remote_servers case is now left implicit.

Findings

⚠️ Majors

  • [docs/products/kubernetes-operator/guides/configuration.mdx:109] The clusterDomain section now names the public and internal Services, but it no longer states that the suffix is written into replica hostnames in remote_servers or shows the FQDN shape for replica-to-replica traffic. A reader with a custom cluster domain now only gets the concrete KeeperCluster example even though the same setting also controls the replica DNS that Distributed queries depend on. Suggested fix: restore the old remote_servers explanation or add an explicit replica FQDN example alongside the Keeper example.
Final Verdict

⚠️ Changes requested

@clickhouse-gh clickhouse-gh Bot added the pr-documentation Documentation PRs for the specific code PR label Aug 25, 2026
Comment thread docs/products/kubernetes-operator/guides/configuration.mdx
@Blargian
Blargian added this pull request to the merge queue Aug 25, 2026
Merged via the queue into master with commit 3216bc8 Aug 25, 2026
182 checks passed
@Blargian
Blargian deleted the mintlify/b02dc523 branch August 25, 2026 14:54
@robot-ch-test-poll robot-ch-test-poll added the pr-synced-to-cloud The PR is synced to the cloud repo label Aug 25, 2026
@mintlify

mintlify Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
ClickHouse-docs 🔴 Failed Aug 26, 2026, 9:40 AM

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

Labels

pr-documentation Documentation PRs for the specific code PR pr-synced-to-cloud The PR is synced to the cloud repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants