Skip to content

Commit 4b34f2a

Browse files
committed
Adds deprecation info for ILM rollover max_size
closes #1633 (docs-content repo) There already is a warning and tooltip in the Kibana UI advising users that the maximum index size is deprecated and that they should use the maximum primary shard size instead.
1 parent 6b0d534 commit 4b34f2a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/reference/elasticsearch/index-lifecycle-actions/ilm-rollover.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,13 @@ The index will roll over once any `max_*` condition is satisfied and all `min_*`
5757
`max_docs`
5858
: (Optional, integer) Triggers rollover after the specified maximum number of documents is reached. Documents added since the last refresh are not included in the document count. The document count does **not** include documents in replica shards.
5959

60-
`max_size`
60+
`max_size` {applies_to}`stack: deprecated`
6161
: (Optional, [byte units](/reference/elasticsearch/rest-apis/api-conventions.md#byte-units)) Triggers rollover when the index reaches a certain size. This is the total size of all primary shards in the index. Replicas are not counted toward the maximum index size.
6262

63+
:::{admonition} Deprecated
64+
The `max_size` rollover attribute will be removed in a future version. Use `max_primary_shard_size` instead.
65+
:::
66+
6367
::::{tip}
6468
To see the current index size, use the [_cat indices](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices) API. The `pri.store.size` value shows the combined size of all primary shards.
6569
::::

0 commit comments

Comments
 (0)