org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity
Class CapacitySchedulerConfiguration

java.lang.Object
  org.apache.hadoop.conf.Configuration
      org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CapacitySchedulerConfiguration

All Implemented Interfaces:

Iterable<Map.Entry<String,String>>, org.apache.hadoop.io.Writable

public class CapacitySchedulerConfiguration
extends org.apache.hadoop.conf.Configuration

Nested Class Summary

static class

CapacitySchedulerConfiguration.QueueMapping

Nested classes/interfaces inherited from class org.apache.hadoop.conf.Configuration

org.apache.hadoop.conf.Configuration.DeprecationDelta, org.apache.hadoop.conf.Configuration.IntegerRanges

Field Summary

static String	ACCESSIBLE_NODE_LABELS
static String	ALL_ACL
static String	AVERAGE_CAPACITY
static String	CAPACITY
static boolean	DEFAULT_ENABLE_QUEUE_MAPPING_OVERRIDE
static boolean	DEFAULT_ENABLE_USER_METRICS
static float	DEFAULT_MAXIMUM_APPLICATIONMASTERS_RESOURCE_PERCENT
static float	DEFAULT_MAXIMUM_CAPACITY_VALUE
static int	DEFAULT_MAXIMUM_SYSTEM_APPLICATIIONS
static String	DEFAULT_NODE_LABEL_EXPRESSION
static int	DEFAULT_NODE_LOCALITY_DELAY
static String	DEFAULT_RESERVATION_ADMISSION_POLICY
static String	DEFAULT_RESERVATION_AGENT_NAME
static long	DEFAULT_RESERVATION_ENFORCEMENT_WINDOW
static boolean	DEFAULT_RESERVATION_MOVE_ON_EXPIRY
static String	DEFAULT_RESERVATION_PLANNER_NAME
static long	DEFAULT_RESERVATION_WINDOW
static boolean	DEFAULT_RESERVE_CONT_LOOK_ALL_NODES
static Class<? extends org.apache.hadoop.yarn.util.resource.ResourceCalculator>	DEFAULT_RESOURCE_CALCULATOR_CLASS
static boolean	DEFAULT_SCHEDULE_ASYNCHRONOUSLY_ENABLE
static int	DEFAULT_USER_LIMIT
static float	DEFAULT_USER_LIMIT_FACTOR
static String	DOT
static String	ENABLE_QUEUE_MAPPING_OVERRIDE
static String	ENABLE_USER_METRICS
static String	INSTANTANEOUS_MAX_CAPACITY
static String	IS_RESERVABLE
static String	MAXIMUM_AM_RESOURCE_SUFFIX
static String	MAXIMUM_APPLICATION_MASTERS_RESOURCE_PERCENT
static String	MAXIMUM_APPLICATIONS_SUFFIX
static String	MAXIMUM_CAPACITY
static float	MAXIMUM_CAPACITY_VALUE
static String	MAXIMUM_SYSTEM_APPLICATIONS
static float	MINIMUM_CAPACITY_VALUE
static String	NODE_LOCALITY_DELAY
static String	NONE_ACL
static String	PREFIX
static String	QUEUE_MAPPING
static String	QUEUES
static String	RESERVATION_ADMISSION_POLICY
static String	RESERVATION_AGENT_NAME
static String	RESERVATION_ENFORCEMENT_WINDOW
static String	RESERVATION_MOVE_ON_EXPIRY
static String	RESERVATION_PLANNER_NAME
static String	RESERVATION_SHOW_RESERVATION_AS_QUEUE
static String	RESERVATION_WINDOW
static String	RESERVE_CONT_LOOK_ALL_NODES
static String	RESOURCE_CALCULATOR_CLASS ResourceComparator for scheduling.
static String	ROOT
static String	SCHEDULE_ASYNCHRONOUSLY_ENABLE
static String	SCHEDULE_ASYNCHRONOUSLY_PREFIX
static String	STATE
static float	UNDEFINED
static String	USER_LIMIT
static String	USER_LIMIT_FACTOR

Constructor Summary

CapacitySchedulerConfiguration()

CapacitySchedulerConfiguration(org.apache.hadoop.conf.Configuration configuration)

