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

Packages that use Plan

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

Uses of Plan in org.apache.hadoop.yarn.server.resourcemanager.reservation

Classes in org.apache.hadoop.yarn.server.resourcemanager.reservation that implement Plan

Modifier and Type	Class	Description
class	InMemoryPlan	This class represents an in memory representation of the state of our reservation system, and provides accelerated access to both individual reservations and aggregate utilization of resources over time.

Fields in org.apache.hadoop.yarn.server.resourcemanager.reservation with type parameters of type Plan

Modifier and Type	Field	Description
protected Collection<Plan>	AbstractSchedulerPlanFollower.plans

Methods in org.apache.hadoop.yarn.server.resourcemanager.reservation that return Plan

Modifier and Type	Method	Description
Plan	AbstractReservationSystem.getPlan(String planName)
Plan	CapacityReservationSystem.getPlan(String planName)
Plan	FairReservationSystem.getPlan(String planName)
Plan	ReservationSystem.getPlan(String planName)	Get an existing Plan that has been initialized.
protected Plan	AbstractReservationSystem.initializePlan(String planQueueName)
Plan	ReservationInputValidator.validateReservationDeleteRequest(ReservationSystem reservationSystem, org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest request)	Quick validation on the input to check some obvious fail conditions (fail fast) the input and returns the appropriate Plan associated with the specified Queue or throws an exception message illustrating the details of any validation check failures
Plan	ReservationInputValidator.validateReservationListRequest(ReservationSystem reservationSystem, org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest request)	Quick validation on the input to check some obvious fail conditions (fail fast) the input and returns the appropriate Plan associated with the specified Queue or throws an exception message illustrating the details of any validation check failures.
Plan	ReservationInputValidator.validateReservationSubmissionRequest(ReservationSystem reservationSystem, org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest request, org.apache.hadoop.yarn.api.records.ReservationId reservationId)	Quick validation on the input to check some obvious fail conditions (fail fast) the input and returns the appropriate Plan associated with the specified Queue or throws an exception message illustrating the details of any validation check failures
Plan	ReservationInputValidator.validateReservationUpdateRequest(ReservationSystem reservationSystem, org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest request)	Quick validation on the input to check some obvious fail conditions (fail fast) the input and returns the appropriate Plan associated with the specified Queue or throws an exception message illustrating the details of any validation check failures

Methods in org.apache.hadoop.yarn.server.resourcemanager.reservation that return types with arguments of type Plan

Modifier and Type	Method	Description
Map<String,Plan>	AbstractReservationSystem.getAllPlans()
Map<String,Plan>	ReservationSystem.getAllPlans()	Return a map containing all the plans known to this ReservationSystem (useful for UI)

Methods in org.apache.hadoop.yarn.server.resourcemanager.reservation with parameters of type Plan

