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

Class FairOrderingPolicy<S extends SchedulableEntity>

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.AbstractComparatorOrderingPolicy<S>

org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.FairOrderingPolicy<S>

All Implemented Interfaces:

OrderingPolicy<S>

public class FairOrderingPolicy<S extends SchedulableEntity>
extends AbstractComparatorOrderingPolicy<S>

An OrderingPolicy which orders SchedulableEntities for fairness (see FairScheduler FairSharePolicy), generally, processes with lesser usage are lesser. If sizedBasedWeight is set to true then an application with high demand may be prioritized ahead of an application with less usage. This is to offset the tendency to favor small apps, which could result in starvation for large apps if many small ones enter and leave the queue continuously (optional, default false)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FairOrderingPolicy.FairComparator

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENABLE_SIZE_BASED_WEIGHT

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

comparator, entitiesToReorder, schedulableEntities

Constructor Summary

Constructors

Constructor and Description
FairOrderingPolicy()

Method Summary

Modifier and Type	Method and Description
void	configure(Map<String,String> conf) Provides configuration information for the policy from the scheduler configuration
void	containerAllocated(S schedulableEntity, RMContainer r) The passed SchedulableEntity has been allocated the passed Container, take appropriate action (depending on comparator, a reordering of the SchedulableEntity may be required)
void	containerReleased(S schedulableEntity, RMContainer r) The passed SchedulableEntity has released the passed Container, take appropriate action (depending on comparator, a reordering of the SchedulableEntity may be required)
void	demandUpdated(S schedulableEntity) Demand Updated for the passed schedulableEntity, reorder if needed.
String	getInfo() Display information regarding configuration and status
boolean	getSizeBasedWeight()
void	setSizeBasedWeight(boolean sizeBasedWeight)

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

addAllSchedulableEntities, addSchedulableEntity, entityRequiresReordering, getAssignmentIterator, getComparator, getNumSchedulableEntities, getPreemptionIterator, getSchedulableEntities, removeSchedulableEntity, reorderSchedulableEntity, reorderScheduleEntities, updateSchedulingResourceUsage

Methods inherited from class java.lang.Object

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

Field Detail

ENABLE_SIZE_BASED_WEIGHT

public static final String ENABLE_SIZE_BASED_WEIGHT

See Also:

Constant Field Values

Constructor Detail

FairOrderingPolicy

public FairOrderingPolicy()

Method Detail

getSizeBasedWeight

public boolean getSizeBasedWeight()

setSizeBasedWeight

public void setSizeBasedWeight(boolean sizeBasedWeight)

configure

public void configure(Map<String,String> conf)

Description copied from interface: OrderingPolicy

Provides configuration information for the policy from the scheduler configuration

Specified by:

configure in interface OrderingPolicy<S extends SchedulableEntity>

Specified by:

configure in class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>

containerAllocated

public void containerAllocated(S schedulableEntity,
                               RMContainer r)

Description copied from interface: OrderingPolicy

The passed SchedulableEntity has been allocated the passed Container, take appropriate action (depending on comparator, a reordering of the SchedulableEntity may be required)

Specified by:

containerAllocated in interface OrderingPolicy<S extends SchedulableEntity>

Specified by:

containerAllocated in class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>

containerReleased

public void containerReleased(S schedulableEntity,
                              RMContainer r)

Description copied from interface: OrderingPolicy

The passed SchedulableEntity has released the passed Container, take appropriate action (depending on comparator, a reordering of the SchedulableEntity may be required)

Specified by:

containerReleased in interface OrderingPolicy<S extends SchedulableEntity>

Specified by:

containerReleased in class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>

demandUpdated

public void demandUpdated(S schedulableEntity)

Description copied from interface: OrderingPolicy

Demand Updated for the passed schedulableEntity, reorder if needed.

Specified by:

demandUpdated in interface OrderingPolicy<S extends SchedulableEntity>

Specified by:

demandUpdated in class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>

getInfo

public String getInfo()

Description copied from interface: OrderingPolicy

Display information regarding configuration and status

Specified by:

getInfo in interface OrderingPolicy<S extends SchedulableEntity>

Specified by:

getInfo in class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>