Skip to content

Commit 3ff1f37

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 e142f34 commit 3ff1f37

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
@@ -39,11 +39,14 @@ The result of the above delete operation is:
3939
[[delete-versioning]]
4040
=== Versioning
4141

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

4851
[float]
4952
[[delete-routing]]

docs/reference/index-modules.asciidoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,27 @@ specific index module:
193193
The maximum number of terms that can be used in Terms Query.
194194
Defaults to `65536`.
195195

196+
`index.routing.allocation.enable`::
197+
198+
Controls shard allocation for this index. It can be set to:
199+
* `all` (default) - Allows shard allocation for all shards.
200+
* `primaries` - Allows shard allocation only for primary shards.
201+
* `new_primaries` - Allows shard allocation only for newly-created primary shards.
202+
* `none` - No shard allocation is allowed.
203+
204+
`index.routing.rebalance.enable`::
205+
206+
Enables shard rebalancing for this index. It can be set to:
207+
* `all` (default) - Allows shard rebalancing for all shards.
208+
* `primaries` - Allows shard rebalancing only for primary shards.
209+
* `replicas` - Allows shard rebalancing only for replica shards.
210+
* `none` - No shard rebalancing is allowed.
211+
212+
`index.gc_deletes`::
213+
214+
The length of time that a <<delete-versioning,deleted document's version number>> remains available for <<index-versioning,further versioned operations>>.
215+
Defaults to `60s`.
216+
196217
[float]
197218
=== Settings in other index modules
198219

0 commit comments

Comments
 (0)