Skip to content

Commit eb3d184

Browse files
committed
Document woes between auto-expand-replicas and allocation filtering (#30531)
Relates to #2869
1 parent c4cbd6f commit eb3d184

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/reference/index-modules.asciidoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,14 @@ specific index module:
103103

104104
`index.auto_expand_replicas`::
105105

106-
Auto-expand the number of replicas based on the number of available nodes.
106+
Auto-expand the number of replicas based on the number of data nodes in the cluster.
107107
Set to a dash delimited lower and upper bound (e.g. `0-5`) or use `all`
108-
for the upper bound (e.g. `0-all`). Defaults to `false` (i.e. disabled).
108+
for the upper bound (e.g. `0-all`). Defaults to `false` (i.e. disabled).
109+
Note that the auto-expanded number of replicas does not take any other allocation
110+
rules into account, such as <<allocation-awareness,shard allocation awareness>>,
111+
<<shard-allocation-filtering,filtering>> or <<allocation-total-shards,total shards per node>>,
112+
and this can lead to the cluster health becoming `YELLOW` if the applicable rules
113+
prevent all the replicas from being allocated.
109114

110115
`index.refresh_interval`::
111116

0 commit comments

Comments
 (0)