CapacitySchedulerConfiguration(org.apache.hadoop.conf.Configuration configuration, boolean useLocalConfigurationProvider)

Method Summary

Set<String>	getAccessibleNodeLabels(String queue)
org.apache.hadoop.security.authorize.AccessControlList	getAcl(String queue, org.apache.hadoop.yarn.api.records.QueueACL acl)
Map<org.apache.hadoop.yarn.api.records.QueueACL,org.apache.hadoop.security.authorize.AccessControlList>	getAcls(String queue)
float	getAverageCapacity(String queue)
float	getCapacity(String queue)
String	getDefaultNodeLabelExpression(String queue)
boolean	getEnableUserMetrics()
long	getEnforcementWindow(String queue)
float	getInstantaneousMaxCapacity(String queue)
org.apache.hadoop.yarn.api.records.Resource	getMaximumAllocation()
float	getMaximumApplicationMasterResourcePercent()
float	getMaximumApplicationMasterResourcePerQueuePercent(String queue) Get the maximum am resource percent per queue setting.
int	getMaximumApplicationsPerQueue(String queue) Get the maximum applications per queue setting.
float	getMaximumCapacity(String queue)
Map<String,Float>	getMaximumNodeLabelCapacities(String queue, Set<String> labels, RMNodeLabelsManager mgr)
int	getMaximumSystemApplications()
org.apache.hadoop.yarn.api.records.Resource	getMinimumAllocation()
boolean	getMoveOnExpiry(String queue)
Map<String,Float>	getNodeLabelCapacities(String queue, Set<String> labels, RMNodeLabelsManager mgr)
int	getNodeLocalityDelay()
boolean	getOverrideWithQueueMappings()
List<CapacitySchedulerConfiguration.QueueMapping>	getQueueMappings() Get user/group mappings to queues.
String[]	getQueues(String queue)
String	getReplanner(String queue)
String	getReservationAdmissionPolicy(String queue)
String	getReservationAgent(String queue)
boolean	getReservationContinueLook()
long	getReservationWindow(String queue)
org.apache.hadoop.yarn.util.resource.ResourceCalculator	getResourceCalculator()
boolean	getScheduleAynschronously()
boolean	getShowReservationAsQueues(String queuePath)
org.apache.hadoop.yarn.api.records.QueueState	getState(String queue)
boolean	getUsePortForNodeName()
int	getUserLimit(String queue)
float	getUserLimitFactor(String queue)
boolean	isReservable(String queue)
void	setAccessibleNodeLabels(String queue, Set<String> labels)
void	setAcl(String queue, org.apache.hadoop.yarn.api.records.QueueACL acl, String aclString)
void	setAcls(String queue, Map<org.apache.hadoop.yarn.api.records.QueueACL,org.apache.hadoop.security.authorize.AccessControlList> acls)
void	setAverageCapacity(String queue, float avgCapacity)
void	setCapacity(String queue, float capacity)
void	setCapacityByLabel(String queue, String label, float capacity)
void	setDefaultNodeLabelExpression(String queue, String exp)
void	setInstantaneousMaxCapacity(String queue, float instMaxCapacity)
void	setMaximumCapacity(String queue, float maxCapacity)
void	setMaximumCapacityByLabel(String queue, String label, float capacity)
void	setQueues(String queue, String[] subQueues)
void	setReservable(String queue, boolean isReservable)
void	setReservationAdmissionPolicy(String queue, String reservationPolicy)
void	setReservationAgent(String queue, String reservationPolicy)
void	setReservationWindow(String queue, long reservationWindow)
void	setResourceComparator(Class<? extends org.apache.hadoop.yarn.util.resource.ResourceCalculator> resourceCalculatorClass)
void	setScheduleAynschronously(boolean async)
void	setUserLimit(String queue, int userLimit)
void	setUserLimitFactor(String queue, float userLimitFactor)

Methods inherited from class org.apache.hadoop.conf.Configuration

