docs: scaling guide#222
Merged
Merged
Conversation
GrigoryPervakov
requested changes
Jun 10, 2026
|
|
||
| A StatefulSet has immutable fields (for example `serviceName`, `selector`, and `volumeClaimTemplates`). When a topology change would require mutating those fields on a shard's existing StatefulSet, the operator cannot update it in place, and that shard keeps its original shape while the newly created shards run the new one. This is tracked in [issue #191](https://github.com/ClickHouse/clickhouse-operator/issues/191). | ||
|
|
||
| If you hit this, delete the affected StatefulSet so the operator recreates it with the current spec: |
Member
There was a problem hiding this comment.
This is not a reproduced issue; it doesn't make sense to mention it in the docs
Contributor
Author
There was a problem hiding this comment.
removed the section
GrigoryPervakov
approved these changes
Jun 11, 2026
|
Docs PR opened: ClickHouse/mintlify-docs-dev#179 Synced upstream clickhouse-operator docs, adding monitoring and scaling guides plus updates to overview, configuration, introduction, OLM install, and API reference. |
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
2 participants
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 docs explain how to configure a cluster but never how to resize one. Users had no reference for what happens when they change
spec.replicasorspec.shards, how the operator keeps the schema in sync, which conditions report progress, or how Keeper changes quorum membership safely.What
Adds a Scaling guide (
docs/guides/scaling.mdx, registered innavigation.json) covering: scaling ClickHouse replicas and shards, automatic schema sync on scale viaenableDatabaseSync(database replication on scale up,SYSTEM DROP DATABASE REPLICAcleanup on scale down), the status conditions to watch (ClusterSizeAligned,SchemaInSync,Ready), and quorum-safe one-member-at-a-timeKeeperClusterscaling (ScaleAllowed)