Package org.apache.hadoop.yarn.server.resourcemanager.reservation

Class FairSchedulerPlanFollower

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.reservation.AbstractSchedulerPlanFollower

org.apache.hadoop.yarn.server.resourcemanager.reservation.FairSchedulerPlanFollower

All Implemented Interfaces:

java.lang.Runnable, PlanFollower

public class FairSchedulerPlanFollower
extends AbstractSchedulerPlanFollower

Field Summary

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.reservation.AbstractSchedulerPlanFollower

clock, plans, scheduler

Constructor Summary

Constructors

Constructor	Description
FairSchedulerPlanFollower()

Method Summary

Modifier and Type	Method	Description
protected void	addReservationQueue(java.lang.String planQueueName, Queue queue, java.lang.String currResId)	Add a new reservation queue for reservation currResId for this planQueue.
protected void	createDefaultReservationQueue(java.lang.String planQueueName, Queue queue, java.lang.String defReservationId)	Creates the default reservation queue for use when no reservation is used for applications submitted to this planQueue.
protected java.util.List<? extends Queue>	getChildReservationQueues(Queue queue)	Get a list of reservation queues for this planQueue.
protected Queue	getPlanQueue(java.lang.String planQueueName)	Get queue associated with reservable queue named.
protected org.apache.hadoop.yarn.api.records.Resource	getPlanResources(Plan plan, Queue queue, org.apache.hadoop.yarn.api.records.Resource clusterResources)	Get plan resources for this planQueue.
protected java.lang.String	getReservationIdFromQueueName(java.lang.String resQueueName)
protected java.lang.String	getReservationQueueName(java.lang.String planQueueName, java.lang.String reservationQueueName)
protected org.apache.hadoop.yarn.api.records.Resource	getReservationQueueResourceIfExists(Plan plan, org.apache.hadoop.yarn.api.records.ReservationId reservationId)	Get reservation queue resources if it exists otherwise return null.
void	init(org.apache.hadoop.yarn.util.Clock clock, ResourceScheduler sched, java.util.Collection<Plan> plans)	Init function that configures the PlanFollower, by providing:

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.reservation.AbstractSchedulerPlanFollower

cleanupExpiredQueues, getReservedResources, run, setPlans, setQueueEntitlement, sortByDelta, synchronizePlan

Methods inherited from class java.lang.Object

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

Constructor Detail

FairSchedulerPlanFollower

public FairSchedulerPlanFollower()

Method Detail

init

public void init(org.apache.hadoop.yarn.util.Clock clock,
                 ResourceScheduler sched,
                 java.util.Collection<Plan> plans)

Description copied from interface: PlanFollower

Init function that configures the PlanFollower, by providing:

Specified by:

init in interface PlanFollower

Overrides:

init in class AbstractSchedulerPlanFollower

Parameters:

clock - a reference to the system clock.

sched - a reference to the underlying scheduler

plans - references to the plans we should keep synchronized at every time tick.

getPlanQueue

protected Queue getPlanQueue(java.lang.String planQueueName)

Description copied from class: AbstractSchedulerPlanFollower

Get queue associated with reservable queue named.

Specified by:

getPlanQueue in class AbstractSchedulerPlanFollower

Parameters:

planQueueName - name of the reservable queue

Returns:

queue associated with the reservable queue

getChildReservationQueues

protected java.util.List<? extends Queue> getChildReservationQueues(Queue queue)

Description copied from class: AbstractSchedulerPlanFollower

Get a list of reservation queues for this planQueue.

Specified by:

getChildReservationQueues in class AbstractSchedulerPlanFollower

Parameters:

queue - the queue for the current Plan

Returns:

the queues corresponding to the reservations

addReservationQueue

protected void addReservationQueue(java.lang.String planQueueName,
                                   Queue queue,
                                   java.lang.String currResId)

Description copied from class: AbstractSchedulerPlanFollower

Add a new reservation queue for reservation currResId for this planQueue.

Specified by:

addReservationQueue in class AbstractSchedulerPlanFollower

Parameters:

planQueueName - name of the reservable queue.

queue - the queue for the current Plan.

currResId - curr reservationId.

createDefaultReservationQueue

protected void createDefaultReservationQueue(java.lang.String planQueueName,
                                             Queue queue,
                                             java.lang.String defReservationId)

Description copied from class: AbstractSchedulerPlanFollower

Creates the default reservation queue for use when no reservation is used for applications submitted to this planQueue.

Specified by:

createDefaultReservationQueue in class AbstractSchedulerPlanFollower

Parameters:

planQueueName - name of the reservable queue

queue - the queue for the current Plan

defReservationId - name of the default ReservationQueue

getPlanResources

protected org.apache.hadoop.yarn.api.records.Resource getPlanResources(Plan plan,
                                                                       Queue queue,
                                                                       org.apache.hadoop.yarn.api.records.Resource clusterResources)

Description copied from class: AbstractSchedulerPlanFollower

Get plan resources for this planQueue.

Specified by:

getPlanResources in class AbstractSchedulerPlanFollower

Parameters:

plan - the current Plan being considered

queue - the queue for the current Plan

clusterResources - the resources available in the cluster

Returns:

the resources allocated to the specified Plan

getReservationQueueResourceIfExists

protected org.apache.hadoop.yarn.api.records.Resource getReservationQueueResourceIfExists(Plan plan,
                                                                                          org.apache.hadoop.yarn.api.records.ReservationId reservationId)

Description copied from class: AbstractSchedulerPlanFollower

Get reservation queue resources if it exists otherwise return null.

Specified by:

getReservationQueueResourceIfExists in class AbstractSchedulerPlanFollower

Parameters:

plan - the current Plan being considered

reservationId - the identifier of the reservation

Returns:

the resources allocated to the specified reservation

getReservationQueueName

protected java.lang.String getReservationQueueName(java.lang.String planQueueName,
                                                   java.lang.String reservationQueueName)

Overrides:

getReservationQueueName in class AbstractSchedulerPlanFollower

getReservationIdFromQueueName

protected java.lang.String getReservationIdFromQueueName(java.lang.String resQueueName)

Overrides:

getReservationIdFromQueueName in class AbstractSchedulerPlanFollower