Skip to content

Commit b427b3f

Browse files
authored
Expand docs on reset desired balance API (#106921) (#106985)
Explains its purpose and surrounding context a little more, including a note that this should never be necessary (i.e. if you find you need it, that's a bug).
1 parent 09751b9 commit b427b3f

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/reference/cluster/delete-desired-balance.asciidoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,13 @@
66

77
NOTE: {cloud-only}
88

9-
Resets the desired balance and starts a new computation from the current allocation.
10-
This API may be used if desired balance computation diverged from the current state
11-
and is trying to move too many shards.
9+
Discards the current desired balance and computes a new desired balance starting from the current allocation of shards.
10+
This can sometimes help {es} find a desired balance which needs fewer shard movements to achieve, especially if the
11+
cluster has experienced changes so substantial that the current desired balance is no longer optimal without {es} having
12+
detected that the current desired balance will take more shard movements to achieve than needed. However, this API
13+
imposes a heavy load on the elected master node and may not always have the expected effect. Calling this API should
14+
never be necessary. Consider instead <<shards-rebalancing-heuristics,increasing the value of
15+
`cluster.routing.allocation.balance.threshold`>> to avoid excessive shard movements.
1216

1317
[[delete-desired-balance-request]]
1418
==== {api-request-title}

0 commit comments

Comments
 (0)