File: option_max_size.md

package info (click to toggle)
elasticsearch-curator 8.0.21-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,716 kB
  • sloc: python: 17,838; makefile: 159; sh: 156
file content (25 lines) | stat: -rw-r--r-- 1,024 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
---
mapped_pages:
  - https://www.elastic.co/guide/en/elasticsearch/client/curator/current/option_max_size.html
---

# max_size [option_max_size]

```yaml
action: rollover
description: >-
  Rollover the index associated with alias 'aliasname', which should be in the
  form of prefix-000001 (or similar), or prefix-yyyy.MM.DD-1.
options:
  name: aliasname
  conditions:
    max_size: 5gb
```

::::{note}
At least one of [max_age](/reference/option_max_age.md), [max_docs](/reference/option_max_docs.md), max_size or any combinations of the three are required as `conditions:` for the [Rollover](/reference/rollover.md) action.
::::


The maximum approximate size an index is allowed to be before triggering a rollover.  Sizes must use Elasticsearch approved [human-readable byte units](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/common-options.md). It *must* be nested under `conditions:` There is no default value.  If this condition is specified, it must have a value, or Curator will generate an error.