Skip to content

Commit

Permalink
docs(refactor): updates the cruise control rebalance concepts (strimz…
Browse files Browse the repository at this point in the history
…i#10810)

Signed-off-by: prmellor <pmellor@redhat.com>
  • Loading branch information
PaulRMellor authored Nov 15, 2024
1 parent 686bbed commit 849ffe0
Show file tree
Hide file tree
Showing 13 changed files with 550 additions and 668 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,25 @@
[id='cruise-control-concepts-{context}']
= Using Cruise Control for cluster rebalancing

include::../../modules/cruise-control/con-cruise-control-description.adoc[leveloffset=+1]
[role="_abstract"]
Cruise Control is an open-source application designed to run alongside Kafka to help optimize use of cluster resources by doing the following:

NOTE: Strimzi provides xref:config-examples-{context}[example configuration files for Cruise Control].
* Monitoring cluster workload
* Rebalancing partitions based on predefined constraints

include::../../modules/cruise-control/con-cruise-control-overview.adoc[leveloffset=+1]
Cruise Control operations help with running a more balanced Kafka cluster that uses brokers more efficiently.

include::../../modules/cruise-control/con-optimization-goals.adoc[leveloffset=+1]
As Kafka clusters evolve, some brokers may become overloaded while others remain underutilized.
Cruise Control addresses this imbalance by modeling resource utilization at the replica level--including, CPU, disk, network load--and generating optimization proposals (which you can approve or reject) for balanced partition assignments based on configurable optimization goals.

include::../../modules/cruise-control/con-optimization-proposals.adoc[leveloffset=+1]
Optimization proposals are configured and generated using a `KafkaRebalance` resource.
You can configure the resource using an annotation so that optimization proposals are approved automatically or manually.

include::../../modules/cruise-control/con-rebalance-performance.adoc[leveloffset=+1]
NOTE: Strimzi provides xref:config-examples-{context}[example configuration files for Cruise Control].

//overview and concepts
include::../../modules/cruise-control/con-cruise-control-overview.adoc[leveloffset=+1]
include::../../modules/cruise-control/con-rebalance-performance.adoc[leveloffset=+2]

include::../../modules/cruise-control/proc-configuring-deploying-cruise-control.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion documentation/modules/configuring/con-config-examples.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ examples
<7> `Kafka` and `KafkaNodePool` configurations for a deployment of Kafka clusters that use KRaft (Kafka Raft metadata) mode.
<8> `Kafka` and `KafkaRebalance` configurations for deploying and using Cruise Control to manage clusters.
`Kafka` configuration examples enable auto-rebalancing on scaling events and set default optimization goals.
`KakaRebalance` configuration examples set user-provided optimization goals and generate optimization proposals in various supported modes.
`KakaRebalance` configuration examples set proposal-specific optimization goals and generate optimization proposals in various supported modes.
<9> `KafkaConnect` and `KafkaConnector` custom resource configuration for a deployment of Kafka Connect. Includes example configurations for a single or multi-node deployment.
<10> `KafkaBridge` custom resource configuration for a deployment of Kafka Bridge.

This file was deleted.

Loading

0 comments on commit 849ffe0

Please sign in to comment.