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

Class FifoScheduler

java.lang.Object

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

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

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.yarn.event.EventHandler<SchedulerEvent>, Recoverable, ResourceScheduler, YarnScheduler

@InterfaceAudience.LimitedPrivate(value="yarn")
@InterfaceStability.Evolving
public class FifoScheduler
extends AbstractYarnScheduler
implements org.apache.hadoop.conf.Configurable

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<org.apache.hadoop.yarn.api.records.NodeId,FiCaSchedulerNode>	nodes

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

applications, EMPTY_ALLOCATION, EMPTY_CONTAINER_LIST, rmContext

Constructor Summary

Constructors

Constructor and Description
FifoScheduler()

Method Summary

Methods

Modifier and Type	Method and Description
void	addApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, String queue, String user)
void	addApplicationAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, boolean transferStateFromPreviousAttempt)
Allocation	allocate(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId, List<org.apache.hadoop.yarn.api.records.ResourceRequest> ask, List<org.apache.hadoop.yarn.api.records.ContainerId> release, List<String> blacklistAdditions, List<String> blacklistRemovals) The main api between the ApplicationMaster and the Scheduler.
boolean	checkAccess(org.apache.hadoop.security.UserGroupInformation callerUGI, org.apache.hadoop.yarn.api.records.QueueACL acl, String queueName) Check if the user has permission to perform the operation.
org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport	getAppResourceUsageReport(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId) Get a resource usage report from a given app attempt ID.
List<org.apache.hadoop.yarn.api.records.ApplicationAttemptId>	getAppsInQueue(String queueName) Gets the apps under a given queue
org.apache.hadoop.conf.Configuration	getConf()
org.apache.hadoop.yarn.api.records.Resource	getMaximumResourceCapability() Get maximum allocatable Resource.
org.apache.hadoop.yarn.api.records.Resource	getMinimumResourceCapability() Get minimum allocatable Resource.
SchedulerNodeReport	getNodeReport(org.apache.hadoop.yarn.api.records.NodeId nodeId) Get node resource usage report.
int	getNumClusterNodes() Get the number of nodes available in the cluster.
org.apache.hadoop.yarn.api.records.QueueInfo	getQueueInfo(String queueName, boolean includeChildQueues, boolean recursive) Get queue information
List<org.apache.hadoop.yarn.api.records.QueueUserACLInfo>	getQueueUserAclInfo() Get acls for queues for current user.
RMContainer	getRMContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId) Get the container for the given containerId.
QueueMetrics	getRootQueueMetrics() Get the root queue for the scheduler.
SchedulerAppReport	getSchedulerAppInfo(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId) Get the Scheduler app for a given app attempt Id.
void	handle(SchedulerEvent event)
void	recover(RMStateStore.RMState state)
void	reinitialize(org.apache.hadoop.conf.Configuration conf, RMContext rmContext) Re-initialize the ResourceScheduler.
void	setConf(org.apache.hadoop.conf.Configuration conf)

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

getSchedulerApplications, getTransferredContainers, moveApplication

Methods inherited from class java.lang.Object

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

Field Detail

nodes

protected Map<org.apache.hadoop.yarn.api.records.NodeId,FiCaSchedulerNode> nodes

Constructor Detail

FifoScheduler

public FifoScheduler()

Method Detail

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

getConf

public org.apache.hadoop.conf.Configuration getConf()

Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

getMinimumResourceCapability

public org.apache.hadoop.yarn.api.records.Resource getMinimumResourceCapability()

Description copied from interface: YarnScheduler

Get minimum allocatable Resource.

Specified by:

getMinimumResourceCapability in interface YarnScheduler

Returns:

minimum allocatable resource

getNumClusterNodes

public int getNumClusterNodes()

Description copied from interface: YarnScheduler

Get the number of nodes available in the cluster.

Specified by:

getNumClusterNodes in interface YarnScheduler

Returns:

the number of available nodes.

getMaximumResourceCapability

public org.apache.hadoop.yarn.api.records.Resource getMaximumResourceCapability()

Description copied from interface: YarnScheduler

Get maximum allocatable Resource.

Specified by:

getMaximumResourceCapability in interface YarnScheduler

