Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing.allocation.decider

Class FilterAllocationDecider

java.lang.Object

org.elasticsearch.cluster.routing.allocation.decider.AllocationDecider

org.elasticsearch.cluster.routing.allocation.decider.FilterAllocationDecider

public class FilterAllocationDecider
extends AllocationDecider

This AllocationDecider control shard allocation by include and exclude filters via dynamic cluster and index routing settings.

This filter is used to make explicit decision on which nodes certain shard can / should be allocated. The decision if a shard can be allocated, must not be allocated or should be allocated is based on either cluster wide dynamic settings (cluster.routing.allocation.*) or index specific dynamic settings (index.routing.allocation.*). All of those settings can be changed at runtime via the cluster or the index update settings API.

Note: Cluster settings are applied first and will override index specific settings such that if a shard can be allocated according to the index routing settings it wont be allocated on a node if the cluster specific settings would disallow the allocation. Filters are applied in the following order:

1. required - filters required allocations. If any required filters are set the allocation is denied if the index is not in the set of required to allocate on the filtered node
2. include - filters "allowed" allocations. If any include filters are set the allocation is denied if the index is not in the set of include filters for the filtered node
3. exclude - filters "prohibited" allocations. If any exclude filters are set the allocation is denied if the index is in the set of exclude filters for the filtered node

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting.AffixSetting<List<String>>	CLUSTER_ROUTING_EXCLUDE_GROUP_SETTING
static final Setting.AffixSetting<List<String>>	CLUSTER_ROUTING_INCLUDE_GROUP_SETTING
static final Setting.AffixSetting<List<String>>	CLUSTER_ROUTING_REQUIRE_GROUP_SETTING
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
FilterAllocationDecider(Settings settings, ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method	Description
Decision	canAllocate(IndexMetadata indexMetadata, RoutingNode node, RoutingAllocation allocation)	Returns a Decision whether the given shard routing can be allocated at all at this state of the RoutingAllocation.
Decision	canAllocate(ShardRouting shardRouting, RoutingNode node, RoutingAllocation allocation)	Returns a Decision whether the given shard routing can be allocated on the given node.
Decision	canRemain(IndexMetadata indexMetadata, ShardRouting shardRouting, RoutingNode node, RoutingAllocation allocation)	Returns a Decision whether the given shard routing can be remain on the given node.
Decision	shouldAutoExpandToNode(IndexMetadata indexMetadata, DiscoveryNode node, RoutingAllocation allocation)	Returns a Decision whether shards of the given index should be auto-expanded to this node at this state of the RoutingAllocation.

Methods inherited from class org.elasticsearch.cluster.routing.allocation.decider.AllocationDecider

canAllocate, canAllocateReplicaWhenThereIsRetentionLease, canForceAllocateDuringReplace, canForceAllocatePrimary, canRebalance, canRebalance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

CLUSTER_ROUTING_REQUIRE_GROUP_SETTING

public static final Setting.AffixSetting<List<String>> CLUSTER_ROUTING_REQUIRE_GROUP_SETTING

CLUSTER_ROUTING_INCLUDE_GROUP_SETTING

public static final Setting.AffixSetting<List<String>> CLUSTER_ROUTING_INCLUDE_GROUP_SETTING

CLUSTER_ROUTING_EXCLUDE_GROUP_SETTING

public static final Setting.AffixSetting<List<String>> CLUSTER_ROUTING_EXCLUDE_GROUP_SETTING

Constructor Details

FilterAllocationDecider

public FilterAllocationDecider(Settings settings,
 ClusterSettings clusterSettings)

Method Details

canAllocate

public Decision canAllocate(ShardRouting shardRouting,
 RoutingNode node,
 RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether the given shard routing can be allocated on the given node. The default is Decision.ALWAYS.

Overrides:

canAllocate in class AllocationDecider

canAllocate

public Decision canAllocate(IndexMetadata indexMetadata,
 RoutingNode node,
 RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether the given shard routing can be allocated at all at this state of the RoutingAllocation. The default is Decision.ALWAYS.

Overrides:

canAllocate in class AllocationDecider

canRemain

public Decision canRemain(IndexMetadata indexMetadata,
 ShardRouting shardRouting,
 RoutingNode node,
 RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether the given shard routing can be remain on the given node. The default is Decision.ALWAYS.

Overrides:

canRemain in class AllocationDecider

shouldAutoExpandToNode

public Decision shouldAutoExpandToNode(IndexMetadata indexMetadata,
 DiscoveryNode node,
 RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether shards of the given index should be auto-expanded to this node at this state of the RoutingAllocation. The default is Decision.ALWAYS.

Overrides:

shouldAutoExpandToNode in class AllocationDecider