- Curator Index Management:
- About
- Versions
- Installation
- Running Curator
- Configuration
- Actions
- Options
- allocation_type
- continue_if_exception
- count
- delay
- delete_aliases
- disable_action
- extra_settings
- ignore_empty_list
- ignore_unavailable
- include_aliases
- include_global_state
- indices
- key
- max_age
- max_docs
- max_num_segments
- max_wait
- migration_prefix
- migration_suffix
- name
- partial
- preserve_existing
- refresh
- remote_aws_key
- remote_aws_region
- remote_aws_secret_key
- remote_certificate
- remote_client_cert
- remote_client_key
- remote_filters
- remote_ssl_no_validate
- remote_url_prefix
- rename_pattern
- rename_replacement
- repository
- requests_per_second
- request_body
- retry_count
- retry_interval
- routing_type
- setting
- slices
- skip_repo_fs_check
- timeout
- timeout_override
- value
- wait_for_active_shards
- wait_for_completion
- wait_interval
- warn_if_no_indices
- Filters
- Filter Elements
- Examples
- Security
- Frequently Asked Questions
- Q: How can I report an error in the documentation?
- Q: Can I delete only certain data from within indices?
- Q: Can Curator handle index names with strange characters?
- Q: I’m getting
DistributionNotFound
andentry_point
errors when I try to run Curator. What am I doing wrong? - Q: Why doesn’t Curator work with AWS Elasticsearch?
- Q: Why am I getting an error message about ASCII encoding?
A newer version is available. For the latest information, see the
current release documentation.
Action File
editAction File
editYou can use environment variables in your configuration files.
An action file has the following structure:
--- # Remember, leave a key empty if there is no value. None will be a string, # not a Python "NoneType" # # Also remember that all examples have 'disable_action' set to True. If you # want to use this action as a template, be sure to set this to False after # copying it. actions: 1: action: ACTION1 description: OPTIONAL DESCRIPTION options: option1: value1 ... optionN: valueN continue_if_exception: False disable_action: True filters: - filtertype: *first* filter_element1: value1 ... filter_elementN: valueN - filtertype: *second* filter_element1: value1 ... filter_elementN: valueN 2: action: ACTION2 description: OPTIONAL DESCRIPTION options: option1: value1 ... optionN: valueN continue_if_exception: False disable_action: True filters: - filtertype: *first* filter_element1: value1 ... filter_elementN: valueN - filtertype: *second* filter_element1: value1 ... filter_elementN: valueN 3: action: ACTION3 ... 4: action: ACTION4 ...
It is a YAML configuration file. The root key must be actions
, after which
there can be any number of actions, nested underneath numbers. Actions will be
taken in the order they are completed.
The high-level elements of each numbered action are:
In the case of the alias action, there are two additional high-level
elements: add
and remove
, which are described in the alias action
documentation.
description
editThis is an optional description which can help describe what the action and its filters are supposed to do.
description: >- I can make the description span multiple lines by putting ">-" at the beginning of the line, as seen above. Subsequent lines must also be indented. options: option1: ...
On this page
Was this helpful?
Thank you for your feedback.