- Curator Index Management:
- Curator and Index Lifecycle Management
- About
- Versions
- Installation
- Running Curator
- Configuration
- Actions
- Options
- allocation_type
- allow_ilm_indices
- continue_if_exception
- copy_aliases
- count
- delay
- delete_after
- delete_aliases
- skip_flush
- disable_action
- extra_settings
- ignore_empty_list
- ignore_unavailable
- include_aliases
- include_global_state
- indices
- key
- max_age
- max_docs
- max_size
- max_num_segments
- max_wait
- migration_prefix
- migration_suffix
- name
- new_index
- node_filters
- number_of_replicas
- number_of_shards
- partial
- post_allocation
- preserve_existing
- refresh
- remote_certificate
- remote_client_cert
- remote_client_key
- remote_filters
- remote_url_prefix
- rename_pattern
- rename_replacement
- repository
- requests_per_second
- request_body
- retry_count
- retry_interval
- routing_type
- search_pattern
- setting
- shrink_node
- shrink_prefix
- shrink_suffix
- slices
- skip_repo_fs_check
- timeout
- timeout_override
- value
- wait_for_active_shards
- wait_for_completion
- wait_for_rebalance
- wait_interval
- warn_if_no_indices
- Filters
- Filter Elements
- aliases
- allocation_type
- count
- date_from
- date_from_format
- date_to
- date_to_format
- direction
- disk_space
- epoch
- exclude
- field
- intersect
- key
- kind
- max_num_segments
- pattern
- period_type
- range_from
- range_to
- reverse
- source
- state
- stats_result
- timestring
- threshold_behavior
- unit
- unit_count
- unit_count_pattern
- use_age
- value
- week_starts_on
- Examples
- Frequently Asked Questions
Rollover
editRollover
editaction: 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.
Extra settings
editThe 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 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.
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register nowWas this helpful?
Thank you for your feedback.