public abstract class AbstractCSQueue extends Object implements CSQueue
Modifier and Type | Class and Description |
---|---|
protected static class |
AbstractCSQueue.CapacityConfigType |
Modifier and Type | Field and Description |
---|---|
protected ActivitiesManager |
activitiesManager |
protected org.apache.hadoop.yarn.security.YarnAuthorizationProvider |
authorizer |
protected AbstractCSQueue.CapacityConfigType |
capacityConfigType |
protected CapacitySchedulerContext |
csContext |
protected org.apache.hadoop.yarn.security.PrivilegedEntity |
queueEntity |
protected ReentrantReadWriteLock.ReadLock |
readLock |
protected ReentrantReadWriteLock.WriteLock |
writeLock |
Constructor and Description |
---|
AbstractCSQueue(CapacitySchedulerContext cs,
CapacitySchedulerConfiguration configuration,
String queueName,
CSQueue parent,
CSQueue old) |
AbstractCSQueue(CapacitySchedulerContext cs,
String queueName,
CSQueue parent,
CSQueue old) |
Modifier and Type | Method and Description |
---|---|
boolean |
accept(org.apache.hadoop.yarn.api.records.Resource cluster,
ResourceCommitRequest<FiCaSchedulerApp,FiCaSchedulerNode> request) |
boolean |
accessibleToPartition(String nodePartition) |
void |
activeQueue()
Active the queue.
|
protected void |
appFinished() |
CSAssignment |
assignContainers(org.apache.hadoop.yarn.api.records.Resource clusterResource,
FiCaSchedulerNode node,
ResourceLimits resourceLimits,
SchedulingMode schedulingMode) |
void |
decPendingResource(String nodeLabel,
org.apache.hadoop.yarn.api.records.Resource resourceToDec)
When an outstanding resource is fulfilled or canceled, calling this will
decrease pending resource in a queue.
|
void |
decReservedResource(String partition,
org.apache.hadoop.yarn.api.records.Resource reservedRes)
Decrement Reserved Capacity
|
void |
decUsedResource(String nodeLabel,
org.apache.hadoop.yarn.api.records.Resource resourceToDec,
SchedulerApplicationAttempt application)
When partition of node updated, we will update queue's resource usage if it
has container(s) running on that.
|
float |
getAbsoluteCapacity()
Get capacity of the parent of the queue as a function of the
cumulative capacity in the cluster.
|
float |
getAbsoluteMaximumCapacity()
Get maximum-capacity of the queue as a funciton of the cumulative capacity
of the cluster.
|
float |
getAbsoluteUsedCapacity()
Get the current absolute used capacity of the queue
relative to the entire cluster.
|
Set<String> |
getAccessibleNodeLabels()
Get labels can be accessed of this queue
labels={*}, means this queue can access any label
labels={ }, means this queue cannot access any label except node without label
labels={a, b, c} means this queue can access a or b or c
|
Map<org.apache.hadoop.yarn.security.AccessType,org.apache.hadoop.security.authorize.AccessControlList> |
getACLs() |
float |
getCapacity()
Get the configured capacity of the queue.
|
AbstractCSQueue.CapacityConfigType |
getCapacityConfigType()
Get CapacityConfigType as PERCENTAGE or ABSOLUTE_RESOURCE.
|
long |
getDefaultApplicationLifetime()
Get the default lifetime in seconds of an application which is submitted to
this queue.
|
org.apache.hadoop.yarn.api.records.Priority |
getDefaultApplicationPriority()
Get the Default Application Priority for this queue
|
boolean |
getDefaultAppLifetimeWasSpecifiedInConfig()
Get the indicator of whether or not the default application lifetime was
set by a config property or was calculated by the capacity scheduler.
|
String |
getDefaultNodeLabelExpression()
Get default label expression of this queue.
|
org.apache.hadoop.yarn.api.records.Resource |
getEffectiveCapacity(String label)
Get effective capacity of queue.
|
org.apache.hadoop.yarn.api.records.Resource |
getEffectiveCapacityDown(String label,
org.apache.hadoop.yarn.api.records.Resource factor)
Get effective capacity of queue.
|
org.apache.hadoop.yarn.api.records.Resource |
getEffectiveMaxCapacity(String label)
Get effective max capacity of queue.
|
org.apache.hadoop.yarn.api.records.Resource |
getEffectiveMaxCapacityDown(String label,
org.apache.hadoop.yarn.api.records.Resource factor)
Get effective max capacity of queue.
|
boolean |
getIntraQueuePreemptionDisabled()
Check whether intra-queue preemption is disabled for this queue
|
boolean |
getIntraQueuePreemptionDisabledInHierarchy()
Determines whether or not the intra-queue preemption disabled switch is set
at any level in this queue's hierarchy.
|
Iterator<RMContainer> |
getKillableContainers(String partition) |
org.apache.hadoop.yarn.api.records.Resource |
getMaximumAllocation() |
long |
getMaximumApplicationLifetime()
Get the maximum lifetime in seconds of an application which is submitted to
this queue.
|
float |
getMaximumCapacity()
Get the configured maximum-capacity of the queue.
|
CSQueueMetrics |
getMetrics()
Get the queue metrics
|
org.apache.hadoop.yarn.api.records.Resource |
getMinimumAllocation() |
String |
getMultiNodeSortingPolicyName()
Get Multi Node scheduling policy name.
|
Set<String> |
getNodeLabelsForQueue()
Get valid Node Labels for this queue
|
int |
getNumContainers() |
CSQueue |
getParent()
Get the parent
Queue . |
boolean |
getPreemptionDisabled()
Check whether disable_preemption property is set for this queue
|
org.apache.hadoop.yarn.api.records.Priority |
getPriority()
Get priority of queue
|
org.apache.hadoop.yarn.security.PrivilegedEntity |
getPrivilegedEntity() |
QueueCapacities |
getQueueCapacities()
Get QueueCapacities of this queue
|
Map<String,org.apache.hadoop.yarn.api.records.QueueConfigurations> |
getQueueConfigurations() |
protected org.apache.hadoop.yarn.api.records.QueueInfo |
getQueueInfo() |
String |
getQueueName()
Get the queue name.
|
String |
getQueuePath()
Get the full name of the queue, including the heirarchy.
|
QueueResourceQuotas |
getQueueResourceQuotas()
Get QueueResourceQuotas associated with each queue.
|
ResourceUsage |
getQueueResourceUsage()
Get ResourceUsage of this queue
|
org.apache.hadoop.yarn.api.records.QueueStatistics |
getQueueStatistics() |
ReentrantReadWriteLock.ReadLock |
getReadLock()
Get readLock associated with the Queue.
|
boolean |
getReservationContinueLooking() |
org.apache.hadoop.yarn.api.records.QueueState |
getState()
Get the current run-state of the queue
|
org.apache.hadoop.yarn.api.records.Resource |
getTotalKillableResource(String partition) |
float |
getUsedCapacity()
Get the current used capacity of nodes without label(s) of the queue
and it's children (if any).
|
org.apache.hadoop.yarn.api.records.Resource |
getUsedResources()
Get the currently utilized resources which allocated at nodes without any
labels in the cluster by the queue and children (if any).
|
Map<String,Float> |
getUserWeights()
Get a map of usernames and weights
|
boolean |
hasAccess(org.apache.hadoop.yarn.api.records.QueueACL acl,
org.apache.hadoop.security.UserGroupInformation user)
Check if the
user has permission to perform the operation |
boolean |
hasChildQueues() |
void |
incPendingResource(String nodeLabel,
org.apache.hadoop.yarn.api.records.Resource resourceToInc)
When new outstanding resource is asked, calling this will increase pending
resource in a queue.
|
void |
incReservedResource(String partition,
org.apache.hadoop.yarn.api.records.Resource reservedRes)
Increment Reserved Capacity
|
void |
incUsedResource(String nodeLabel,
org.apache.hadoop.yarn.api.records.Resource resourceToInc,
SchedulerApplicationAttempt application)
When partition of node updated, we will update queue's resource usage if it
has container(s) running on that.
|
void |
recoverDrainingState() |
protected void |
releaseResource(org.apache.hadoop.yarn.api.records.Resource clusterResource,
org.apache.hadoop.yarn.api.records.Resource resource,
String nodePartition) |
void |
setMultiNodeSortingPolicyName(String policyName) |
void |
setParent(CSQueue newParentQueue)
Set the parent
Queue . |
protected void |
setupConfigurableCapacities() |
protected void |
setupConfigurableCapacities(CapacitySchedulerConfiguration configuration) |
protected void |
setupQueueConfigs(org.apache.hadoop.yarn.api.records.Resource clusterResource,
CapacitySchedulerConfiguration configuration) |
protected void |
updateConfigurableResourceRequirement(String queuePath,
org.apache.hadoop.yarn.api.records.Resource clusterResource) |
void |
updateQueueState(org.apache.hadoop.yarn.api.records.QueueState queueState)
Update the queue state.
|
void |
validateSubmitApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId,
String userName,
String queue)
Validate submitApplication api so that moveApplication do a pre-check.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
apply, assignContainers, attachContainer, collectSchedulerApplications, completedContainer, detachContainer, finishApplication, finishApplicationAttempt, getAbstractUsersManager, getChildQueues, getNumApplications, reinitialize, submitApplication, submitApplicationAttempt, updateClusterResource
stopQueue
getQueueInfo, getQueueUserAclInfo, recoverContainer
protected final org.apache.hadoop.yarn.security.PrivilegedEntity queueEntity
protected AbstractCSQueue.CapacityConfigType capacityConfigType
protected CapacitySchedulerContext csContext
protected org.apache.hadoop.yarn.security.YarnAuthorizationProvider authorizer
protected ActivitiesManager activitiesManager
protected ReentrantReadWriteLock.ReadLock readLock
protected ReentrantReadWriteLock.WriteLock writeLock
public AbstractCSQueue(CapacitySchedulerContext cs, String queueName, CSQueue parent, CSQueue old) throws IOException
IOException
public AbstractCSQueue(CapacitySchedulerContext cs, CapacitySchedulerConfiguration configuration, String queueName, CSQueue parent, CSQueue old)
protected void setupConfigurableCapacities()
protected void setupConfigurableCapacities(CapacitySchedulerConfiguration configuration)
public String getQueuePath()
CSQueue
getQueuePath
in interface CSQueue
public float getCapacity()
CSQueue
getCapacity
in interface CSQueue
public float getAbsoluteCapacity()
CSQueue
getAbsoluteCapacity
in interface CSQueue
public float getAbsoluteMaximumCapacity()
CSQueue
getAbsoluteMaximumCapacity
in interface CSQueue
public float getAbsoluteUsedCapacity()
CSQueue
getAbsoluteUsedCapacity
in interface CSQueue
public float getMaximumCapacity()
CSQueue
getMaximumCapacity
in interface CSQueue
public float getUsedCapacity()
CSQueue
getUsedCapacity
in interface CSQueue
public org.apache.hadoop.yarn.api.records.Resource getUsedResources()
CSQueue
getUsedResources
in interface CSQueue
public int getNumContainers()
public org.apache.hadoop.yarn.api.records.QueueState getState()
CSQueue
getState
in interface CSQueue
getState
in interface SchedulerQueue<CSQueue>
public CSQueueMetrics getMetrics()
Queue
getMetrics
in interface Queue
public String getQueueName()
CSQueue
getQueueName
in interface CSQueue
getQueueName
in interface Queue
public org.apache.hadoop.yarn.security.PrivilegedEntity getPrivilegedEntity()
getPrivilegedEntity
in interface CSQueue
public CSQueue getParent()
CSQueue
Queue
.getParent
in interface CSQueue
getParent
in interface SchedulerQueue<CSQueue>
public void setParent(CSQueue newParentQueue)
CSQueue
Queue
.public Set<String> getAccessibleNodeLabels()
Queue
getAccessibleNodeLabels
in interface Queue
public boolean hasAccess(org.apache.hadoop.yarn.api.records.QueueACL acl, org.apache.hadoop.security.UserGroupInformation user)
CSQueue
user
has permission to perform the operationpublic String getDefaultNodeLabelExpression()
Queue
getDefaultNodeLabelExpression
in interface Queue
protected void setupQueueConfigs(org.apache.hadoop.yarn.api.records.Resource clusterResource, CapacitySchedulerConfiguration configuration) throws IOException
IOException
protected void updateConfigurableResourceRequirement(String queuePath, org.apache.hadoop.yarn.api.records.Resource clusterResource)
public AbstractCSQueue.CapacityConfigType getCapacityConfigType()
CSQueue
getCapacityConfigType
in interface CSQueue
public org.apache.hadoop.yarn.api.records.Resource getEffectiveCapacity(String label)
CSQueue
getEffectiveCapacity
in interface CSQueue
label
- partitionpublic org.apache.hadoop.yarn.api.records.Resource getEffectiveCapacityDown(String label, org.apache.hadoop.yarn.api.records.Resource factor)
CSQueue
getEffectiveCapacityDown
in interface CSQueue
label
- partitionfactor
- factor to normalize downpublic org.apache.hadoop.yarn.api.records.Resource getEffectiveMaxCapacity(String label)
CSQueue
getEffectiveMaxCapacity
in interface CSQueue
label
- partitionpublic org.apache.hadoop.yarn.api.records.Resource getEffectiveMaxCapacityDown(String label, org.apache.hadoop.yarn.api.records.Resource factor)
CSQueue
getEffectiveMaxCapacityDown
in interface CSQueue
label
- partitionfactor
- factor to normalize downprotected org.apache.hadoop.yarn.api.records.QueueInfo getQueueInfo()
public org.apache.hadoop.yarn.api.records.QueueStatistics getQueueStatistics()
public Map<String,org.apache.hadoop.yarn.api.records.QueueConfigurations> getQueueConfigurations()
@InterfaceAudience.Private public org.apache.hadoop.yarn.api.records.Resource getMaximumAllocation()
getMaximumAllocation
in interface CSQueue
@InterfaceAudience.Private public org.apache.hadoop.yarn.api.records.Resource getMinimumAllocation()
getMinimumAllocation
in interface CSQueue
protected void releaseResource(org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource resource, String nodePartition)
@InterfaceAudience.Private public boolean getReservationContinueLooking()
@InterfaceAudience.Private public Map<org.apache.hadoop.yarn.security.AccessType,org.apache.hadoop.security.authorize.AccessControlList> getACLs()
@InterfaceAudience.Private public boolean getPreemptionDisabled()
CSQueue
getPreemptionDisabled
in interface CSQueue
@InterfaceAudience.Private public boolean getIntraQueuePreemptionDisabled()
CSQueue
getIntraQueuePreemptionDisabled
in interface CSQueue
@InterfaceAudience.Private public boolean getIntraQueuePreemptionDisabledInHierarchy()
CSQueue
getIntraQueuePreemptionDisabledInHierarchy
in interface CSQueue
@InterfaceAudience.Private public QueueCapacities getQueueCapacities()
CSQueue
getQueueCapacities
in interface CSQueue
@InterfaceAudience.Private public ResourceUsage getQueueResourceUsage()
CSQueue
getQueueResourceUsage
in interface CSQueue
public QueueResourceQuotas getQueueResourceQuotas()
CSQueue
getQueueResourceQuotas
in interface CSQueue
public ReentrantReadWriteLock.ReadLock getReadLock()
CSQueue
getReadLock
in interface CSQueue
public boolean hasChildQueues()
public void incReservedResource(String partition, org.apache.hadoop.yarn.api.records.Resource reservedRes)
Queue
incReservedResource
in interface Queue
partition
- asked by applicationreservedRes
- reserved resource askedpublic void decReservedResource(String partition, org.apache.hadoop.yarn.api.records.Resource reservedRes)
Queue
decReservedResource
in interface Queue
partition
- asked by applicationreservedRes
- reserved resource askedpublic void incPendingResource(String nodeLabel, org.apache.hadoop.yarn.api.records.Resource resourceToInc)
Queue
incPendingResource
in interface Queue
nodeLabel
- asked by applicationresourceToInc
- new resource askedpublic void decPendingResource(String nodeLabel, org.apache.hadoop.yarn.api.records.Resource resourceToDec)
CSQueue
decPendingResource
in interface CSQueue
decPendingResource
in interface Queue
nodeLabel
- asked by applicationresourceToDec
- new resource askedpublic void incUsedResource(String nodeLabel, org.apache.hadoop.yarn.api.records.Resource resourceToInc, SchedulerApplicationAttempt application)
CSQueue
incUsedResource
in interface CSQueue
public void decUsedResource(String nodeLabel, org.apache.hadoop.yarn.api.records.Resource resourceToDec, SchedulerApplicationAttempt application)
CSQueue
decUsedResource
in interface CSQueue
public boolean accessibleToPartition(String nodePartition)
public org.apache.hadoop.yarn.api.records.Priority getDefaultApplicationPriority()
Queue
getDefaultApplicationPriority
in interface Queue
public Set<String> getNodeLabelsForQueue()
CSQueue
getNodeLabelsForQueue
in interface CSQueue
public org.apache.hadoop.yarn.api.records.Resource getTotalKillableResource(String partition)
public Iterator<RMContainer> getKillableContainers(String partition)
public CSAssignment assignContainers(org.apache.hadoop.yarn.api.records.Resource clusterResource, FiCaSchedulerNode node, ResourceLimits resourceLimits, SchedulingMode schedulingMode)
assignContainers
in interface CSQueue
public boolean accept(org.apache.hadoop.yarn.api.records.Resource cluster, ResourceCommitRequest<FiCaSchedulerApp,FiCaSchedulerNode> request)
public void validateSubmitApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, String userName, String queue) throws org.apache.hadoop.security.AccessControlException
CSQueue
validateSubmitApplication
in interface CSQueue
applicationId
- Application IDuserName
- User Namequeue
- Queue Nameorg.apache.hadoop.security.AccessControlException
- if any acl violation is there.public void updateQueueState(org.apache.hadoop.yarn.api.records.QueueState queueState)
SchedulerQueue
updateQueueState
in interface SchedulerQueue<CSQueue>
queueState
- the queue statepublic void activeQueue() throws org.apache.hadoop.yarn.exceptions.YarnException
SchedulerQueue
activeQueue
in interface SchedulerQueue<CSQueue>
org.apache.hadoop.yarn.exceptions.YarnException
- if the queue can not be activated.protected void appFinished()
public org.apache.hadoop.yarn.api.records.Priority getPriority()
CSQueue
getPriority
in interface CSQueue
public Map<String,Float> getUserWeights()
CSQueue
getUserWeights
in interface CSQueue
public void recoverDrainingState()
public String getMultiNodeSortingPolicyName()
CSQueue
getMultiNodeSortingPolicyName
in interface CSQueue
public void setMultiNodeSortingPolicyName(String policyName)
public long getMaximumApplicationLifetime()
CSQueue
getMaximumApplicationLifetime
in interface CSQueue
public long getDefaultApplicationLifetime()
CSQueue
getDefaultApplicationLifetime
in interface CSQueue
public boolean getDefaultAppLifetimeWasSpecifiedInConfig()
CSQueue
getDefaultAppLifetimeWasSpecifiedInConfig
in interface CSQueue
Copyright © 2008–2022 Apache Software Foundation. All rights reserved.