- Curator Index Management:
- About
- Versions
- Installation
- Running Curator
- Configuration
- Actions
- Options
- allocation_type
- continue_if_exception
- copy_aliases
- count
- delay
- delete_after
- 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
- node_filters
- number_of_replicas
- number_of_shards
- partial
- post_allocation
- 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
- shrink_node
- shrink_prefix
- shrink_suffix
- 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
- 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
- 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?
Environment Variables
editEnvironment Variables
editThis functionality is experimental and may be changed or removed
completely in a future release.
You can use environment variable references in the both the configuration file and the action file to set values that need to be configurable at runtime. To do this, use:
${VAR}
Where VAR
is the name of the environment variable.
Each variable reference is replaced at startup by the value of the environment
variable. The replacement is case-sensitive and occurs while the YAML file is
parsed, but before configuration schema validation. References to undefined
variables are replaced by None
unless you specify a default value. To specify
a default value, use:
${VAR:default_value}
Where default_value
is the value to use if the environment variable is
undefined.
Unsupported use cases
When using environment variables, the value must only be the environment variable.
Using extra text, such as:
logfile: ${LOGPATH}/extra/path/information/file.log
is not supported at this time.
Examples
editHere are some examples of configurations that use environment variables and what each configuration looks like after replacement:
Config source | Environment setting | Config after replacement |
---|---|---|
|
|
|
|
no setting |
|
|
no setting |
|
|
|
|
On this page