Skip to content

Commit 28ac8c9

Browse files
authored
[DOCS] Clarify ILM rollup docs (#68223)
1 parent 290601f commit 28ac8c9

File tree

3 files changed

+28
-19
lines changed

3 files changed

+28
-19
lines changed

docs/reference/ilm/actions/ilm-rollup.asciidoc

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,16 @@ Phases allowed: hot, cold.
77
Aggregates an index's time series data and stores the results in a new read-only
88
index. For example, you can roll up hourly data into daily or weekly summaries.
99

10-
For more information about rollup, see the <<rollup-api, rollup action documentation>>
10+
For more information about rollup, see the <<rollup-api, rollup action documentation>>.
1111

1212
The name of the rolled up index will be the original index name of the managed index prefixed
1313
with `rollup-`.
1414

1515
[[ilm-rollup-options]]
16-
==== Rollup options
16+
==== Options
17+
1718
`config`::
18-
(Required, integer)
19+
(Required, object)
1920
The rollup configuration, a more detailed description of the
2021
rollup configuration specification can be found <<rollup-api-request-body,here>>.
2122

@@ -28,14 +29,14 @@ with the newly created rollup index.
2829
==== Example
2930

3031
[source,console]
31-
--------------------------------------------------
32+
----
3233
PUT _ilm/policy/my_policy
3334
{
3435
"policy": {
3536
"phases": {
3637
"cold": {
3738
"actions": {
38-
"rollup" : {
39+
"rollup": {
3940
"config": {
4041
"groups": {
4142
"date_histogram": {
@@ -44,7 +45,12 @@ PUT _ilm/policy/my_policy
4445
}
4546
},
4647
"metrics": [
47-
{ "field": "temperature", "metrics": [ "avg" ] }
48+
{
49+
"field": "temperature",
50+
"metrics": [
51+
"avg"
52+
]
53+
}
4854
]
4955
}
5056
}
@@ -53,4 +59,4 @@ PUT _ilm/policy/my_policy
5359
}
5460
}
5561
}
56-
--------------------------------------------------
62+
----

docs/reference/ilm/ilm-actions.asciidoc

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ Block write operations to the index.
2828
Remove the index as the write index for the rollover alias and
2929
start indexing to a new index.
3030

31+
ifdef::permanently-unreleased-branch[]
32+
<<ilm-rollup,Rollup>>::
33+
Aggregates an index's time series data and stores the results in a new read-only
34+
index. For example, you can roll up hourly data into daily or weekly summaries.
35+
endif::[]
36+
3137
<<ilm-searchable-snapshot, Searchable snapshot>>::
3238
beta:[]
3339
Take a snapshot of the managed index in the configured repository
@@ -47,27 +53,18 @@ Performed automatically before a rollover, shrink, or searchable snapshot action
4753
<<ilm-wait-for-snapshot,Wait for snapshot>>::
4854
Ensure that a snapshot exists before deleting the index.
4955

50-
ifdef::permanently-unreleased-branch[]
51-
52-
<<ilm-rollup,Rollup>>::
53-
Aggregates an index's time series data and stores the results in a new read-only
54-
index. For example, you can roll up hourly data into daily or weekly summaries.
55-
56-
endif::[]
57-
5856
include::actions/ilm-allocate.asciidoc[]
5957
include::actions/ilm-delete.asciidoc[]
6058
include::actions/ilm-forcemerge.asciidoc[]
6159
include::actions/ilm-freeze.asciidoc[]
6260
include::actions/ilm-migrate.asciidoc[]
6361
include::actions/ilm-readonly.asciidoc[]
6462
include::actions/ilm-rollover.asciidoc[]
63+
ifdef::permanently-unreleased-branch[]
64+
include::actions/ilm-rollup.asciidoc[]
65+
endif::[]
6566
include::actions/ilm-searchable-snapshot.asciidoc[]
6667
include::actions/ilm-set-priority.asciidoc[]
6768
include::actions/ilm-shrink.asciidoc[]
6869
include::actions/ilm-unfollow.asciidoc[]
6970
include::actions/ilm-wait-for-snapshot.asciidoc[]
70-
71-
ifdef::permanently-unreleased-branch[]
72-
include::actions/ilm-rollup.asciidoc[]
73-
endif::[]

docs/reference/ilm/ilm-index-lifecycle.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ the rollover criteria, it could be 20 minutes before the rollover is complete.
8686
- <<ilm-readonly,Read-Only>>
8787
- <<ilm-shrink,Shrink>>
8888
- <<ilm-forcemerge,Force Merge>>
89+
ifdef::permanently-unreleased-branch[]
90+
- <<ilm-rollup,Rollup>>
91+
endif::[]
8992
* Warm
9093
- <<ilm-set-priority,Set Priority>>
9194
- <<ilm-unfollow,Unfollow>>
@@ -100,6 +103,9 @@ the rollover criteria, it could be 20 minutes before the rollover is complete.
100103
- <<ilm-allocate,Allocate>>
101104
- <<ilm-migrate,Migrate>>
102105
- <<ilm-freeze,Freeze>>
106+
ifdef::permanently-unreleased-branch[]
107+
- <<ilm-rollup,Rollup>>
108+
endif::[]
103109
- <<ilm-searchable-snapshot, Searchable Snapshot>>
104110
* Delete
105111
- <<ilm-wait-for-snapshot,Wait For Snapshot>>

0 commit comments

Comments
 (0)