addDefaultResource, addDeprecation, addDeprecation, addDeprecation, addDeprecation, addDeprecations, addResource, addResource, addResource, addResource, addResource, addResource, clear, dumpConfiguration, dumpDeprecatedKeys, get, get, getBoolean, getClass, getClass, getClassByName, getClassByNameOrNull, getClasses, getClassLoader, getConfResourceAsInputStream, getConfResourceAsReader, getDouble, getEnum, getFile, getFinalParameters, getFloat, getInstances, getInt, getInts, getLocalPath, getLong, getLongBytes, getPassword, getPasswordFromConfig, getPasswordFromCredentialProviders, getPattern, getPropertySources, getProps, getRange, getRaw, getResource, getSocketAddr, getSocketAddr, getStringCollection, getStrings, getStrings, getTimeDuration, getTrimmed, getTrimmed, getTrimmedStringCollection, getTrimmedStrings, getTrimmedStrings, getValByRegex, hasWarnedDeprecation, isDeprecated, iterator, main, readFields, reloadConfiguration, set, set, setBoolean, setBooleanIfUnset, setClass, setClassLoader, setDeprecatedProperties, setDouble, setEnum, setFloat, setIfUnset, setInt, setLong, setPattern, setQuietMode, setSocketAddr, setStrings, setTimeDuration, size, toString, unset, updateConnectAddr, updateConnectAddr, write, writeXml, writeXml

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

@InterfaceAudience.Private
public static final String PREFIX

See Also:

Constant Field Values

DOT

@InterfaceAudience.Private
public static final String DOT

See Also:

Constant Field Values

MAXIMUM_APPLICATIONS_SUFFIX

@InterfaceAudience.Private
public static final String MAXIMUM_APPLICATIONS_SUFFIX

See Also:

Constant Field Values

MAXIMUM_SYSTEM_APPLICATIONS

@InterfaceAudience.Private
public static final String MAXIMUM_SYSTEM_APPLICATIONS

See Also:

Constant Field Values

MAXIMUM_AM_RESOURCE_SUFFIX

@InterfaceAudience.Private
public static final String MAXIMUM_AM_RESOURCE_SUFFIX

See Also:

Constant Field Values

MAXIMUM_APPLICATION_MASTERS_RESOURCE_PERCENT

@InterfaceAudience.Private
public static final String MAXIMUM_APPLICATION_MASTERS_RESOURCE_PERCENT

See Also:

Constant Field Values

QUEUES

@InterfaceAudience.Private
public static final String QUEUES

See Also:

Constant Field Values

CAPACITY

@InterfaceAudience.Private
public static final String CAPACITY

See Also:

Constant Field Values

MAXIMUM_CAPACITY

@InterfaceAudience.Private
public static final String MAXIMUM_CAPACITY

See Also:

Constant Field Values

USER_LIMIT

@InterfaceAudience.Private
public static final String USER_LIMIT

See Also:

Constant Field Values

USER_LIMIT_FACTOR

@InterfaceAudience.Private
public static final String USER_LIMIT_FACTOR

See Also:

Constant Field Values

STATE

@InterfaceAudience.Private
public static final String STATE

See Also:

Constant Field Values

ACCESSIBLE_NODE_LABELS

@InterfaceAudience.Private
public static final String ACCESSIBLE_NODE_LABELS

See Also:

Constant Field Values

DEFAULT_NODE_LABEL_EXPRESSION

@InterfaceAudience.Private
public static final String DEFAULT_NODE_LABEL_EXPRESSION

See Also:

Constant Field Values

RESERVE_CONT_LOOK_ALL_NODES

public static final String RESERVE_CONT_LOOK_ALL_NODES

See Also:

Constant Field Values

DEFAULT_RESERVE_CONT_LOOK_ALL_NODES

@InterfaceAudience.Private
public static final boolean DEFAULT_RESERVE_CONT_LOOK_ALL_NODES

See Also:

Constant Field Values

DEFAULT_MAXIMUM_SYSTEM_APPLICATIIONS

@InterfaceAudience.Private
public static final int DEFAULT_MAXIMUM_SYSTEM_APPLICATIIONS

See Also:

Constant Field Values

DEFAULT_MAXIMUM_APPLICATIONMASTERS_RESOURCE_PERCENT

@InterfaceAudience.Private
public static final float DEFAULT_MAXIMUM_APPLICATIONMASTERS_RESOURCE_PERCENT

See Also:

Constant Field Values

UNDEFINED

@InterfaceAudience.Private
public static final float UNDEFINED

See Also:

