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

Class CapacitySchedulerQueueManager

java.lang.Object

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

All Implemented Interfaces:

SchedulerQueueManager<CSQueue,CapacitySchedulerConfiguration>

@Private
@Unstable
public class CapacitySchedulerQueueManager
extends Object
implements SchedulerQueueManager<CSQueue,CapacitySchedulerConfiguration>

Context of the Queues in Capacity Scheduler.

Constructor Summary

Constructors

Constructor	Description
CapacitySchedulerQueueManager(org.apache.hadoop.conf.Configuration conf, RMNodeLabelsManager labelManager, AppPriorityACLsManager appPriorityACLManager)	Construct the service.

Method Summary

Modifier and Type	Method	Description
void	addLegacyDynamicQueue(Queue queue)	Adds an AutoCreatedLeafQueue to the manager collection and extends the children collection of its parent.
void	addQueue(String queueName, CSQueue queue)	Add a new queue to the existing queues.
AbstractLeafQueue	createQueue(QueuePath queue)	Auto creates a LeafQueue and its upper hierarchy given a path at runtime.
List<String>	determineMissingParents(QueuePath queue)	Determines the missing parent paths of a potentially auto creatable queue.
AbstractLeafQueue	getAndCheckLeafQueue(String queue)	Check that the String provided in input is the name of an existing, LeafQueue, if successful returns the queue.
ConfiguredNodeLabels	getConfiguredNodeLabelsForAllQueues()	Get ConfiguredNodeLabels which contains the configured node labels for all queues.
org.apache.hadoop.yarn.api.records.Priority	getDefaultPriorityForQueue(String queueName)	Get the default priority of the queue.
List<org.apache.hadoop.yarn.security.Permission>	getPermissionsForDynamicQueue(QueuePath queuePath, CapacitySchedulerConfiguration csConf)
CSQueue	getQueue(String queueName)	Get a queue matching the specified queue name.
CSQueue	getQueueByFullName(String name)
CapacitySchedulerQueueCapacityHandler	getQueueCapacityHandler()
Map<String,CSQueue>	getQueues()	Get all the queues.
QueueStateManager<CSQueue,CapacitySchedulerConfiguration>	getQueueStateManager()
CSQueue	getRootQueue()	Get the root queue.
Map<String,CSQueue>	getShortNameQueues()
void	initializeQueues(CapacitySchedulerConfiguration conf)	Initialized the queues.
boolean	isAmbiguous(String shortName)
void	reinitConfiguredNodeLabels(CapacitySchedulerConfiguration conf)
void	reinitializeQueues(CapacitySchedulerConfiguration newConf)	Reinitialize the queues.
void	removeLegacyDynamicQueue(String queueName)	Removes an AutoCreatedLeafQueue from the manager collection and from its parent children collection.
void	removeQueue(String queueName)	Remove the queue from the existing queue.
void	setCapacitySchedulerContext(CapacitySchedulerContext capacitySchedulerContext)	Set the CapacitySchedulerContext.
static void	setQueueAcls(org.apache.hadoop.yarn.security.YarnAuthorizationProvider authorizer, AppPriorityACLsManager appPriorityACLManager, CSQueueStore queues)
protected void	setRootQueue(CSQueue rootQueue)

Methods inherited from class java.lang.Object

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

Constructor Details

CapacitySchedulerQueueManager

public CapacitySchedulerQueueManager(org.apache.hadoop.conf.Configuration conf,
 RMNodeLabelsManager labelManager,
 AppPriorityACLsManager appPriorityACLManager)

Construct the service.

Parameters:

conf - the configuration

labelManager - the labelManager

appPriorityACLManager - App priority ACL manager

Method Details

getRootQueue

public CSQueue getRootQueue()

Description copied from interface: SchedulerQueueManager

Get the root queue.

Specified by:

getRootQueue in interface SchedulerQueueManager<CSQueue,CapacitySchedulerConfiguration>

Returns:

root queue

setRootQueue

@VisibleForTesting
protected void setRootQueue(CSQueue rootQueue)

getQueues

public Map<String,CSQueue> getQueues()

Description copied from interface: SchedulerQueueManager

Get all the queues.

Specified by:

getQueues in interface SchedulerQueueManager<CSQueue,CapacitySchedulerConfiguration>

Returns:

a map contains all the queues as well as related queue names

getShortNameQueues

@VisibleForTesting
public Map<String,CSQueue> getShortNameQueues()

removeQueue

public void removeQueue(String queueName)

Description copied from interface: SchedulerQueueManager

Remove the queue from the existing queue.

Specified by:

removeQueue in interface SchedulerQueueManager<CSQueue,CapacitySchedulerConfiguration>

Parameters:

queueName - the queue name

addQueue

public void addQueue(String queueName,
 CSQueue queue)

Description copied from interface: SchedulerQueueManager

