Cluster Routing

edit
action: cluster_routing
description: "Apply routing rules to the entire cluster"
options:
  routing_type:
  value: ...
  setting: enable

Empty values and commented lines will result in the default value, if any, being selected. If a setting is set, but not used by a given action, it will be ignored.

This action changes the shard routing allocation for the selected indices.

See http://www.elastic.co/guide/en/elasticsearch/reference/8.14/shards-allocation.html for more information.

You can optionally set wait_for_completion to True to have Curator wait for the shard routing to complete before continuing:

action: cluster_routing
description: "Apply routing rules to the entire cluster"
options:
  routing_type:
  value: ...
  setting: enable
  wait_for_completion: True
  max_wait: 300
  wait_interval: 10

This configuration will wait for a maximum of 300 seconds for shard routing and reallocation to complete before giving up. A max_wait value of -1 will wait indefinitely. Curator will poll for completion at 10 second intervals, as defined by wait_interval.

Required settings

edit
  • routing_type
  • value
  • setting Currently must be set to enable. This setting is a placeholder for potential future expansion.