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.

When choosing conditions, any one of max_age, max_docs, max_size, or any combination of the three may be used. If multiple are used, then the specified condition for any one of them must be matched for the rollover to occur.

If one or more of the max_age, max_docs, or max_size options are present, they must each have a value. Because there are no default values, none of these conditions can be left empty, or Curator will generate an error.

Extra settings

edit

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

Required settings

edit

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 Only supported in Elasticsearch 6.1.0 and up. 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.

Optional settings

edit

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

See an example of this action in an actionfile here.

« Restore Shrink »