Skip to content

Commit 0e51482

Browse files
committed
Document 'max_size' parameter as shard size for rollover (#38750)
It was not clear that this is *primary* shard size, not the entire shard size. Resolves #37981
1 parent f0248db commit 0e51482

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

docs/reference/ilm/policy-definitions.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ existing index meets one of the rollover conditions.
352352
[options="header"]
353353
|======
354354
| Name | Required | Default | Description
355-
| `max_size` | no | - | max index storage size.
355+
| `max_size` | no | - | max primary shard index storage size.
356356
See <<byte-units, Byte Units>>
357357
for formatting
358358
| `max_docs` | no | - | max number of documents an

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ The rollover action takes the following parameters:
3333
.`rollover` Action Parameters
3434
|===
3535
|Name |Description
36-
|max_size |The maximum estimated size the index is allowed to grow
37-
to. Defaults to `null`. Optional.
36+
|max_size |The maximum estimated size the primary shard of the index is allowed
37+
to grow to. Defaults to `null`. Optional.
3838
|max_docs |The maximum number of document the index should
3939
contain. Defaults to `null`. Optional.
4040
|max_age |The maximum age of the index. Defaults to `null`. Optional.

docs/reference/indices/rollover-index.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,15 @@ from the original (rolled-over) index.
1818
In this scenario, the write index will have its rollover alias' `is_write_index` set to `false`, while the newly created index
1919
will now have the rollover alias pointing to it as the write index with `is_write_index` as `true`.
2020

21+
The available conditions are:
22+
23+
.`conditions` parameters
24+
|===
25+
| Name | Description
26+
| max_age | The maximum age of the index
27+
| max_docs | The maximum number of documents the index should contain. This does not add documents multiple times for replicas
28+
| max_size | The maximum estimated size of the primary shard of the index
29+
|===
2130

2231
[source,js]
2332
--------------------------------------------------

0 commit comments

Comments
 (0)