org.apache.hadoop.yarn.server.resourcemanager.reservation
Interface Plan

All Superinterfaces:

PlanContext, PlanEdit, PlanView

public interface Plan
extends PlanContext, PlanView, PlanEdit

A Plan represents the central data structure of a reservation system that maintains the "agenda" for the cluster. In particular, it maintains information on how a set of ReservationDefinition that have been previously accepted will be honored. ReservationDefinition submitted by the users through the RM public APIs are passed to appropriate ReservationAgents, which in turn will consult the Plan (via the PlanView interface) and try to determine whether there are sufficient resources available in this Plan to satisfy the temporal and resource constraints of a ReservationDefinition. If a valid allocation is found the agent will try to store it in the plan (via the PlanEdit interface). Upon success the system return to the user a positive acknowledgment, and a reservation identifier to be later used to access the reserved resources. A PlanFollower will continuously read from the Plan and will affect the instantaneous allocation of resources among jobs running by publishing the "current" slice of the Plan to the underlying scheduler. I.e., the configuration of queues/weights of the scheduler are modified to reflect the allocations in the Plan. As this interface have several methods we decompose them into three groups: PlanContext: containing configuration type information, PlanView read-only access to the plan state, and PlanEdit write access to the plan state.

Method Summary

Methods inherited from interface org.apache.hadoop.yarn.server.resourcemanager.reservation.PlanEdit

addReservation, archiveCompletedReservations, deleteReservation, setTotalCapacity, updateReservation

Methods inherited from interface org.apache.hadoop.yarn.server.resourcemanager.reservation.PlanView

getAllReservations, getConsumptionForUser, getEarliestStartTime, getLastEndTime, getReservationById, getReservationsAtTime, getTotalCapacity, getTotalCommittedResources

Methods inherited from interface org.apache.hadoop.yarn.server.resourcemanager.reservation.PlanContext

getMaximumAllocation, getMinimumAllocation, getMoveOnExpiry, getQueueMetrics, getQueueName, getReplanner, getReservationAgent, getResourceCalculator, getSharingPolicy, getStep