Skip to content

docs: document spec.clusterDomain in configuration guide#228

Merged
GrigoryPervakov merged 1 commit into
ClickHouse:mainfrom
arekborucki:docs/cluster-domain
Jun 16, 2026
Merged

docs: document spec.clusterDomain in configuration guide#228
GrigoryPervakov merged 1 commit into
ClickHouse:mainfrom
arekborucki:docs/cluster-domain

Conversation

@arekborucki

Copy link
Copy Markdown
Contributor

Why

spec.clusterDomain existed only in the API reference, with no explanation of when or why to set it. Users on clusters with a non-default kubelet --cluster-domain had no guidance, and a mismatch can break. Keeper coordination and Distributed queries with DNS resolution errors.

What

Adds a Cluster domain section to the Configuration guide covering:

  • the default value, cluster.local
  • the FQDN format generated by the operator
  • where the value is used (remote_servers replica host names and Keeper coordination host names)
  • the requirement to set the same value on both ClickHouseCluster and KeeperCluster

@arekborucki arekborucki force-pushed the docs/cluster-domain branch from 6c3fe0f to 05a4d2c Compare June 15, 2026 20:38
@GrigoryPervakov GrigoryPervakov merged commit 024dd86 into ClickHouse:main Jun 16, 2026
21 checks passed
@mintlify

mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown

Docs PR opened: ClickHouse/mintlify-docs-dev#209

Added a Cluster domain section to the Kubernetes Operator configuration guide explaining when and how to override spec.clusterDomain.

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.

2 participants