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

Class AbstractManagedParentQueue

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractCSQueue

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractParentQueue

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractManagedParentQueue

All Implemented Interfaces:

CSQueue, Queue, SchedulerQueue<CSQueue>

Direct Known Subclasses:

ManagedParentQueue, PlanQueue

public abstract class AbstractManagedParentQueue
extends AbstractParentQueue

A container class for automatically created child leaf queues. From the user perspective this is equivalent to a LeafQueue, but functionality wise is a sub-class of ParentQueue

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractParentQueue

AbstractParentQueue.QueueCapacityType

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractCSQueue

AbstractCSQueue.CapacityConfigType

Field Summary

Fields

Modifier and Type	Field	Description
protected AutoCreatedLeafQueueConfig	leafQueueTemplate
protected AutoCreatedQueueManagementPolicy	queueManagementPolicy

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractParentQueue

childQueues

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractCSQueue

activitiesManager, authorizer, capacityConfigType, configuredCapacityVectors, configuredMaxCapacityVectors, queueAllocationSettings, queueContext, queueEntity, queueNodeLabelsSettings, queuePath, readLock, writeLock

Constructor Summary

Constructors

Constructor	Description
AbstractManagedParentQueue(CapacitySchedulerQueueContext queueContext, String queueName, CSQueue parent, CSQueue old)

Method Summary

Modifier and Type	Method	Description
void	addChildQueue(CSQueue childQueue)	Add the specified child queue.
AutoCreatedQueueManagementPolicy	getAutoCreatedQueueManagementPolicy()
AutoCreatedLeafQueueConfig	getLeafQueueTemplate()
protected CapacitySchedulerConfiguration	initializeLeafQueueConfigs(String configPrefix)
void	reinitialize(CSQueue newlyParsedQueue, org.apache.hadoop.yarn.api.records.Resource clusterResource)	Reinitialize the queue.
CSQueue	removeChildQueue(String childQueueName)	Remove the specified child queue.
void	removeChildQueue(CSQueue childQueue)	Remove the specified child queue.
protected float	sumOfChildAbsCapacities()
protected float	sumOfChildCapacities()
protected void	validateQueueEntitlementChange(AbstractAutoCreatedLeafQueue leafQueue, QueueEntitlement entitlement)

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractParentQueue

apply, assignContainers, attachContainer, collectSchedulerApplications, completedContainer, createNewQueue, detachContainer, finishApplication, finishApplicationAttempt, getAbstractUsersManager, getAutoCreatedQueueTemplate, getCapacityConfigurationTypeForQueues, getChildQueues, getChildQueuesByTryLock, getNumApplications, getQueueInfo, getQueueOrderingPolicy, getQueueUserAclInfo, getResourceLimitsOfChild, hasChildQueues, isEligibleForAutoDeletion, isEligibleForAutoQueueCreation, isEligibleForLegacyAutoQueueCreation, recoverContainer, refreshAfterResourceCalculation, setDynamicQueueACLProperties, setupQueueConfigs, stopQueue, submitApplication, submitApplicationAttempt, submitApplicationAttempt, toString, updateClusterResource, updateClusterResourceLegacyMode, validateSubmitApplication

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractCSQueue

