mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-08 05:58:44 +00:00
8a662c7e62
* [DOCS] Rework conceptual info for ILM. (#52181) * [DOCS] Rework conceptual info for ILM. * Split the actions out of concepts. * Added xpack role to actions. Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review * Edit actions for consistency and add action template. (#55632) * Edit actions for consistency and add action template. * Update docs/reference/ilm/actions/ilm-readonly.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review
53 lines
1.3 KiB
Plaintext
53 lines
1.3 KiB
Plaintext
[role="xpack"]
|
|
[[ilm-forcemerge]]
|
|
=== Force merge
|
|
|
|
Phases allowed: hot, warm.
|
|
|
|
<<indices-forcemerge,Force merges>> the index into
|
|
the specified maximum number of <<indices-segments,segments>>.
|
|
|
|
This action makes the index <<dynamic-index-settings,read-only>>.
|
|
|
|
To use the `forcemerge` action in the `hot` phase, the `rollover` action *must* be present.
|
|
If no rollover action is configured, {ilm-init} will reject the policy.
|
|
|
|
[[ilm-forcemerge-options]]
|
|
==== Options
|
|
|
|
`max_num_segments`::
|
|
(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`.
|
|
+
|
|
[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.
|
|
======
|
|
|
|
[[ilm-forcemerge-action-ex]]
|
|
==== Example
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ilm/policy/my_policy
|
|
{
|
|
"policy": {
|
|
"phases": {
|
|
"warm": {
|
|
"actions": {
|
|
"forcemerge" : {
|
|
"max_num_segments": 1
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|