org.elasticsearch.cluster.routing.allocation.decider

Class EnableAllocationDecider

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

org.elasticsearch.cluster.routing.allocation.decider.EnableAllocationDecider

All Implemented Interfaces:

NodeSettingsService.Listener

public class EnableAllocationDecider
extends AllocationDecider
implements NodeSettingsService.Listener

This allocation decider allows shard allocations / rebalancing via the cluster wide settings CLUSTER_ROUTING_ALLOCATION_ENABLE / CLUSTER_ROUTING_REBALANCE_ENABLE and the per index setting INDEX_ROUTING_ALLOCATION_ENABLE / INDEX_ROUTING_REBALANCE_ENABLE. The per index settings overrides the cluster wide setting.

Allocation settings can have the following values (non-casesensitive):

• NONE - no shard allocation is allowed.
• NEW_PRIMARIES - only primary shards of new indices are allowed to be allocated
• PRIMARIES - only primary shards are allowed to be allocated
• ALL - all shards are allowed to be allocated

Rebalancing settings can have the following values (non-casesensitive):

• NONE - no shard rebalancing is allowed.
• REPLICAS - only replica shards are allowed to be balanced
• PRIMARIES - only primary shards are allowed to be balanced
• ALL - all shards are allowed to be balanced

See Also:

EnableAllocationDecider.Rebalance, EnableAllocationDecider.Allocation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnableAllocationDecider.Allocation Allocation values or rather their string representation to be used used with CLUSTER_ROUTING_ALLOCATION_ENABLE / INDEX_ROUTING_ALLOCATION_ENABLE via cluster / index settings.
static class	EnableAllocationDecider.Rebalance Rebalance values or rather their string representation to be used used with CLUSTER_ROUTING_REBALANCE_ENABLE / INDEX_ROUTING_REBALANCE_ENABLE via cluster / index settings.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_ROUTING_ALLOCATION_ENABLE
static String	CLUSTER_ROUTING_REBALANCE_ENABLE
static String	INDEX_ROUTING_ALLOCATION_ENABLE
static String	INDEX_ROUTING_REBALANCE_ENABLE
static String	NAME

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
EnableAllocationDecider(Settings settings, NodeSettingsService nodeSettingsService)

Method Summary

Methods

Modifier and Type	Method and Description
Decision	canAllocate(ShardRouting shardRouting, RoutingNode node, RoutingAllocation allocation) Returns a Decision whether the given shard routing can be allocated on the given node.
Decision	canRebalance(ShardRouting shardRouting, RoutingAllocation allocation) Returns a Decision whether the given shard routing can be re-balanced to the given allocation.
void	onRefreshSettings(Settings settings)

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

canAllocate, canAllocate, canAllocate, canRebalance, canRemain

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

CLUSTER_ROUTING_ALLOCATION_ENABLE

public static final String CLUSTER_ROUTING_ALLOCATION_ENABLE

See Also:

Constant Field Values

INDEX_ROUTING_ALLOCATION_ENABLE

public static final String INDEX_ROUTING_ALLOCATION_ENABLE

See Also:

Constant Field Values

CLUSTER_ROUTING_REBALANCE_ENABLE

public static final String CLUSTER_ROUTING_REBALANCE_ENABLE

See Also:

Constant Field Values

INDEX_ROUTING_REBALANCE_ENABLE

public static final String INDEX_ROUTING_REBALANCE_ENABLE

See Also:

Constant Field Values

Constructor Detail

EnableAllocationDecider

@Inject
public EnableAllocationDecider(Settings settings,
                              NodeSettingsService nodeSettingsService)

Method Detail

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

canRebalance

public Decision canRebalance(ShardRouting shardRouting,
                    RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether the given shard routing can be re-balanced to the given allocation. The default is Decision.ALWAYS.

Overrides:

canRebalance in class AllocationDecider

onRefreshSettings

public void onRefreshSettings(Settings settings)

Specified by:

onRefreshSettings in interface NodeSettingsService.Listener