Constant Field Values

MINIMUM_CAPACITY_VALUE

@InterfaceAudience.Private
public static final float MINIMUM_CAPACITY_VALUE

See Also:

Constant Field Values

MAXIMUM_CAPACITY_VALUE

@InterfaceAudience.Private
public static final float MAXIMUM_CAPACITY_VALUE

See Also:

Constant Field Values

DEFAULT_MAXIMUM_CAPACITY_VALUE

@InterfaceAudience.Private
public static final float DEFAULT_MAXIMUM_CAPACITY_VALUE

See Also:

Constant Field Values

DEFAULT_USER_LIMIT

@InterfaceAudience.Private
public static final int DEFAULT_USER_LIMIT

See Also:

Constant Field Values

DEFAULT_USER_LIMIT_FACTOR

@InterfaceAudience.Private
public static final float DEFAULT_USER_LIMIT_FACTOR

See Also:

Constant Field Values

ALL_ACL

@InterfaceAudience.Private
public static final String ALL_ACL

See Also:

Constant Field Values

NONE_ACL

@InterfaceAudience.Private
public static final String NONE_ACL

See Also:

Constant Field Values

ENABLE_USER_METRICS

@InterfaceAudience.Private
public static final String ENABLE_USER_METRICS

See Also:

Constant Field Values

DEFAULT_ENABLE_USER_METRICS

@InterfaceAudience.Private
public static final boolean DEFAULT_ENABLE_USER_METRICS

See Also:

Constant Field Values

RESOURCE_CALCULATOR_CLASS

@InterfaceAudience.Private
public static final String RESOURCE_CALCULATOR_CLASS

ResourceComparator for scheduling.

See Also:

Constant Field Values

DEFAULT_RESOURCE_CALCULATOR_CLASS

@InterfaceAudience.Private
public static final Class<? extends org.apache.hadoop.yarn.util.resource.ResourceCalculator> DEFAULT_RESOURCE_CALCULATOR_CLASS

ROOT

@InterfaceAudience.Private
public static final String ROOT

See Also:

Constant Field Values

NODE_LOCALITY_DELAY

@InterfaceAudience.Private
public static final String NODE_LOCALITY_DELAY

See Also:

Constant Field Values

DEFAULT_NODE_LOCALITY_DELAY

@InterfaceAudience.Private
public static final int DEFAULT_NODE_LOCALITY_DELAY

See Also:

Constant Field Values

SCHEDULE_ASYNCHRONOUSLY_PREFIX

@InterfaceAudience.Private
public static final String SCHEDULE_ASYNCHRONOUSLY_PREFIX

See Also:

Constant Field Values

SCHEDULE_ASYNCHRONOUSLY_ENABLE

@InterfaceAudience.Private
public static final String SCHEDULE_ASYNCHRONOUSLY_ENABLE

See Also:

Constant Field Values

DEFAULT_SCHEDULE_ASYNCHRONOUSLY_ENABLE

@InterfaceAudience.Private
public static final boolean DEFAULT_SCHEDULE_ASYNCHRONOUSLY_ENABLE

See Also:

Constant Field Values

QUEUE_MAPPING

@InterfaceAudience.Private
public static final String QUEUE_MAPPING

See Also:

Constant Field Values

ENABLE_QUEUE_MAPPING_OVERRIDE

@InterfaceAudience.Private
public static final String ENABLE_QUEUE_MAPPING_OVERRIDE

See Also:

Constant Field Values

DEFAULT_ENABLE_QUEUE_MAPPING_OVERRIDE

@InterfaceAudience.Private
public static final boolean DEFAULT_ENABLE_QUEUE_MAPPING_OVERRIDE

See Also:

Constant Field Values

AVERAGE_CAPACITY

@InterfaceAudience.Private
public static final String AVERAGE_CAPACITY

See Also:

Constant Field Values

IS_RESERVABLE

@InterfaceAudience.Private
public static final String IS_RESERVABLE

See Also:

Constant Field Values

RESERVATION_WINDOW

@InterfaceAudience.Private
public static final String RESERVATION_WINDOW

See Also:

Constant Field Values

INSTANTANEOUS_MAX_CAPACITY

@InterfaceAudience.Private
public static final String INSTANTANEOUS_MAX_CAPACITY