Add a new queue to the existing queues.

Specified by:

addQueue in interface SchedulerQueueManager<CSQueue,CapacitySchedulerConfiguration>

Parameters:

queueName - the queue name

queue - the queue object

getQueue

public CSQueue getQueue(String queueName)

Description copied from interface: SchedulerQueueManager

Get a queue matching the specified queue name.

Specified by:

getQueue in interface SchedulerQueueManager<CSQueue,CapacitySchedulerConfiguration>

Parameters:

queueName - the queue name

Returns:

a queue object

getQueueByFullName

public CSQueue getQueueByFullName(String name)

isAmbiguous

public boolean isAmbiguous(String shortName)

setCapacitySchedulerContext

public void setCapacitySchedulerContext(CapacitySchedulerContext capacitySchedulerContext)

Set the CapacitySchedulerContext.

Parameters:

capacitySchedulerContext - the CapacitySchedulerContext

initializeQueues

public void initializeQueues(CapacitySchedulerConfiguration conf)
                      throws IOException

Initialized the queues.

Parameters:

conf - the CapacitySchedulerConfiguration

Throws:

IOException - if fails to initialize queues

reinitializeQueues

public void reinitializeQueues(CapacitySchedulerConfiguration newConf)
                        throws IOException

Description copied from interface: SchedulerQueueManager

Reinitialize the queues.

Specified by:

reinitializeQueues in interface SchedulerQueueManager<CSQueue,CapacitySchedulerConfiguration>

Parameters:

newConf - the configuration

Throws:

IOException - if fails to re-initialize queues

setQueueAcls

@VisibleForTesting
public static void setQueueAcls(org.apache.hadoop.yarn.security.YarnAuthorizationProvider authorizer,
 AppPriorityACLsManager appPriorityACLManager,
 CSQueueStore queues)
                         throws IOException

Throws:

IOException

getAndCheckLeafQueue

public AbstractLeafQueue getAndCheckLeafQueue(String queue)
                                       throws org.apache.hadoop.yarn.exceptions.YarnException

Check that the String provided in input is the name of an existing, LeafQueue, if successful returns the queue.

Parameters:

queue - the queue name

Returns:

the LeafQueue

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the queue does not exist or the queue is not the type of LeafQueue.

getDefaultPriorityForQueue

public org.apache.hadoop.yarn.api.records.Priority getDefaultPriorityForQueue(String queueName)

Get the default priority of the queue.

Parameters:

queueName - the queue name

Returns:

the default priority of the queue

getQueueStateManager

@Private
public QueueStateManager<CSQueue,CapacitySchedulerConfiguration> getQueueStateManager()

getQueueCapacityHandler

public CapacitySchedulerQueueCapacityHandler getQueueCapacityHandler()

removeLegacyDynamicQueue

public void removeLegacyDynamicQueue(String queueName)
                              throws SchedulerDynamicEditException

Removes an AutoCreatedLeafQueue from the manager collection and from its parent children collection.

Parameters:

queueName - queue to be removed

Throws:

SchedulerDynamicEditException - if queue is not eligible for deletion

addLegacyDynamicQueue

public void addLegacyDynamicQueue(Queue queue)
                           throws SchedulerDynamicEditException,
IOException

Adds an AutoCreatedLeafQueue to the manager collection and extends the children collection of its parent.

Parameters:

queue - to be added

Throws:

SchedulerDynamicEditException - if queue is not eligible to be added

IOException - if parent can not accept the queue

createQueue

public AbstractLeafQueue createQueue(QueuePath queue)
                              throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Auto creates a LeafQueue and its upper hierarchy given a path at runtime.

Parameters:

queue - the application placement information of the queue

Returns:

the auto created LeafQueue

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the given path is not eligible to be auto created

IOException - if the given path can not be added to the parent

determineMissingParents

public List<String> determineMissingParents(QueuePath queue)
                                     throws SchedulerDynamicEditException

Determines the missing parent paths of a potentially auto creatable queue. The missing parents are sorted in a way that the first item is the highest in the hierarchy. Example: root.a, root.a.b, root.a.b.c

Parameters:

queue - to be auto created

Returns:

missing parent paths

Throws:

SchedulerDynamicEditException - if the given queue is not eligible to be auto created

getPermissionsForDynamicQueue

public List<org.apache.hadoop.yarn.security.Permission> getPermissionsForDynamicQueue(QueuePath queuePath,
 CapacitySchedulerConfiguration csConf)

getConfiguredNodeLabelsForAllQueues

public ConfiguredNodeLabels getConfiguredNodeLabelsForAllQueues()

Get ConfiguredNodeLabels which contains the configured node labels for all queues.

Returns:

configured node labels

reinitConfiguredNodeLabels

@VisibleForTesting
public void reinitConfiguredNodeLabels(CapacitySchedulerConfiguration conf)