Skip to content

Commit 6aeb2b8

Browse files
committed
Reinstate missing documentation (#28781)
The documentation for settings index.routing.allocation.enable, index.routing.rebalance.enable and index.gc_deletes was lost in f123a53. This change reinstates it.
1 parent 64cee18 commit 6aeb2b8

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

docs/reference/docs/delete.asciidoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,14 @@ The result of the above delete operation is:
4040
[[delete-versioning]]
4141
=== Versioning
4242

43-
Each document indexed is versioned. When deleting a document, the
44-
`version` can be specified to make sure the relevant document we are
45-
trying to delete is actually being deleted and it has not changed in the
46-
meantime. Every write operation executed on a document, deletes included,
47-
causes its version to be incremented.
43+
Each document indexed is versioned. When deleting a document, the `version` can
44+
be specified to make sure the relevant document we are trying to delete is
45+
actually being deleted and it has not changed in the meantime. Every write
46+
operation executed on a document, deletes included, causes its version to be
47+
incremented. The version number of a deleted document remains available for a
48+
short time after deletion to allow for control of concurrent operations. The
49+
length of time for which a deleted document's version remains available is
50+
determined by the `index.gc_deletes` index setting and defaults to 60 seconds.
4851

4952
[float]
5053
[[delete-routing]]

docs/reference/index-modules.asciidoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,27 @@ specific index module:
183183
These listeners are used to implement <<docs-refresh,`refresh=wait_for`>>.
184184

185185

186+
`index.routing.allocation.enable`::
187+
188+
Controls shard allocation for this index. It can be set to:
189+
* `all` (default) - Allows shard allocation for all shards.
190+
* `primaries` - Allows shard allocation only for primary shards.
191+
* `new_primaries` - Allows shard allocation only for newly-created primary shards.
192+
* `none` - No shard allocation is allowed.
193+
194+
`index.routing.rebalance.enable`::
195+
196+
Enables shard rebalancing for this index. It can be set to:
197+
* `all` (default) - Allows shard rebalancing for all shards.
198+
* `primaries` - Allows shard rebalancing only for primary shards.
199+
* `replicas` - Allows shard rebalancing only for replica shards.
200+
* `none` - No shard rebalancing is allowed.
201+
202+
`index.gc_deletes`::
203+
204+
The length of time that a <<delete-versioning,deleted document's version number>> remains available for <<index-versioning,further versioned operations>>.
205+
Defaults to `60s`.
206+
186207
[float]
187208
=== Settings in other index modules
188209

0 commit comments

Comments
 (0)