Skip to content

Commit af0278b

Browse files
nik9000dakrone
authored andcommitted
[Docs] Allocation setting explanation
Closes #5748
1 parent 9aa1cb4 commit af0278b

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

docs/reference/cluster/update-settings.asciidoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,22 +65,32 @@ There is a specific list of settings that can be updated, those include:
6565

6666
[float]
6767
===== Balanced Shards
68+
All these values are relative to one another. The first three are used to
69+
compose a three separate weighting functions into one. The cluster is balanced
70+
when no allowed action can bring the weights of each node closer together by
71+
more then the fourth setting. Actions might not be allowed, for instance,
72+
due to forced awareness or allocation filtering.
6873

6974
`cluster.routing.allocation.balance.shard`::
70-
Defines the weight factor for shards allocated on a node
71-
(float). Defaults to `0.45f`.
75+
Defines the weight factor for shards allocated on a node
76+
(float). Defaults to `0.45f`. Raising this raises the tendency to
77+
equalize the number of shards across all nodes in the cluster.
7278

7379
`cluster.routing.allocation.balance.index`::
74-
Defines a factor to the number of shards per index allocated
75-
on a specific node (float). Defaults to `0.5f`.
80+
Defines a factor to the number of shards per index allocated
81+
on a specific node (float). Defaults to `0.5f`. Raising this raises the
82+
tendency to equalize the number of shards per index across all nodes in
83+
the cluster.
7684

7785
`cluster.routing.allocation.balance.primary`::
78-
defines a weight factor for the number of primaries of a specific index
79-
allocated on a node (float). `0.05f`.
86+
Defines a weight factor for the number of primaries of a specific index
87+
allocated on a node (float). `0.05f`. Raising this raises the tendency
88+
to equalize the number of primary shards across all nodes in the cluster.
8089

8190
`cluster.routing.allocation.balance.threshold`::
82-
minimal optimization value of operations that should be performed (non
83-
negative float). Defaults to `1.0f`.
91+
Minimal optimization value of operations that should be performed (non
92+
negative float). Defaults to `1.0f`. Raising this will cause the cluster
93+
to be less aggressive about optimizing the shard balance.
8494

8595
[float]
8696
===== Concurrent Rebalance

0 commit comments

Comments
 (0)