docs: clarify topologyZoneKey and nodeHostnameKey semantics - #271
Merged
Conversation
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
|
Docs PR opened: ClickHouse/ClickHouse#111078 Updated the Kubernetes Operator API reference to clarify how topologyZoneKey balances pods and nodeHostnameKey enforces exclusive node occupancy. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The
topologyZoneKey/nodeHostnameKeydocstrings didn't state the actual scheduling contract. Support feedback showed users can't tell thattopologyZoneKeyaccepts any node label and scopes per shard, or thatnodeHostnameKeyis a hard one-pod-per-node rule that leaves pods Pending when there are fewer nodes than pods.What
Rewrites the two godoc comments:
topologyZoneKey= balance (spreads pods holding the same data across domains, maxSkew 1, different shards may share a domain),nodeHostnameKey= exclusion (required anti-affinity across all pods of the cluster, needs nodes >= pods; for dense layouts pointtopologyZoneKeyatkubernetes.io/hostnameinstead). CRDs, chart and api-reference regenerated.