Skip to content

Commit b475b28

Browse files
authored
Add documentation about ILM forcemerge with best_compression (#51893)
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
1 parent 6a7fb7b commit b475b28

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/reference/ilm/policy-definitions.asciidoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -300,12 +300,17 @@ most a specific number of <<indices-segments,segments>>.
300300
[options="header"]
301301
|======
302302
| Name | Required | Default | Description
303-
| `max_num_segments` | yes | - | The number of
304-
segments to merge to.
305-
To fully merge the
306-
index, set it to `1`
303+
| `max_num_segments` | yes | - | The number of segments to merge to. To fully merge the index, set it to `1`
304+
| `codec` | no | - | Optional specification of the `best_compression` codec
307305
|======
308306

307+
[WARNING]
308+
======
309+
When using the `"codec": "best_compression"` configuration in the ILM forcemerge action, ILM will
310+
<<indices-close,close>> and then <<indices-open-close,re-open>> the index prior to a forcemerge.
311+
During this time the index will be unavailable for either read or write operations.
312+
======
313+
309314
[source,console]
310315
--------------------------------------------------
311316
PUT _ilm/policy/my_policy

0 commit comments

Comments
 (0)