Returns:

maximum allocatable resource

reinitialize

public void reinitialize(org.apache.hadoop.conf.Configuration conf,
                RMContext rmContext)
                  throws IOException

Description copied from interface: ResourceScheduler

Re-initialize the ResourceScheduler.

Specified by:

reinitialize in interface ResourceScheduler

Parameters:

conf - configuration

Throws:

IOException

allocate

public Allocation allocate(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId,
                  List<org.apache.hadoop.yarn.api.records.ResourceRequest> ask,
                  List<org.apache.hadoop.yarn.api.records.ContainerId> release,
                  List<String> blacklistAdditions,
                  List<String> blacklistRemovals)

Description copied from interface: YarnScheduler

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.

Specified by:

allocate in interface YarnScheduler

Returns:

the Allocation for the application

getSchedulerAppInfo

public SchedulerAppReport getSchedulerAppInfo(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId)

Description copied from interface: YarnScheduler

Get the Scheduler app for a given app attempt Id.

Specified by:

getSchedulerAppInfo in interface YarnScheduler

Parameters:

applicationAttemptId - the id of the application attempt

Returns:

SchedulerApp for this given attempt.

getAppResourceUsageReport

public org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport getAppResourceUsageReport(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId)

Description copied from interface: YarnScheduler

Get a resource usage report from a given app attempt ID.

Specified by:

getAppResourceUsageReport in interface YarnScheduler

Parameters:

applicationAttemptId - the id of the application attempt

Returns:

resource usage report for this given attempt

addApplication

public void addApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId,
                  String queue,
                  String user)

addApplicationAttempt

public void addApplicationAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId,
                         boolean transferStateFromPreviousAttempt)

handle

public void handle(SchedulerEvent event)

Specified by:

handle in interface org.apache.hadoop.yarn.event.EventHandler<SchedulerEvent>

getQueueInfo

public org.apache.hadoop.yarn.api.records.QueueInfo getQueueInfo(String queueName,
                                                        boolean includeChildQueues,
                                                        boolean recursive)

Description copied from interface: YarnScheduler

Get queue information

Specified by:

getQueueInfo in interface YarnScheduler

Parameters:

queueName - queue name

includeChildQueues - include child queues?

recursive - get children queues?

Returns:

queue information

getQueueUserAclInfo

public List<org.apache.hadoop.yarn.api.records.QueueUserACLInfo> getQueueUserAclInfo()

Description copied from interface: YarnScheduler

Get acls for queues for current user.

Specified by:

getQueueUserAclInfo in interface YarnScheduler

Returns:

acls for queues for current user

recover

public void recover(RMStateStore.RMState state)

Specified by:

recover in interface Recoverable

getNodeReport

public SchedulerNodeReport getNodeReport(org.apache.hadoop.yarn.api.records.NodeId nodeId)

Description copied from interface: YarnScheduler

Get node resource usage report.

Specified by:

getNodeReport in interface YarnScheduler

Returns:

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

getRMContainer

public RMContainer getRMContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)

Description copied from interface: YarnScheduler

Get the container for the given containerId.

Specified by:

getRMContainer in interface YarnScheduler

Returns:

the container for the given containerId.

getRootQueueMetrics

public QueueMetrics getRootQueueMetrics()

Description copied from interface: YarnScheduler

Get the root queue for the scheduler.

Specified by:

getRootQueueMetrics in interface YarnScheduler

Returns:

the root queue for the scheduler.

checkAccess

public boolean checkAccess(org.apache.hadoop.security.UserGroupInformation callerUGI,
                  org.apache.hadoop.yarn.api.records.QueueACL acl,
                  String queueName)

Description copied from interface: YarnScheduler

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

Specified by:

checkAccess in interface YarnScheduler

Returns:

true if the user has the permission, false otherwise

getAppsInQueue

public List<org.apache.hadoop.yarn.api.records.ApplicationAttemptId> getAppsInQueue(String queueName)

Description copied from interface: YarnScheduler

Gets the apps under a given queue

Specified by:

getAppsInQueue in interface YarnScheduler

Parameters:

queueName - the name of the queue.

Returns:

a collection of app attempt ids in the given queue.