Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.queuemanagement

Class GuaranteedOrZeroCapacityOverTimePolicy

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.queuemanagement.GuaranteedOrZeroCapacityOverTimePolicy

All Implemented Interfaces:

AutoCreatedQueueManagementPolicy

public class GuaranteedOrZeroCapacityOverTimePolicy
extends Object
implements AutoCreatedQueueManagementPolicy

Capacity Management policy for auto created leaf queues

Assigns capacity if available to leaf queues based on application submission order i.e leaf queues are assigned capacity in FCFS order based on application submission time. Updates leaf queue capacities to 0 when there are no pending or running apps under that queue.

Constructor Summary

Constructors

Constructor	Description
GuaranteedOrZeroCapacityOverTimePolicy()

Method Summary

Modifier and Type	Method	Description
void	commitQueueManagementChanges(List<QueueManagementChange> queueManagementChanges)	Commit queue management changes - which involves updating required state on parent/underlying leaf queues.
List<QueueManagementChange>	computeQueueManagementChanges()	Computes / adjusts child queue capacities for auto created leaf queues.
float	getAbsoluteActivatedChildQueueCapacity(String nodeLabel)
AutoCreatedLeafQueueConfig	getInitialLeafQueueConfiguration(AbstractAutoCreatedLeafQueue leafQueue)	Get initial template for the specified leaf queue.
boolean	hasPendingApps(AutoCreatedLeafQueue leafQueue)
void	init(AbstractParentQueue parentQueue)	Initialize policy.
boolean	isActive(AutoCreatedLeafQueue leafQueue, String nodeLabel)
void	reinitialize(AbstractParentQueue parentQueue)	Reinitialize policy state ( if required ).
void	updateTemplateAbsoluteCapacities(QueueCapacities queueCapacities)

Methods inherited from class java.lang.Object

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

Constructor Details

GuaranteedOrZeroCapacityOverTimePolicy

public GuaranteedOrZeroCapacityOverTimePolicy()

Method Details

init

public void init(AbstractParentQueue parentQueue)
          throws IOException

Description copied from interface: AutoCreatedQueueManagementPolicy

Initialize policy.

Specified by:

init in interface AutoCreatedQueueManagementPolicy

Parameters:

parentQueue - parent queue

Throws:

IOException - an I/O exception has occurred.

computeQueueManagementChanges

public List<QueueManagementChange> computeQueueManagementChanges()
                                                          throws SchedulerDynamicEditException

Computes / adjusts child queue capacities for auto created leaf queues. This method computes queue entitlements but does not update LeafQueueState or queue capacities. Scheduler calls commitQueueManagementChanges after validation after applying queue changes and commits to LeafQueueState are done in commitQueueManagementChanges.

Specified by:

computeQueueManagementChanges in interface AutoCreatedQueueManagementPolicy

Returns:

List of Queue Management change suggestions which could potentially be committed/rejected by the scheduler due to validation failures

Throws:

SchedulerDynamicEditException - when compute queueManagement changes fails.

updateTemplateAbsoluteCapacities

public void updateTemplateAbsoluteCapacities(QueueCapacities queueCapacities)

isActive

@VisibleForTesting
public boolean isActive(AutoCreatedLeafQueue leafQueue,
 String nodeLabel)
                 throws SchedulerDynamicEditException

Throws:

SchedulerDynamicEditException

commitQueueManagementChanges

public void commitQueueManagementChanges(List<QueueManagementChange> queueManagementChanges)
                                  throws SchedulerDynamicEditException

Commit queue management changes - which involves updating required state on parent/underlying leaf queues.

Specified by:

commitQueueManagementChanges in interface AutoCreatedQueueManagementPolicy

Parameters:

queueManagementChanges - Queue Management changes to commit

Throws:

SchedulerDynamicEditException - when validation fails

hasPendingApps

public boolean hasPendingApps(AutoCreatedLeafQueue leafQueue)

reinitialize

public void reinitialize(AbstractParentQueue parentQueue)
                  throws IOException

Description copied from interface: AutoCreatedQueueManagementPolicy

Reinitialize policy state ( if required ).

Specified by:

reinitialize in interface AutoCreatedQueueManagementPolicy

Parameters:

parentQueue - parent queue

Throws:

IOException - an I/O exception has occurred.

getInitialLeafQueueConfiguration

public AutoCreatedLeafQueueConfig getInitialLeafQueueConfiguration(AbstractAutoCreatedLeafQueue leafQueue)
                                                            throws SchedulerDynamicEditException

Description copied from interface: AutoCreatedQueueManagementPolicy

Get initial template for the specified leaf queue.

Specified by:

getInitialLeafQueueConfiguration in interface AutoCreatedQueueManagementPolicy

Parameters:

leafQueue - the leaf queue

Returns:

initial leaf queue template configurations and capacities for auto created queue

Throws:

SchedulerDynamicEditException - when get initialLeafQueue Configuration fails.

getAbsoluteActivatedChildQueueCapacity

@VisibleForTesting
public float getAbsoluteActivatedChildQueueCapacity(String nodeLabel)