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

Class ReservationSchedulerConfiguration

java.lang.Object
org.apache.hadoop.conf.Configuration
org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationSchedulerConfiguration
All Implemented Interfaces:
Iterable<Map.Entry<String,String>>, org.apache.hadoop.io.Writable
Direct Known Subclasses:
AllocationConfiguration, CapacitySchedulerConfiguration
public abstract class ReservationSchedulerConfiguration extends org.apache.hadoop.conf.Configuration

  • Nested Class Summary

    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

    Fields
    Modifier and Type
    Field
    Description
    static final float
    DEFAULT_CAPACITY_OVER_TIME_MULTIPLIER
     
    static final String
    DEFAULT_RESERVATION_ADMISSION_POLICY
     
    static final String
    DEFAULT_RESERVATION_AGENT_NAME
     
    static final long
    DEFAULT_RESERVATION_ENFORCEMENT_WINDOW
     
    static final boolean
    DEFAULT_RESERVATION_MOVE_ON_EXPIRY
     
    static final String
    DEFAULT_RESERVATION_PLANNER_NAME
     
    static final long
    DEFAULT_RESERVATION_WINDOW
     
    static final boolean
    DEFAULT_SHOW_RESERVATIONS_AS_QUEUES
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReservationSchedulerConfiguration()
     
    ReservationSchedulerConfiguration(org.apache.hadoop.conf.Configuration configuration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getAverageCapacity(QueuePath queue)
    Gets the average allowed capacity which will aggregated over the getReservationWindow(org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.QueuePath) by the the SharingPolicy to check aggregate used capacity
    long
    getEnforcementWindow(QueuePath queue)
    Gets the time in milliseconds for which the Planner will verify the Plans satisfy the constraints
    float
    getInstantaneousMaxCapacity(QueuePath queue)
    Gets the maximum capacity at any time that the SharingPolicy allows
    boolean
    getMoveOnExpiry(QueuePath queue)
    Gets whether the applications should be killed or moved to the parent queue when the ReservationDefinition expires
    String
    getReplanner(QueuePath queue)
    Gets the name of the Planner class associated with the queue
    abstract Map<org.apache.hadoop.yarn.api.records.ReservationACL,org.apache.hadoop.security.authorize.AccessControlList>
    getReservationAcls(QueuePath queue)
    Gets a map containing the AccessControlList of users for each ReservationACL acl on thee specified queue.
    String
    getReservationAdmissionPolicy(QueuePath queue)
    Gets the name of the SharingPolicy class associated with the queue
    String
    getReservationAgent(QueuePath queue)
    Gets the name of the ReservationAgent class associated with the queue
    long
    getReservationWindow(QueuePath queue)
    Gets the length of time in milliseconds for which the SharingPolicy checks for validity
    boolean
    getShowReservationAsQueues(QueuePath queuePath)
    Checks whether the reservation queues be hidden or visible
    abstract boolean
    isReservable(QueuePath queue)
    Checks if the queue participates in reservation based scheduling

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

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

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Field Details

    • DEFAULT_RESERVATION_WINDOW

      @Private public static final long DEFAULT_RESERVATION_WINDOW
      See Also:

    • DEFAULT_RESERVATION_ADMISSION_POLICY

      @Private public static final String DEFAULT_RESERVATION_ADMISSION_POLICY
      See Also:

    • DEFAULT_RESERVATION_AGENT_NAME

      @Private public static final String DEFAULT_RESERVATION_AGENT_NAME
      See Also:

    • DEFAULT_RESERVATION_PLANNER_NAME

      @Private public static final String DEFAULT_RESERVATION_PLANNER_NAME
      See Also:

    • DEFAULT_RESERVATION_MOVE_ON_EXPIRY

      @Private public static final boolean DEFAULT_RESERVATION_MOVE_ON_EXPIRY
      See Also:

    • DEFAULT_RESERVATION_ENFORCEMENT_WINDOW

      @Private public static final long DEFAULT_RESERVATION_ENFORCEMENT_WINDOW
      See Also:

    • DEFAULT_SHOW_RESERVATIONS_AS_QUEUES

      @Private public static final boolean DEFAULT_SHOW_RESERVATIONS_AS_QUEUES
      See Also:

    • DEFAULT_CAPACITY_OVER_TIME_MULTIPLIER

      @Private public static final float DEFAULT_CAPACITY_OVER_TIME_MULTIPLIER
      See Also:

  • Constructor Details

    • ReservationSchedulerConfiguration

      public ReservationSchedulerConfiguration()

    • ReservationSchedulerConfiguration

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

  • Method Details

    • isReservable

      public abstract boolean isReservable(QueuePath queue)
      Checks if the queue participates in reservation based scheduling
      Parameters:
      queue - name of the queue
      Returns:
      true if the queue participates in reservation based scheduling

    • getReservationAcls

      public abstract Map<org.apache.hadoop.yarn.api.records.ReservationACL,org.apache.hadoop.security.authorize.AccessControlList> getReservationAcls(QueuePath queue)
      Gets a map containing the AccessControlList of users for each ReservationACL acl on thee specified queue.
      Parameters:
      queue - the queue with which to check a user's permissions.
      Returns:
      The a Map of ReservationACL to AccessControlList which contains a list of users that have the specified permission level.

    • getReservationWindow

      public long getReservationWindow(QueuePath queue)
      Gets the length of time in milliseconds for which the SharingPolicy checks for validity
      Parameters:
      queue - name of the queue
      Returns:
      length in time in milliseconds for which to check the SharingPolicy

    • getAverageCapacity

      public float getAverageCapacity(QueuePath queue)
      Gets the average allowed capacity which will aggregated over the getReservationWindow(org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.QueuePath) by the the SharingPolicy to check aggregate used capacity
      Parameters:
      queue - name of the queue
      Returns:
      average capacity allowed by the SharingPolicy

    • getInstantaneousMaxCapacity

      public float getInstantaneousMaxCapacity(QueuePath queue)
      Gets the maximum capacity at any time that the SharingPolicy allows
      Parameters:
      queue - name of the queue
      Returns:
      maximum allowed capacity at any time

    • getReservationAdmissionPolicy

      public String getReservationAdmissionPolicy(QueuePath queue)
      Gets the name of the SharingPolicy class associated with the queue
      Parameters:
      queue - name of the queue
      Returns:
      the class name of the SharingPolicy

    • getReservationAgent

      public String getReservationAgent(QueuePath queue)
      Gets the name of the ReservationAgent class associated with the queue
      Parameters:
      queue - name of the queue
      Returns:
      the class name of the ReservationAgent

    • getShowReservationAsQueues

      public boolean getShowReservationAsQueues(QueuePath queuePath)
      Checks whether the reservation queues be hidden or visible
      Parameters:
      queuePath - name of the queue
      Returns:
      true if reservation queues should be visible

    • getReplanner

      public String getReplanner(QueuePath queue)
      Gets the name of the Planner class associated with the queue
      Parameters:
      queue - name of the queue
      Returns:
      the class name of the Planner

    • getMoveOnExpiry

      public boolean getMoveOnExpiry(QueuePath queue)
      Gets whether the applications should be killed or moved to the parent queue when the ReservationDefinition expires
      Parameters:
      queue - name of the queue
      Returns:
      true if application should be moved, false if they need to be killed

    • getEnforcementWindow

      public long getEnforcementWindow(QueuePath queue)
      Gets the time in milliseconds for which the Planner will verify the Plans satisfy the constraints
      Parameters:
      queue - name of the queue
      Returns:
      the time in milliseconds for which to check constraints