See Also:

Constant Field Values

DEFAULT_RESERVATION_WINDOW

@InterfaceAudience.Private
public static final long DEFAULT_RESERVATION_WINDOW

See Also:

Constant Field Values

RESERVATION_ADMISSION_POLICY

@InterfaceAudience.Private
public static final String RESERVATION_ADMISSION_POLICY

See Also:

Constant Field Values

RESERVATION_AGENT_NAME

@InterfaceAudience.Private
public static final String RESERVATION_AGENT_NAME

See Also:

Constant Field Values

RESERVATION_SHOW_RESERVATION_AS_QUEUE

@InterfaceAudience.Private
public static final String RESERVATION_SHOW_RESERVATION_AS_QUEUE

See Also:

Constant Field Values

DEFAULT_RESERVATION_ADMISSION_POLICY

@InterfaceAudience.Private
public static final String DEFAULT_RESERVATION_ADMISSION_POLICY

See Also:

Constant Field Values

DEFAULT_RESERVATION_AGENT_NAME

@InterfaceAudience.Private
public static final String DEFAULT_RESERVATION_AGENT_NAME

See Also:

Constant Field Values

RESERVATION_PLANNER_NAME

@InterfaceAudience.Private
public static final String RESERVATION_PLANNER_NAME

See Also:

Constant Field Values

DEFAULT_RESERVATION_PLANNER_NAME

@InterfaceAudience.Private
public static final String DEFAULT_RESERVATION_PLANNER_NAME

See Also:

Constant Field Values

RESERVATION_MOVE_ON_EXPIRY

@InterfaceAudience.Private
public static final String RESERVATION_MOVE_ON_EXPIRY

See Also:

Constant Field Values

DEFAULT_RESERVATION_MOVE_ON_EXPIRY

@InterfaceAudience.Private
public static final boolean DEFAULT_RESERVATION_MOVE_ON_EXPIRY

See Also:

Constant Field Values

RESERVATION_ENFORCEMENT_WINDOW

@InterfaceAudience.Private
public static final String RESERVATION_ENFORCEMENT_WINDOW

See Also:

Constant Field Values

DEFAULT_RESERVATION_ENFORCEMENT_WINDOW

@InterfaceAudience.Private
public static final long DEFAULT_RESERVATION_ENFORCEMENT_WINDOW

See Also:

Constant Field Values

Constructor Detail

CapacitySchedulerConfiguration

public CapacitySchedulerConfiguration()

CapacitySchedulerConfiguration

public CapacitySchedulerConfiguration(org.apache.hadoop.conf.Configuration configuration)

CapacitySchedulerConfiguration

public CapacitySchedulerConfiguration(org.apache.hadoop.conf.Configuration configuration,
                                      boolean useLocalConfigurationProvider)

Method Detail

getMaximumSystemApplications

public int getMaximumSystemApplications()

getMaximumApplicationMasterResourcePercent

public float getMaximumApplicationMasterResourcePercent()

getMaximumApplicationsPerQueue

public int getMaximumApplicationsPerQueue(String queue)

Get the maximum applications per queue setting.

Parameters:

queue - name of the queue

Returns:

setting specified or -1 if not set

getMaximumApplicationMasterResourcePerQueuePercent

public float getMaximumApplicationMasterResourcePerQueuePercent(String queue)

Get the maximum am resource percent per queue setting.

Parameters:

queue - name of the queue

Returns:

per queue setting or defaults to the global am-resource-percent setting if per queue setting not present

getCapacity

public float getCapacity(String queue)

setCapacity

public void setCapacity(String queue,
                        float capacity)

getMaximumCapacity

public float getMaximumCapacity(String queue)

setMaximumCapacity

public void setMaximumCapacity(String queue,
                               float maxCapacity)

setCapacityByLabel

public void setCapacityByLabel(String queue,
                               String label,
                               float capacity)

setMaximumCapacityByLabel

public void setMaximumCapacityByLabel(String queue,
                                      String label,
                                      float capacity)

getUserLimit

public int getUserLimit(String queue)

setUserLimit

public void setUserLimit(String queue,
                         int userLimit)

getUserLimitFactor

public float getUserLimitFactor(String queue)

