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

Interface YarnScheduler

All Superinterfaces:

EventHandler<SchedulerEvent>

All Known Subinterfaces:

PreemptableResourceScheduler, ResourceScheduler

All Known Implementing Classes:

CapacityScheduler, FairScheduler, FifoScheduler

public interface YarnScheduler
extends EventHandler<SchedulerEvent>

This interface is used by the components to talk to the scheduler for allocating of resources, cleaning up resources.

Method Summary

Methods

Modifier and Type	Method and Description
Allocation	allocate(ApplicationAttemptId appAttemptId, List<ResourceRequest> ask, List<ContainerId> release, List<String> blacklistAdditions, List<String> blacklistRemovals) The main api between the ApplicationMaster and the Scheduler.
boolean	checkAccess(UserGroupInformation callerUGI, QueueACL acl, String queueName) Check if the user has permission to perform the operation.
Resource	getMaximumResourceCapability() Get maximum allocatable Resource.
Resource	getMinimumResourceCapability() Get minimum allocatable Resource.
SchedulerNodeReport	getNodeReport(NodeId nodeId) Get node resource usage report.
int	getNumClusterNodes() Get the number of nodes available in the cluster.
QueueInfo	getQueueInfo(String queueName, boolean includeChildQueues, boolean recursive) Get queue information
List<QueueUserACLInfo>	getQueueUserAclInfo() Get acls for queues for current user.
QueueMetrics	getRootQueueMetrics() Get the root queue for the scheduler.
SchedulerAppReport	getSchedulerAppInfo(ApplicationAttemptId appAttemptId) Get the Scheduler app for a given app attempt Id.

Methods inherited from interface org.apache.hadoop.yarn.event.EventHandler

handle

Method Detail

getQueueInfo

@InterfaceAudience.Public
@InterfaceStability.Stable
QueueInfo getQueueInfo(String queueName,
                                                                        boolean includeChildQueues,
                                                                        boolean recursive)
                       throws IOException

Get queue information

Parameters:

queueName - queue name

includeChildQueues - include child queues?

recursive - get children queues?

Returns:

queue information

Throws:

IOException

getQueueUserAclInfo

@InterfaceAudience.Public
@InterfaceStability.Stable
List<QueueUserACLInfo> getQueueUserAclInfo()

Get acls for queues for current user.

Returns:

acls for queues for current user

getMinimumResourceCapability

@InterfaceAudience.Public
@InterfaceStability.Stable
Resource getMinimumResourceCapability()

Get minimum allocatable Resource.

Returns:

minimum allocatable resource

getMaximumResourceCapability

@InterfaceAudience.Public
@InterfaceStability.Stable
Resource getMaximumResourceCapability()

Get maximum allocatable Resource.

Returns:

maximum allocatable resource

getNumClusterNodes

@InterfaceAudience.Public
@InterfaceStability.Stable
int getNumClusterNodes()

Get the number of nodes available in the cluster.

Returns:

the number of available nodes.

allocate

@InterfaceAudience.Public
@InterfaceStability.Stable
Allocation allocate(ApplicationAttemptId appAttemptId,
                                                                     List<ResourceRequest> ask,
                                                                     List<ContainerId> release,
                                                                     List<String> blacklistAdditions,
                                                                     List<String> blacklistRemovals)

The main api between the ApplicationMaster and the Scheduler. The ApplicationMaster is updating his future resource requirements and may release containers he doens't need.

Parameters:

appAttemptId -

ask -

release -

blacklistAdditions -

blacklistRemovals -

Returns:

the Allocation for the application

getNodeReport

@InterfaceAudience.LimitedPrivate(value="yarn")
@InterfaceStability.Stable
SchedulerNodeReport getNodeReport(NodeId nodeId)

Get node resource usage report.

Parameters:

nodeId -

Returns:

the SchedulerNodeReport for the node or null if nodeId does not point to a defined node.

getSchedulerAppInfo

@InterfaceAudience.LimitedPrivate(value="yarn")
@InterfaceStability.Stable
SchedulerAppReport getSchedulerAppInfo(ApplicationAttemptId appAttemptId)

Get the Scheduler app for a given app attempt Id.

Parameters:

appAttemptId - the id of the application attempt

Returns:

SchedulerApp for this given attempt.

getRootQueueMetrics

@InterfaceAudience.LimitedPrivate(value="yarn")
@InterfaceStability.Evolving
QueueMetrics getRootQueueMetrics()

Get the root queue for the scheduler.

Returns:

the root queue for the scheduler.

checkAccess

boolean checkAccess(UserGroupInformation callerUGI,
                  QueueACL acl,
                  String queueName)

Check if the user has permission to perform the operation. If the user has QueueACL.ADMINISTER_QUEUE permission, this user can view/modify the applications in this queue

Parameters:

callerUGI -

acl -

queueName -

Returns:

true if the user has the permission, false otherwise