Skip to content

Commit

Permalink
Removing wording indicating that read-only index block is released au…
Browse files Browse the repository at this point in the history
…tomatically. (#62627)
  • Loading branch information
Adam Locke authored Oct 2, 2020
1 parent e4e4aab commit 509507d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
15 changes: 8 additions & 7 deletions docs/reference/index-modules.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -156,13 +156,14 @@ specific index module:

`index.blocks.read_only_allow_delete`::

Similar to `index.blocks.read_only`, but also allows deleting the index to
make more resources available. The <<disk-allocator,disk-based shard
allocator>> may add and remove this block automatically.

Deleting documents from an index to release resources - rather than deleting the index itself - can increase the index size over time. When `index.blocks.read_only_allow_delete` is set to `true`, deleting documents is not permitted. However, deleting the index itself releases the read-only index block and makes resources available almost immediately.

IMPORTANT: {es} adds and removes the read-only index block automatically when the disk utilization falls below the high watermark, controlled by <<cluster-routing-flood_stage,cluster.routing.allocation.disk.watermark.flood_stage>>.
Similar to `index.blocks.read_only`, but also allows deleting the index to
make more resources available.
+
Deleting documents from an index to release resources - rather than deleting
the index itself - can increase the index size over time. When
`index.blocks.read_only_allow_delete` is set to `true`, deleting documents is
not permitted. However, deleting the index itself releases the read-only index
block and makes resources available almost immediately.

`index.blocks.read`::

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/modules/cluster/disk_allocator.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Controls the flood stage watermark, which defaults to 95%. {es} enforces a read-
(`index.blocks.read_only_allow_delete`) on every index that has one or more
shards allocated on the node, and that has at least one disk exceeding the flood
stage. This setting is a last resort to prevent nodes from running out of disk space.
The index block is automatically released when the disk utilization falls below
The index block must be released manually when the disk utilization falls below
the high watermark.

NOTE: You cannot mix the usage of percentage values and byte values within
Expand Down

0 comments on commit 509507d

Please # to comment.