Skip to content

Commit

Permalink
Add documentation about ILM forcemerge with best_compression (#51893)
Browse files Browse the repository at this point in the history
This adds the option to the parameter list and a warning about the index being unavailable during
the close and open operations.

Relates to #49974
  • Loading branch information
dakrone committed Feb 5, 2020
1 parent d0865b9 commit f8c8a10
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/reference/ilm/policy-definitions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -300,12 +300,17 @@ most a specific number of <<indices-segments,segments>>.
[options="header"]
|======
| Name | Required | Default | Description
| `max_num_segments` | yes | - | The number of
segments to merge to.
To fully merge the
index, set it to `1`
| `max_num_segments` | yes | - | The number of segments to merge to. To fully merge the index, set it to `1`
| `codec` | no | - | Optional specification of the `best_compression` codec
|======

[WARNING]
======
When using the `"codec": "best_compression"` configuration in the ILM forcemerge action, ILM will
<<indices-close,close>> and then <<indices-open-close,re-open>> the index prior to a forcemerge.
During this time the index will be unavailable for either read or write operations.
======

[source,console]
--------------------------------------------------
PUT _ilm/policy/my_policy
Expand Down

0 comments on commit f8c8a10

Please sign in to comment.