io.github.retz.planner.spi

Interface Planner

All Known Implementing Classes:

FIFOPlanner, PriorityPlanner

public interface Planner

Retz server will have only one Planner instance within RetzScheduler - so that an actual Planner implemenatation instance may have states inside. Important Note: in 'orderBy', 'filter', 'plan', all of these MUST NOT perform any external I/O like network access, disk access, DB queries as they're in hot path of core scheduling logics of Retz. If any of these methods block, the whole scheduling system may block or freak out. See `Stanchion.java` for how these processes may potentially block. Important Note 2: This Service Provider Interface is still very young boiler plate, which will frequently changed along with future addition of many other built in planners.

Method Summary

Modifier and Type	Method and Description
boolean	filter(Job job)
void	initialize(java.util.Properties p)
java.util.List<java.lang.String>	orderBy()
Plan	plan(java.util.Map<java.lang.String,Offer> offers, java.util.List<Job> jobs) Core callback method that determines matching of jobs and offers, which job assined to which offer (agent) etc etc...
void	setMaxStock(int maxStock)
void	setUseGpu(boolean useGpu)

Method Detail

initialize

void initialize(java.util.Properties p)
         throws java.lang.Throwable

Throws:

java.lang.Throwable

orderBy

java.util.List<java.lang.String> orderBy()

filter

boolean filter(Job job)

plan

Plan plan(java.util.Map<java.lang.String,Offer> offers,
          java.util.List<Job> jobs)

Core callback method that determines matching of jobs and offers, which job assined to which offer (agent) etc etc... Note: attributes in jobs are just a String each but attributes in offers are structured because original attributes in Protos.Offer are already structured (but they're not simple POJO). TODO: offers and jobs should be immutable as they may be reused after plan

Parameters:

offers - A map whose key is offer ID in String with offers including Resource and Attributes

jobs - A list of candidate jobs retrieved from DB

Returns:

plan for next series of Job dispatch to Mesos

setUseGpu

void setUseGpu(boolean useGpu)

setMaxStock

void setMaxStock(int maxStock)