Rollover
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_age: 1d
max_docs: 1000000
max_size: 5gb
This action uses the Elasticsearch Rollover API to create a new index, if any of the described conditions are met.
Important
Warning
The extra_settings option allows the addition of extra index settings (but not mappings). An example of how these settings can be used might be:
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_age: 1d
max_docs: 1000000
extra_settings:
index.number_of_shards: 3
index.number_of_replicas: 1
timeout_override:
continue_if_exception: False
disable_action: False
- name The alias name
- max_age The maximum age that is allowed before triggering a rollover. This 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. - max_docs The maximum number of documents allowed in an index before triggering a rollover. This 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. - max_size The maximum size the index can be before a rollover is triggered. This 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.
- extra_settings No default value. You can add any acceptable index settings (not mappings) as nested YAML. See the Elasticsearch Create Index API documentation for more information.
- new_index Specify a new index name.
- timeout_override
- continue_if_exception
- disable_action
Tip
See an example of this action in an actionfile here.