-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Add documentation for tracking progress of Cruise Control rebalances. #11529
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
50 changes: 50 additions & 0 deletions
50
documentation/modules/cruise-control/proc-tracking-cluster-rebalance.adoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // assembly-cruise-control-concepts.adoc | ||
|
|
||
| [id='proc-tracking-cluster-rebalance-{context}'] | ||
|
|
||
| = Tracking rebalances | ||
|
|
||
| You can track the progress of a partition rebalance using status information in the `KafkaRebalance` resource. | ||
| Tracking an active partition rebalance supports planning of cluster operations, including worker node maintenance, scaling, and broker upgrades. | ||
| Understanding key details, such as duration and the remaining data to transfer, helps with scheduling maintenance windows and assessing the impact of proceeding or canceling the rebalance. | ||
|
|
||
| When a rebalance is in progress, Strimzi stores progress information in a `ConfigMap`. | ||
| The `ConfigMap` is referenced by the `status.progress.rebalanceProgressConfigMap` property of the `KafkaRebalance` resource and has the same name as the `KafkaRebalance` resource. | ||
| The `ConfigMap` includes the following fields: | ||
|
|
||
| - `estimatedTimeToCompletionInMinutes`: The estimated time it will take in minutes until the partition rebalance is complete. | ||
|
|
||
| - `completedByteMovementPercentage`: The percentage of data movement completed (in bytes), as a rounded down integer from 0-100. | ||
|
|
||
| - `executorState.json`: The “non-verbose” JSON payload from the link:https://github.com/linkedin/cruise-control/wiki/REST-APIs#query-the-state-of-cruise-control[/kafkacruisecontrol/state?substates=executor] endpoint, providing details about the executor's current status, including partition movement progress, concurrency limits, and total data to move. | ||
|
|
||
| The information is updated on each reconciliation of the `KafkaRebalance` resource. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * The `KafkaRebalance` custom resource is in a `Rebalancing` state. | ||
|
|
||
| .Procedure | ||
|
|
||
| - Accessing `estimatedTimeToCompletionInMinutes` field.: | ||
| + | ||
| [source,shell] | ||
| ---- | ||
| kubectl get configmaps <my_rebalance> -o jsonpath="{['data']['estimatedTimeToCompletionInMinutes']}" | ||
| ---- | ||
|
|
||
| - Accessing `completedByteMovementPercentage` field.: | ||
| + | ||
| [source,shell] | ||
| ---- | ||
| kubectl get configmaps <my_rebalance> -o jsonpath="{['data']['completedByteMovementPercentage']}" | ||
| ---- | ||
|
|
||
| - Accessing `executorState.json` field. | ||
| + | ||
| [source,shell] | ||
| ---- | ||
| kubectl get configmaps <my_rebalance> -o jsonpath="{['data']['executorState.json']}" | ||
| ---- | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.