Skip to content

Commit 338ba12

Browse files
committed
[DOCS] Clarify definition of max_size (elastic#56561)
1 parent ea2e798 commit 338ba12

File tree

3 files changed

+29
-30
lines changed

3 files changed

+29
-30
lines changed

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,24 @@ PUT my_index-000001
4343
You must specify at least one rollover condition.
4444
An empty rollover action is invalid.
4545

46-
`max_size`::
47-
(Optional, <<byte-units, byte units>>)
48-
Triggers roll over after the specified maximum primary shard index storage size is reached.
46+
`max_age`::
47+
(Optional, <<time-units, time units>>)
48+
Triggers roll over after the maximum elapsed time from index creation is reached.
4949

5050
`max_docs`::
5151
(Optional, integer)
5252
Triggers roll over after the specified maximum number of documents is reached.
5353
Documents added since the last refresh are not included in the document count.
5454
The document count does *not* include documents in replica shards.
5555

56-
`max_age`::
57-
(Optional, <<time-units, time units>>)
58-
Triggers roll over after the maximum elapsed time from index creation is reached.
56+
`max_size`::
57+
(Optional, <<byte-units, byte units>>)
58+
Triggers roll over when the index reaches a certain size.
59+
This is the total size of all primary shards in the index.
60+
Replicas are not counted toward the maximum index size.
61+
+
62+
TIP: To see the current index size, use the <<cat-indices, _cat indices>> API.
63+
The `pri.store.size` value shows the combined size of all primary shards.
5964

6065
[[ilm-rollover-ex]]
6166
==== Example

docs/reference/ilm/using-policies-rollover.asciidoc

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,17 @@
44
== Configure rollover
55
[[using-policies-rollover]]
66
You control when the rollover action is triggered by specifying one or more
7-
rollover parameters. The rollover is performed once any of the criteria are
8-
met. Because the criteria are checked periodically, the index might grow
9-
slightly beyond the specified threshold. To control how often the criteria are
10-
checked, specify the `indices.lifecycle.poll_interval` cluster setting.
7+
rollover criteria:
8+
9+
* Maximum size (the combined size of all primary shards in the index)
10+
* Maximum document count
11+
* Maximum age
12+
13+
The rollover is performed once any of the criteria are met.
14+
Because the criteria are checked periodically, the index might grow
15+
slightly beyond the specified threshold.
16+
To control how often the criteria are checked,
17+
specify the `indices.lifecycle.poll_interval` cluster setting.
1118

1219
IMPORTANT: New indices created via rollover will not automatically inherit the
1320
policy used by the old index, and will not use any policy by default. Therefore,
@@ -16,24 +23,6 @@ it is highly recommended to apply the policy via
1623
setting, for your indices which specifies the policy you wish to use for each
1724
new index.
1825

19-
The rollover action takes the following parameters:
20-
21-
[[rollover-action-params]]
22-
.`rollover` Action Parameters
23-
[options="header"]
24-
|===
25-
|Name |Description
26-
|max_size |The maximum estimated size the primary shard of the index is allowed
27-
to grow to. Defaults to `null`. Optional.
28-
|max_docs |The maximum number of document the index should
29-
contain. Defaults to `null`. Optional.
30-
|max_age |The maximum age of the index. Defaults to `null`. Optional.
31-
|===
32-
33-
These parameters are used to determine when the index is considered "full" and
34-
a rollover should be performed. Where multiple criteria are defined the
35-
rollover operation will be performed once any of the criteria are met.
36-
3726
The following request defines a policy with a rollover action that triggers
3827
when the index size reaches 25GB. The old index is subsequently deleted after
3928
30 days.
@@ -127,7 +116,7 @@ the new index, enabling indexing to continue uninterrupted.
127116
[[skipping-rollover]]
128117
=== Skipping Rollover
129118

130-
The `index.lifecycle.indexing_complete` setting indicates to {ilm} whether this
119+
The `index.lifecycle.indexing_complete` setting indicates to {ilm-init} whether this
131120
index has already been rolled over. If it is set to `true`, that indicates that
132121
this index has already been rolled over and does not need to be rolled over
133122
again. Therefore, {ilm} will skip any Rollover Action configured in the

docs/reference/indices/rollover-index.asciidoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,12 @@ The document count does *not* include documents in replica shards.
145145

146146
`max_size`::
147147
(Optional, <<byte-units, byte units>>)
148-
Maximum estimated size of the primary shard of the index.
148+
Maximum index size.
149+
This is the total size of all primary shards in the index.
150+
Replicas are not counted toward the maximum index size.
151+
152+
TIP: To see the current index size, use the <<cat-indices, _cat indices>> API.
153+
The `pri.store.size` value shows the combined size of all primary shards.
149154
--
150155

151156
include::{docdir}/rest-api/common-parms.asciidoc[tag=mappings]

0 commit comments

Comments
 (0)