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

Class PrimaryGroupPlacementRule

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.placement.PlacementRule

org.apache.hadoop.yarn.server.resourcemanager.placement.FSPlacementRule

org.apache.hadoop.yarn.server.resourcemanager.placement.PrimaryGroupPlacementRule

@Private
@Unstable
public class PrimaryGroupPlacementRule
extends FSPlacementRule

Places apps in queues by the primary group of the submitter.

Field Summary

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.placement.FSPlacementRule

createQueue

Constructor Summary

Constructors

Constructor	Description
PrimaryGroupPlacementRule()

Method Summary

Modifier and Type	Method	Description
ApplicationPlacementContext	getPlacementForApp(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext asc, String user)	Return the scheduler queue name the application should be placed in wrapped in an ApplicationPlacementContext object.
boolean	initialize(ResourceScheduler scheduler)	Standard initialisation for FairScheduler rules, shared by all rules.

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.placement.FSPlacementRule

getCreateFlag, getParentRule, setConfig, setConfig, setConfig, setParentRule

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.placement.PlacementRule

getName, getPlacementForApp

Methods inherited from class java.lang.Object

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

Constructor Details

PrimaryGroupPlacementRule

public PrimaryGroupPlacementRule()

Method Details

initialize

public boolean initialize(ResourceScheduler scheduler)
                   throws IOException

Description copied from class: FSPlacementRule

Standard initialisation for FairScheduler rules, shared by all rules. Each rule that extends this abstract and overrides this method must call super.initialize() to run this basic initialisation.

Overrides:

initialize in class FSPlacementRule

Parameters:

scheduler - the scheduler using the rule

Returns:

true in all cases

Throws:

IOException - for any errors

getPlacementForApp

public ApplicationPlacementContext getPlacementForApp(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext asc,
 String user)
                                               throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from class: PlacementRule

Return the scheduler queue name the application should be placed in wrapped in an ApplicationPlacementContext object. A non null return value places the application in a queue, a null value means the queue is not yet determined. The next PlacementRule in the list maintained in the PlacementManager will be executed.

Specified by:

getPlacementForApp in class PlacementRule

Parameters:

asc - The context of the application created on submission

user - The name of the user submitting the application

Returns:

The queue name wrapped in ApplicationPlacementContext or null if no queue was resolved

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - for any error while executing the rule