accept, activateQueue, appFinished, assignContainers, checkConfigTypeIsAbsoluteResource, decPendingResource, decReservedResource, decUsedResource, getAbsoluteCapacity, getAbsoluteMaximumCapacity, getAbsoluteUsedCapacity, getAccessibleNodeLabels, getACLs, getCapacity, getCapacityConfigType, getCapacityOrWeightString, getConfiguredCapacityVector, getConfiguredMaxCapacityVector, getConfiguredNodeLabels, getDefaultApplicationLifetime, getDefaultApplicationPriority, getDefaultAppLifetimeWasSpecifiedInConfig, getDefaultNodeLabelExpression, getEffectiveCapacity, getEffectiveCapacityDown, getEffectiveMaxCapacity, getEffectiveMaxCapacityDown, getIntraQueuePreemptionDisabled, getIntraQueuePreemptionDisabledInHierarchy, getKillableContainers, getMaximumAbsoluteResource, getMaximumAllocation, getMaximumApplicationLifetime, getMaximumCapacity, getMaxParallelApps, getMetrics, getMinimumAbsoluteResource, getMinimumAllocation, getMultiNodeSortingPolicyClassName, getNodeLabelsForQueue, getNumContainers, getParent, getPreemptionDisabled, getPriority, getPrivilegedEntity, getQueueCapacities, getQueueContext, getQueueInfo, getQueueName, getQueuePath, getQueuePathObject, getQueueResourceQuotas, getQueueResourceUsage, getQueueShortName, getReadLock, getState, getTotalKillableResource, getUsedCapacity, getUsedResources, getUserWeights, getWriteLock, hasAccess, incPendingResource, incReservedResource, incUsedResource, isDynamicQueue, isInactiveDynamicQueue, isReservationsContinueLooking, overrideCapacityVectorsForSpecialQueues, parseAndSetDynamicTemplates, recoverDrainingState, releaseResource, setConfiguredMaxCapacityVector, setConfiguredMinCapacityVector, setDynamicQueue, setMaxParallelApps, setMultiNodeSortingPolicyClassName, setParent, setupConfigurableCapacities, updateAbsoluteCapacities, updateCapacityConfigType, updateConfigurableResourceLimits, updateQueueState

Methods inherited from class java.lang.Object

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

Field Details

leafQueueTemplate

protected AutoCreatedLeafQueueConfig leafQueueTemplate

queueManagementPolicy

protected AutoCreatedQueueManagementPolicy queueManagementPolicy

Constructor Details

AbstractManagedParentQueue

public AbstractManagedParentQueue(CapacitySchedulerQueueContext queueContext,
 String queueName,
 CSQueue parent,
 CSQueue old)
                           throws IOException

Throws:

IOException

Method Details

reinitialize

public void reinitialize(CSQueue newlyParsedQueue,
 org.apache.hadoop.yarn.api.records.Resource clusterResource)
                  throws IOException

Description copied from interface: CSQueue

Reinitialize the queue.

Specified by:

reinitialize in interface CSQueue

Overrides:

reinitialize in class AbstractParentQueue

Parameters:

newlyParsedQueue - new queue to re-initalize from

clusterResource - resources in the cluster

Throws:

IOException - an I/O exception has occurred.

addChildQueue

public void addChildQueue(CSQueue childQueue)
                   throws SchedulerDynamicEditException,
IOException

Add the specified child queue.

Parameters:

childQueue - reference to the child queue to be added

Throws:

SchedulerDynamicEditException - when addChildQueue fails.

IOException - an I/O exception has occurred.

removeChildQueue

public void removeChildQueue(CSQueue childQueue)
                      throws SchedulerDynamicEditException

Remove the specified child queue.

Overrides:

removeChildQueue in class AbstractParentQueue

Parameters:

childQueue - reference to the child queue to be removed

Throws:

SchedulerDynamicEditException - when removeChildQueue fails.

removeChildQueue

public CSQueue removeChildQueue(String childQueueName)
                         throws SchedulerDynamicEditException

Remove the specified child queue.

Parameters:

childQueueName - name of the child queue to be removed

Returns:

child queue.

Throws:

SchedulerDynamicEditException - when removeChildQueue fails.

sumOfChildCapacities

protected float sumOfChildCapacities()

sumOfChildAbsCapacities

protected float sumOfChildAbsCapacities()

getLeafQueueTemplate

public AutoCreatedLeafQueueConfig getLeafQueueTemplate()

getAutoCreatedQueueManagementPolicy

public AutoCreatedQueueManagementPolicy getAutoCreatedQueueManagementPolicy()

initializeLeafQueueConfigs

protected CapacitySchedulerConfiguration initializeLeafQueueConfigs(String configPrefix)

validateQueueEntitlementChange

protected void validateQueueEntitlementChange(AbstractAutoCreatedLeafQueue leafQueue,
 QueueEntitlement entitlement)
                                       throws SchedulerDynamicEditException

Throws:

SchedulerDynamicEditException