Skip to content

Commit 1424d58

Browse files
committed
docs: Improve leader_balancer_mode guidance
Update description to help users choose between calibrated, random, and greedy modes with clearer guidance on when to use each option.
1 parent 247108d commit 1424d58

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs-data/property-overrides.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1297,7 +1297,7 @@
12971297
"config_scope": "cluster"
12981298
},
12991299
"leader_balancer_mode": {
1300-
"description": "Mode of the leader balancer optimization strategy.\n\nAccepted values:\n\n* `calibrated`: Balances leaders based on replica counts per shard using a calibrated heuristic.\n* `random`: Randomly moves leaders to reduce load on heavily-loaded shards.\n* `greedy`: A topic-aware strategy that distributes each topic's leadership evenly across all brokers. Pre-calculates the target distribution for consistent, reproducible results across runs. Useful for benchmarking or production environments where predictable leader distribution matters.\n\nLegacy values `greedy_balanced_shards` and `random_hill_climbing` are treated as `calibrated`.",
1300+
"description": "Mode of the leader balancer optimization strategy.\n\nAccepted values:\n\n* `calibrated` (default): An adaptive strategy that samples potential moves and prioritizes high-impact transfers. Minimizes unnecessary leader movement while achieving balance over time. Best for most production workloads.\n* `random`: Accepts the first random move that improves balance. Less efficient than `calibrated` because it doesn't prioritize high-impact moves. Kept for legacy compatibility.\n* `greedy`: A topic-aware strategy that pre-calculates the entire target distribution before making moves. Each topic is independently balanced across all brokers. Produces deterministic, reproducible results given the same input. Best for benchmarking or environments requiring predictable leader placement. May move more leaders than other modes to reach its target state.\n\nLegacy values `greedy_balanced_shards` and `random_hill_climbing` are treated as `calibrated`.",
13011301
"config_scope": "cluster"
13021302
},
13031303
"leader_balancer_mute_timeout": {

modules/reference/attachments/redpanda-properties-v26.1.2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8700,7 +8700,7 @@
87008700
"config_scope": "cluster",
87018701
"default": "calibrated",
87028702
"defined_in": "src/v/config/configuration.cc",
8703-
"description": "Mode of the leader balancer optimization strategy.\n\nAccepted values:\n\n* `calibrated`: Balances leaders based on replica counts per shard using a calibrated heuristic.\n* `random`: Randomly moves leaders to reduce load on heavily-loaded shards.\n* `greedy`: A topic-aware strategy that distributes each topic's leadership evenly across all brokers. Pre-calculates the target distribution for consistent, reproducible results across runs. Useful for benchmarking or production environments where predictable leader distribution matters.\n\nLegacy values `greedy_balanced_shards` and `random_hill_climbing` are treated as `calibrated`.",
8703+
"description": "Mode of the leader balancer optimization strategy.\n\nAccepted values:\n\n* `calibrated` (default): An adaptive strategy that samples potential moves and prioritizes high-impact transfers. Minimizes unnecessary leader movement while achieving balance over time. Best for most production workloads.\n* `random`: Accepts the first random move that improves balance. Less efficient than `calibrated` because it doesn't prioritize high-impact moves. Kept for legacy compatibility.\n* `greedy`: A topic-aware strategy that pre-calculates the entire target distribution before making moves. Each topic is independently balanced across all brokers. Produces deterministic, reproducible results given the same input. Best for benchmarking or environments requiring predictable leader placement. May move more leaders than other modes to reach its target state.\n\nLegacy values `greedy_balanced_shards` and `random_hill_climbing` are treated as `calibrated`.",
87048704
"enum": [
87058705
"calibrated",
87068706
"random",

modules/reference/partials/properties/cluster-properties.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11507,9 +11507,9 @@ Mode of the leader balancer optimization strategy.
1150711507

1150811508
Accepted values:
1150911509

11510-
* `calibrated`: Balances leaders based on replica counts per shard using a calibrated heuristic.
11511-
* `random`: Randomly moves leaders to reduce load on heavily-loaded shards.
11512-
* `greedy`: A topic-aware strategy that distributes each topic's leadership evenly across all brokers. Pre-calculates the target distribution for consistent, reproducible results across runs. Useful for benchmarking or production environments where predictable leader distribution matters.
11510+
* `calibrated` (default): An adaptive strategy that samples potential moves and prioritizes high-impact transfers. Minimizes unnecessary leader movement while achieving balance over time. Best for most production workloads.
11511+
* `random`: Accepts the first random move that improves balance. Less efficient than `calibrated` because it doesn't prioritize high-impact moves. Kept for legacy compatibility.
11512+
* `greedy`: A topic-aware strategy that pre-calculates the entire target distribution before making moves. Each topic is independently balanced across all brokers. Produces deterministic, reproducible results given the same input. Best for benchmarking or environments requiring predictable leader placement. May move more leaders than other modes to reach its target state.
1151311513

1151411514
Legacy values `greedy_balanced_shards` and `random_hill_climbing` are treated as `calibrated`.
1151511515

0 commit comments

Comments
 (0)