Modifier and Type	Method	Description
RLESparseResourceAllocation	CapacityOverTimePolicy.availableResources(RLESparseResourceAllocation available, Plan plan, String user, org.apache.hadoop.yarn.api.records.ReservationId oldId, long start, long end)
RLESparseResourceAllocation	NoOverCommitPolicy.availableResources(RLESparseResourceAllocation available, Plan plan, String user, org.apache.hadoop.yarn.api.records.ReservationId oldId, long start, long end)
RLESparseResourceAllocation	SharingPolicy.availableResources(RLESparseResourceAllocation available, Plan plan, String user, org.apache.hadoop.yarn.api.records.ReservationId oldId, long start, long end)	This method provide a (partial) instantaneous validation by applying business rules (such as max number of parallel containers allowed for a user).
protected abstract org.apache.hadoop.yarn.api.records.Resource	AbstractSchedulerPlanFollower.getPlanResources(Plan plan, Queue queue, org.apache.hadoop.yarn.api.records.Resource clusterResources)	Get plan resources for this planQueue.
protected org.apache.hadoop.yarn.api.records.Resource	CapacitySchedulerPlanFollower.getPlanResources(Plan plan, Queue queue, org.apache.hadoop.yarn.api.records.Resource clusterResources)
protected org.apache.hadoop.yarn.api.records.Resource	FairSchedulerPlanFollower.getPlanResources(Plan plan, Queue queue, org.apache.hadoop.yarn.api.records.Resource clusterResources)
protected abstract org.apache.hadoop.yarn.api.records.Resource	AbstractSchedulerPlanFollower.getReservationQueueResourceIfExists(Plan plan, org.apache.hadoop.yarn.api.records.ReservationId reservationId)	Get reservation queue resources if it exists otherwise return null.
protected org.apache.hadoop.yarn.api.records.Resource	CapacitySchedulerPlanFollower.getReservationQueueResourceIfExists(Plan plan, org.apache.hadoop.yarn.api.records.ReservationId reservationId)
protected org.apache.hadoop.yarn.api.records.Resource	FairSchedulerPlanFollower.getReservationQueueResourceIfExists(Plan plan, org.apache.hadoop.yarn.api.records.ReservationId reservationId)
protected List<ReservationAllocation>	AbstractSchedulerPlanFollower.sortByDelta(List<ReservationAllocation> currentReservations, long now, Plan plan)	Sort in the order from the least new amount of resources asked (likely negative) to the highest.
void	AbstractSchedulerPlanFollower.synchronizePlan(Plan plan, boolean shouldReplan)
void	PlanFollower.synchronizePlan(Plan plan, boolean shouldReplan)	The function performing the actual synchronization operation for a given Plan.
void	CapacityOverTimePolicy.validate(Plan plan, ReservationAllocation reservation)	The validation algorithm walks over the RLE encoded allocation and checks that for all transition points (when the start or end of the checking window encounters a value in the RLE).
void	NoOverCommitPolicy.validate(Plan plan, ReservationAllocation reservation)
void	SharingPolicy.validate(Plan plan, ReservationAllocation newAllocation)	This method runs the policy validation logic, and return true/false on whether the ReservationAllocation is acceptable according to this sharing policy.

Method parameters in org.apache.hadoop.yarn.server.resourcemanager.reservation with type arguments of type Plan

Modifier and Type	Method	Description
void	AbstractSchedulerPlanFollower.init(org.apache.hadoop.yarn.util.Clock clock, ResourceScheduler sched, Collection<Plan> plans)
void	CapacitySchedulerPlanFollower.init(org.apache.hadoop.yarn.util.Clock clock, ResourceScheduler sched, Collection<Plan> plans)
void	FairSchedulerPlanFollower.init(org.apache.hadoop.yarn.util.Clock clock, ResourceScheduler sched, Collection<Plan> plans)
void	PlanFollower.init(org.apache.hadoop.yarn.util.Clock clock, ResourceScheduler sched, Collection<Plan> plans)	Init function that configures the PlanFollower, by providing:
void	AbstractSchedulerPlanFollower.setPlans(Collection<Plan> plans)
void	PlanFollower.setPlans(Collection<Plan> plans)	Setter for the list of plans.

Uses of Plan in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning

Methods in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning with parameters of type Plan

