Package 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>

FairOrderingPolicy comparison goes through following steps. 1.Fairness based comparison. SchedulableEntities with lesser usage would be preferred when compared to another. 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) 2. Compare using job submit time. SchedulableEntities submitted earlier would be preferred than later. 3. Compare demands. SchedulableEntities without resource demand get lower priority than ones which have demands.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	FairOrderingPolicy.FairComparator

Field Summary

Fields

Modifier and Type	Field	Description
static final 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	Description
FairOrderingPolicy()

Method Summary

Modifier and Type	Method	Description
void	configure(Map<String,String> conf)	Provides configuration information for the policy from the scheduler configuration.
void	containerAllocated(S schedulableEntity, RMContainer r)	Notify the OrderingPolicy that the SchedulableEntity has been allocated the given RMContainer, enabling the OrderingPolicy to take appropriate action.
void	containerReleased(S schedulableEntity, RMContainer r)	Notify the OrderingPolicy that the SchedulableEntity has released the given RMContainer, enabling the OrderingPolicy to take appropriate action.
void	demandUpdated(S schedulableEntity)	Notify the OrderingPolicy that the demand for the SchedulableEntity has been updated, enabling the OrderingPolicy to reorder the SchedulableEntity if needed.
String	getConfigName()	Return configuration name (which will be used to set ordering policy).
String	getInfo()	Return 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 Details

ENABLE_SIZE_BASED_WEIGHT

public static final String ENABLE_SIZE_BASED_WEIGHT

See Also:

• Constant Field Values

Constructor Details

FairOrderingPolicy

public FairOrderingPolicy()

Method Details

getSizeBasedWeight

@VisibleForTesting
public boolean getSizeBasedWeight()

setSizeBasedWeight

@VisibleForTesting
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>

Parameters:

conf - a map of scheduler configuration properties and values

containerAllocated

public void containerAllocated(S schedulableEntity,
 RMContainer r)

Description copied from interface: OrderingPolicy

Notify the OrderingPolicy that the SchedulableEntity has been allocated the given RMContainer, enabling the OrderingPolicy to take appropriate action. Depending on the 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>

Parameters:

schedulableEntity - the SchedulableEntity

r - the allocated RMContainer

containerReleased

public void containerReleased(S schedulableEntity,
 RMContainer r)

Description copied from interface: OrderingPolicy

Notify the OrderingPolicy that the SchedulableEntity has released the given RMContainer, enabling the OrderingPolicy to take appropriate action. Depending on the 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>

Parameters:

schedulableEntity - the SchedulableEntity

r - the released RMContainer

demandUpdated

public void demandUpdated(S schedulableEntity)

Description copied from interface: OrderingPolicy

Notify the OrderingPolicy that the demand for the SchedulableEntity has been updated, enabling the OrderingPolicy to reorder the SchedulableEntity if needed.

Specified by:

demandUpdated in interface OrderingPolicy<S extends SchedulableEntity>

Specified by:

demandUpdated in class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>

Parameters:

schedulableEntity - the updated SchedulableEntity

getInfo

public String getInfo()

Description copied from interface: OrderingPolicy

Return information regarding configuration and status.

Specified by:

getInfo in interface OrderingPolicy<S extends SchedulableEntity>

Specified by:

getInfo in class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>

Returns:

configuration and status information

getConfigName

public String getConfigName()

Description copied from interface: OrderingPolicy

Return configuration name (which will be used to set ordering policy).

Specified by:

getConfigName in interface OrderingPolicy<S extends SchedulableEntity>

Specified by:

getConfigName in class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>

Returns:

configuration name