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

Class FifoScheduler

java.lang.Object

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

All Implemented Interfaces:

Configurable, EventHandler<SchedulerEvent>, Recoverable, ResourceScheduler, YarnScheduler

@InterfaceAudience.LimitedPrivate(value="yarn")
@InterfaceStability.Evolving
public class FifoScheduler
extends Object
implements ResourceScheduler, Configurable

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<ApplicationAttemptId,FiCaSchedulerApp>	applications

Constructor Summary

Constructors

Constructor and Description
FifoScheduler()

Method Summary

Methods

Modifier and Type	Method and Description
Allocation	allocate(ApplicationAttemptId applicationAttemptId, 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.
Configuration	getConf() Return the configuration used by this object.
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 applicationAttemptId) Get the Scheduler app for a given app attempt Id.
void	handle(SchedulerEvent event)
void	recover(RMStateStore.RMState state)
void	reinitialize(Configuration conf, RMContext rmContext) Re-initialize the ResourceScheduler.
void	setConf(Configuration conf) Set the configuration to be used by this object.

Methods inherited from class java.lang.Object

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

Field Detail

applications

protected Map<ApplicationAttemptId,FiCaSchedulerApp> applications

Constructor Detail

FifoScheduler

public FifoScheduler()

Method Detail

setConf

public void setConf(Configuration conf)

Description copied from interface: Configurable

Set the configuration to be used by this object.

Specified by:

setConf in interface Configurable

getConf

public Configuration getConf()

Description copied from interface: Configurable

Return the configuration used by this object.

Specified by:

getConf in interface Configurable

getMinimumResourceCapability

public 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 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(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(ApplicationAttemptId applicationAttemptId,
                  List<ResourceRequest> ask,
                  List<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(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.

handle

public void handle(SchedulerEvent event)

Specified by:

handle in interface EventHandler<SchedulerEvent>

getQueueInfo

public 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<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(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.

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(UserGroupInformation callerUGI,
                  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