Modifier and Type	Method	Description
protected boolean	PlanningAlgorithm.allocateUser(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract, ReservationAllocation oldReservation)	Performs the actual allocation for a ReservationDefinition within a Plan.
ReservationInterval	StageExecutionInterval.computeExecutionInterval(Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition reservation, org.apache.hadoop.yarn.api.records.ReservationRequest currentReservationStage, boolean allocateLeft, RLESparseResourceAllocation allocations)	Computes the earliest allowed starting time for a given stage.
ReservationInterval	StageExecutionIntervalByDemand.computeExecutionInterval(Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition reservation, org.apache.hadoop.yarn.api.records.ReservationRequest currentReservationStage, boolean allocateLeft, RLESparseResourceAllocation allocations)
ReservationInterval	StageExecutionIntervalUnconstrained.computeExecutionInterval(Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition reservation, org.apache.hadoop.yarn.api.records.ReservationRequest currentReservationStage, boolean allocateLeft, RLESparseResourceAllocation allocations)
RLESparseResourceAllocation	IterativePlanner.computeJobAllocation(Plan plan, org.apache.hadoop.yarn.api.records.ReservationId reservationId, org.apache.hadoop.yarn.api.records.ReservationDefinition reservation, String user)
abstract RLESparseResourceAllocation	PlanningAlgorithm.computeJobAllocation(Plan plan, org.apache.hadoop.yarn.api.records.ReservationId reservationId, org.apache.hadoop.yarn.api.records.ReservationDefinition reservation, String user)
protected Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource>	IterativePlanner.computeStageAllocation(Plan plan, org.apache.hadoop.yarn.api.records.ReservationRequest rr, long stageArrivalTime, long stageDeadline, long period, String user, org.apache.hadoop.yarn.api.records.ReservationId oldId)
Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource>	StageAllocator.computeStageAllocation(Plan plan, RLESparseResourceAllocation planLoads, RLESparseResourceAllocation planModifications, org.apache.hadoop.yarn.api.records.ReservationRequest rr, long stageArrival, long stageDeadline, long period, String user, org.apache.hadoop.yarn.api.records.ReservationId oldId)	Computes the allocation of a stage inside a defined time interval.
Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource>	StageAllocatorGreedy.computeStageAllocation(Plan plan, RLESparseResourceAllocation planLoads, RLESparseResourceAllocation planModifications, org.apache.hadoop.yarn.api.records.ReservationRequest rr, long stageEarliestStart, long stageDeadline, long period, String user, org.apache.hadoop.yarn.api.records.ReservationId oldId)
Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource>	StageAllocatorGreedyRLE.computeStageAllocation(Plan plan, RLESparseResourceAllocation planLoads, RLESparseResourceAllocation planModifications, org.apache.hadoop.yarn.api.records.ReservationRequest rr, long stageEarliestStart, long stageDeadline, long period, String user, org.apache.hadoop.yarn.api.records.ReservationId oldId)
Map<ReservationInterval,org.apache.hadoop.yarn.api.records.Resource>	StageAllocatorLowCostAligned.computeStageAllocation(Plan plan, RLESparseResourceAllocation planLoads, RLESparseResourceAllocation planModifications, org.apache.hadoop.yarn.api.records.ReservationRequest rr, long stageArrival, long stageDeadline, long period, String user, org.apache.hadoop.yarn.api.records.ReservationId oldId)
boolean	AlignedPlannerWithGreedy.createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)
boolean	GreedyReservationAgent.createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)
boolean	PlanningAlgorithm.createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)
boolean	ReservationAgent.createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)	Create a reservation for the user that abides by the specified contract
boolean	TryManyReservationAgents.createReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)
boolean	AlignedPlannerWithGreedy.deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan)
boolean	GreedyReservationAgent.deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan)
boolean	PlanningAlgorithm.deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan)
boolean	ReservationAgent.deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan)	Delete an user reservation
boolean	TryManyReservationAgents.deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan)
protected void	IterativePlanner.initialize(Plan plan, org.apache.hadoop.yarn.api.records.ReservationId reservationId, org.apache.hadoop.yarn.api.records.ReservationDefinition reservation)
void	Planner.plan(Plan plan, List<org.apache.hadoop.yarn.api.records.ReservationDefinition> contracts)	Update the existing Plan, by adding/removing/updating existing reservations, and adding a subset of the reservation requests in the contracts parameter.
void	SimpleCapacityReplanner.plan(Plan plan, List<org.apache.hadoop.yarn.api.records.ReservationDefinition> contracts)
protected ReservationInterval	IterativePlanner.setStageExecutionInterval(Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition reservation, org.apache.hadoop.yarn.api.records.ReservationRequest currentReservationStage, RLESparseResourceAllocation allocations)
boolean	AlignedPlannerWithGreedy.updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)
boolean	GreedyReservationAgent.updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)
boolean	PlanningAlgorithm.updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)
boolean	ReservationAgent.updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)	Update a reservation for the user that abides by the specified contract
boolean	TryManyReservationAgents.updateReservation(org.apache.hadoop.yarn.api.records.ReservationId reservationId, String user, Plan plan, org.apache.hadoop.yarn.api.records.ReservationDefinition contract)