setUserLimitFactor

public void setUserLimitFactor(String queue,
                               float userLimitFactor)

getState

public org.apache.hadoop.yarn.api.records.QueueState getState(String queue)

setAccessibleNodeLabels

public void setAccessibleNodeLabels(String queue,
                                    Set<String> labels)

getAccessibleNodeLabels

public Set<String> getAccessibleNodeLabels(String queue)

getNodeLabelCapacities

public Map<String,Float> getNodeLabelCapacities(String queue,
                                                Set<String> labels,
                                                RMNodeLabelsManager mgr)

getMaximumNodeLabelCapacities

public Map<String,Float> getMaximumNodeLabelCapacities(String queue,
                                                       Set<String> labels,
                                                       RMNodeLabelsManager mgr)

getDefaultNodeLabelExpression

public String getDefaultNodeLabelExpression(String queue)

setDefaultNodeLabelExpression

public void setDefaultNodeLabelExpression(String queue,
                                          String exp)

getReservationContinueLook

public boolean getReservationContinueLook()

getAcl

public org.apache.hadoop.security.authorize.AccessControlList getAcl(String queue,
                                                                     org.apache.hadoop.yarn.api.records.QueueACL acl)

setAcl

public void setAcl(String queue,
                   org.apache.hadoop.yarn.api.records.QueueACL acl,
                   String aclString)

getAcls

public Map<org.apache.hadoop.yarn.api.records.QueueACL,org.apache.hadoop.security.authorize.AccessControlList> getAcls(String queue)

setAcls

public void setAcls(String queue,
                    Map<org.apache.hadoop.yarn.api.records.QueueACL,org.apache.hadoop.security.authorize.AccessControlList> acls)

getQueues

public String[] getQueues(String queue)

setQueues

public void setQueues(String queue,
                      String[] subQueues)

getMinimumAllocation

public org.apache.hadoop.yarn.api.records.Resource getMinimumAllocation()

getMaximumAllocation

public org.apache.hadoop.yarn.api.records.Resource getMaximumAllocation()

getEnableUserMetrics

public boolean getEnableUserMetrics()

getNodeLocalityDelay

public int getNodeLocalityDelay()

getResourceCalculator

public org.apache.hadoop.yarn.util.resource.ResourceCalculator getResourceCalculator()

getUsePortForNodeName

public boolean getUsePortForNodeName()

setResourceComparator

public void setResourceComparator(Class<? extends org.apache.hadoop.yarn.util.resource.ResourceCalculator> resourceCalculatorClass)

getScheduleAynschronously

public boolean getScheduleAynschronously()

setScheduleAynschronously

public void setScheduleAynschronously(boolean async)

getOverrideWithQueueMappings

public boolean getOverrideWithQueueMappings()

getQueueMappings

public List<CapacitySchedulerConfiguration.QueueMapping> getQueueMappings()

Get user/group mappings to queues.

Returns:

user/groups mappings or null on illegal configs

isReservable

public boolean isReservable(String queue)

setReservable

public void setReservable(String queue,
                          boolean isReservable)

getReservationWindow

public long getReservationWindow(String queue)

getAverageCapacity

public float getAverageCapacity(String queue)

getInstantaneousMaxCapacity

public float getInstantaneousMaxCapacity(String queue)

setInstantaneousMaxCapacity

public void setInstantaneousMaxCapacity(String queue,
                                        float instMaxCapacity)

setReservationWindow

public void setReservationWindow(String queue,
                                 long reservationWindow)

setAverageCapacity

public void setAverageCapacity(String queue,
                               float avgCapacity)

getReservationAdmissionPolicy

public String getReservationAdmissionPolicy(String queue)

setReservationAdmissionPolicy

public void setReservationAdmissionPolicy(String queue,
                                          String reservationPolicy)

getReservationAgent

public String getReservationAgent(String queue)

setReservationAgent

public void setReservationAgent(String queue,
                                String reservationPolicy)

getShowReservationAsQueues

public boolean getShowReservationAsQueues(String queuePath)

getReplanner

public String getReplanner(String queue)

getMoveOnExpiry

public boolean getMoveOnExpiry(String queue)

getEnforcementWindow

public long getEnforcementWindow(String queue)