Skip to content

[DOCS] Fix ILM force merge codec param #62243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 10, 2020
Merged

[DOCS] Fix ILM force merge codec param #62243

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3123f89
[DOCS] Fix ILM force merge codec param
jrodewig Sep 10, 2020
62c629e
better explanation of `best_compression`
jrodewig Sep 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/reference/ilm/actions/ilm-forcemerge.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ shards are relocating, in which case they will not be merged.
(Required, integer)
Number of segments to merge to. To fully merge the index, set to `1`.

`codec`::
(Optional, string)
Use the `best_compression` codec. Valid values: `best_compression`.
`index_codec`::
(Optional, string)
Codec used to compress the document store. The only accepted value is
`best_compression`, which uses {wikipedia}/DEFLATE[DEFLATE] for a higher
compression ratio but slower stored fields performance. To use the default LZ4
codec, omit this argument.
+
[WARNING]
======
Setting `"codec": "best_compression"` in the {ilm-init} forcemerge action causes {ilm-int} to
<<indices-close,close>> and then <<indices-open-close,re-open>> the index prior to the force merge.
During this time, the index is unavailable for both read and write operations.
======
WARNING: If using `best_compression`, {ilm-init} will <<indices-close,close>>
and then <<indices-open-close,re-open>> the index prior to the force merge.
While closed, the index will be unavailable for read or write operations.

[[ilm-forcemerge-action-ex]]
==== Example
Expand Down