Module org.elasticsearch.server
Interface ShardsAllocator
- All Known Implementing Classes:
BalancedShardsAllocator
,DesiredBalanceShardsAllocator
public interface ShardsAllocator
A ShardsAllocator
is the main entry point for shard allocation on nodes in the cluster.
The allocator makes basic decision where a shard instance will be allocated, if already allocated instances
need to relocate to other nodes due to node failures or due to rebalancing decisions.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
allocate
(RoutingAllocation allocation) Allocates shards to nodes in the cluster.default void
allocate
(RoutingAllocation allocation, ActionListener<Void> listener) Allocates shards to nodes in the cluster.decideShardAllocation
(ShardRouting shard, RoutingAllocation allocation) Returns the decision for where a shard should reside in the cluster.default RoutingExplanations
execute
(RoutingAllocation allocation, AllocationCommands commands, boolean explain, boolean retryFailed) Execute allocation commands
-
Method Details
-
allocate
Allocates shards to nodes in the cluster. An implementation of this method should: - assign unassigned shards - relocate shards that cannot stay on a node anymore - relocate shards to find a good shard balance in the cluster- Parameters:
allocation
- current node allocation
-
allocate
Allocates shards to nodes in the cluster. An implementation of this method should: - assign unassigned shards - relocate shards that cannot stay on a node anymore - relocate shards to find a good shard balance in the cluster- Parameters:
allocation
- current node allocationlistener
- listener to be executed once async allocation is completed
-
execute
default RoutingExplanations execute(RoutingAllocation allocation, AllocationCommands commands, boolean explain, boolean retryFailed) Execute allocation commands -
decideShardAllocation
Returns the decision for where a shard should reside in the cluster. If the shard is unassigned, then theAllocateUnassignedDecision
will be non-null. If the shard is not in the unassigned state, then theMoveDecision
will be non-null. This method is primarily used by the cluster allocation explain API to provide detailed explanations for the allocation of a single shard. Implementations of theallocate(RoutingAllocation)
method may use the results of this method implementation to decide on allocating shards in the routing table to the cluster. If an implementation of this interface does not support explaining decisions for a single shard through the cluster explain API, then this method should throw aUnsupportedOperationException
.
-