本地英文版地址: ../en/shard-allocation-filtering.html
Index-level shard allocation filteringedit
You can use shard allocation filters to control where Elasticsearch allocates shards of a particular index. These per-index filters are applied in conjunction with cluster-wide allocation filtering and allocation awareness.
Shard allocation filters can be based on custom node attributes or the built-in
_name
, _host_ip
, _publish_ip
, _ip
, _host
and _id
attributes.
Index lifecycle management uses filters based
on custom node attributes to determine how to reallocate shards when moving
between phases.
The cluster.routing.allocation
settings are dynamic, enabling live indices to
be moved from one set of nodes to another. Shards are only relocated if it is
possible to do so without breaking another routing constraint, such as never
allocating a primary and replica shard on the same node.
For example, you could use a custom node attribute to indicate a node’s performance characteristics and use shard allocation filtering to route shards for a particular index to the most appropriate class of hardware.
Enabling index-level shard allocation filteringedit
To filter based on a custom node attribute:
-
Specify the filter characteristics with a custom node attribute in each node’s
elasticsearch.yml
configuration file. For example, if you havesmall
,medium
, andbig
nodes, you could add asize
attribute to filter based on node size.node.attr.size: medium
You can also set custom attributes when you start a node:
`./bin/elasticsearch -Enode.attr.size=medium
-
Add a routing allocation filter to the index. The
index.routing.allocation
settings support three types of filters:include
,exclude
, andrequire
. For example, to tell Elasticsearch to allocate shards from thetest
index to eitherbig
ormedium
nodes, useindex.routing.allocation.include
:PUT test/_settings { "index.routing.allocation.include.size": "big,medium" }
If you specify multiple filters, all conditions must be satisfied for shards to be relocated. For example, to move the
test
index tobig
nodes inrack1
, you could specify:PUT test/_settings { "index.routing.allocation.include.size": "big", "index.routing.allocation.include.rack": "rack1" }
Index allocation filter settingsedit
-
index.routing.allocation.include.{attribute}
-
Assign the index to a node whose
{attribute}
has at least one of the comma-separated values. -
index.routing.allocation.require.{attribute}
-
Assign the index to a node whose
{attribute}
has all of the comma-separated values. -
index.routing.allocation.exclude.{attribute}
-
Assign the index to a node whose
{attribute}
has none of the comma-separated values.
The index allocation settings support the following built-in attributes:
|
Match nodes by node name |
|
Match nodes by host IP address (IP associated with hostname) |
|
Match nodes by publish IP address |
|
Match either |
|
Match nodes by hostname |
|
Match nodes by node id |
You can use wildcards when specifying attribute values, for example:
PUT test/_settings { "index.routing.allocation.include._ip": "192.168.2.*" }