honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Lee Hinman 2020-02-05 09:37:12 -07:00 committed by Lee Hinman
parent d0865b963e
commit f8c8a10f05
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/reference/ilm/policy-definitions.asciidoc
View File

@ -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