Skip to content

Commit 612b7b1

Browse files
committed
Document new waiting on shards on index close
In 8.x the default for `?wait_for_active_shards` changes from `NONE` to `DEFAULT` on calls to `POST /index/_close`. This commit adds this change to the breaking changes docs. Relates elastic#66419, elastic#66542
1 parent 3819fcb commit 612b7b1

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/reference/migration/migrate_8_0/indices.asciidoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,18 @@ Discontinue use of the `index.translog.retention.age` and
102102
`index.translog.retention.size` index settings. Requests that
103103
include these settings will return an error.
104104
====
105+
106+
.The default for the `?wait_for_active_shards` parameter on the close index API has changed from `NONE` to `DEFAULT`.
107+
[%collapsible]
108+
====
109+
*Details* +
110+
When closing an index in earlier versions, by default {es} would not wait for
111+
the shards of the closed index to be properly assigned before returning. From
112+
version 8.0 onwards the default behaviour is to wait for shards to be assigned
113+
according to the <<index-wait-for-active-shards,index setting
114+
`index.write.wait_for_active_shards`>>.
115+
116+
*Impact* +
117+
Accept the new behaviour, or specify `?wait_for_active_shards=NONE` to preserve
118+
the old behaviour if needed.
119+
====

0 commit comments

Comments
 (0)