Skip to content

Commit ebb2141

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 821838d commit ebb2141

File tree

3 files changed

+5
-7
lines changed

3 files changed

+5
-7
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 & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8015,7 +8015,6 @@ endif::[]
80158015

80168016
// end::redpanda-cloud[]
80178017

8018-
// tag::redpanda-cloud[]
80198018
=== iceberg_rest_catalog_aws_credentials_source
80208019

80218020
*Accepted values*: `aws_instance_metadata`, `azure_aks_oidc_federation`, `azure_vm_instance_metadata`, `config_file`, `gcp_instance_metadata`, `sts`.
@@ -8076,7 +8075,6 @@ endif::[]
80768075

80778076
|===
80788077

8079-
// end::redpanda-cloud[]
80808078

80818079
// tag::redpanda-cloud[]
80828080
=== iceberg_rest_catalog_aws_region
@@ -11509,9 +11507,9 @@ Mode of the leader balancer optimization strategy.
1150911507

1151011508
Accepted values:
1151111509

11512-
* `calibrated`: Balances leaders based on replica counts per shard using a calibrated heuristic.
11513-
* `random`: Randomly moves leaders to reduce load on heavily-loaded shards.
11514-
* `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.
1151511513

1151611514
Legacy values `greedy_balanced_shards` and `random_hill_climbing` are treated as `calibrated`.
1151711515

0 commit comments

Comments
 (0)