com.mesosphere.sdk.scheduler

Class AbstractScheduler

java.lang.Object

com.mesosphere.sdk.scheduler.AbstractScheduler

Direct Known Subclasses:

DefaultScheduler, UninstallScheduler

public abstract class AbstractScheduler
extends java.lang.Object

Abstract main scheduler class that ties together the main pieces of a SDK Scheduler process. Handles interaction with Mesos via an embedded AbstractScheduler.MesosScheduler object.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigStore<ServiceSpec>	configStore
protected SchedulerConfig	schedulerConfig
protected StateStore	stateStore
protected java.util.concurrent.ExecutorService	statusExecutor Executor for handling TaskStatus updates in Scheduler#statusUpdate(SchedulerDriver, Protos.TaskStatus).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScheduler(StateStore stateStore, ConfigStore<ServiceSpec> configStore, SchedulerConfig schedulerConfig) Creates a new AbstractScheduler given a StateStore.

Method Summary

Modifier and Type	Method and Description
void	awaitOffersProcessed() All offers must have been presented to resourceOffers() before calling this.
AbstractScheduler	disableApiServer() Skips the creation of the API server and marks it as "started".
AbstractScheduler	disableThreading() Forces the Scheduler to run in a synchronous/single-threaded mode for tests.
java.util.Optional<Scheduler>	getMesosScheduler() Returns a Mesos API Scheduler object to be registered with Mesos, or an empty Optional if Mesos registration should not be performed.
java.util.Collection<Plan>	getPlans() Returns the plans defined for this scheduler.
abstract java.util.Collection<java.lang.Object>	getResources() Returns a list of API resources to be served by the scheduler to the local cluster.
protected abstract PlanCoordinator	initialize(SchedulerDriver driver) Performs any additional Scheduler initialization after registration has completed.
protected abstract void	processOffers(SchedulerDriver driver, java.util.List<Protos.Offer> offers, java.util.Collection<Step> steps) The abstract scheduler will periodically call this method with a list of available offers, which may be empty.
protected abstract void	processStatusUpdate(Protos.TaskStatus status) Handles a task status update which was received from Mesos.
AbstractScheduler	setOfferQueueSize(int queueSize) Overrides the Scheduler's offer queue size.
AbstractScheduler	start() Starts any internal threads to be used by the service.

Methods inherited from class java.lang.Object

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

Field Detail

stateStore

protected final StateStore stateStore

configStore

protected final ConfigStore<ServiceSpec> configStore

schedulerConfig

protected final SchedulerConfig schedulerConfig

statusExecutor

protected final java.util.concurrent.ExecutorService statusExecutor

Executor for handling TaskStatus updates in Scheduler#statusUpdate(SchedulerDriver, Protos.TaskStatus).

Constructor Detail

AbstractScheduler

protected AbstractScheduler(StateStore stateStore,
                            ConfigStore<ServiceSpec> configStore,
                            SchedulerConfig schedulerConfig)

Creates a new AbstractScheduler given a StateStore.

Method Detail

start

public AbstractScheduler start()

Starts any internal threads to be used by the service. Must be called after construction, once, in order for work to proceed.

Returns:

this

getMesosScheduler

public java.util.Optional<Scheduler> getMesosScheduler()

Returns a Mesos API Scheduler object to be registered with Mesos, or an empty Optional if Mesos registration should not be performed.

awaitOffersProcessed

public void awaitOffersProcessed()
                          throws java.lang.InterruptedException

All offers must have been presented to resourceOffers() before calling this. This call will block until all offers have been processed.

Throws:

java.lang.InterruptedException - if waiting for offers to be processed is interrupted

java.lang.IllegalStateException - if offers were not processed in a reasonable amount of time

disableApiServer

public AbstractScheduler disableApiServer()

Skips the creation of the API server and marks it as "started". In order for this to have any effect, it must be called before start().

Returns:

this

disableThreading

public AbstractScheduler disableThreading()

Forces the Scheduler to run in a synchronous/single-threaded mode for tests. To have any effect, this must be called before calling start().

Returns:

this

setOfferQueueSize

public AbstractScheduler setOfferQueueSize(int queueSize)

Overrides the Scheduler's offer queue size. Must only be called before the scheduler has start()ed.

Parameters:

queueSize - the queue size to use, zero for infinite

getPlans

public java.util.Collection<Plan> getPlans()

Returns the plans defined for this scheduler. Useful for scheduler tests.

getResources

public abstract java.util.Collection<java.lang.Object> getResources()

Returns a list of API resources to be served by the scheduler to the local cluster. This may be called before initialize(SchedulerDriver) has been called.

initialize

protected abstract PlanCoordinator initialize(SchedulerDriver driver)
                                       throws java.lang.Exception

Performs any additional Scheduler initialization after registration has completed. The provided SchedulerDriver may be used to talk to Mesos. Returns a PlanCoordinator which will be used to select candidate workloads.

Throws:

java.lang.Exception

processOffers

protected abstract void processOffers(SchedulerDriver driver,
                                      java.util.List<Protos.Offer> offers,
                                      java.util.Collection<Step> steps)

The abstract scheduler will periodically call this method with a list of available offers, which may be empty.

processStatusUpdate

protected abstract void processStatusUpdate(Protos.TaskStatus status)
                                     throws java.lang.Exception

Handles a task status update which was received from Mesos. This call is executed on a separate thread which is run by the Mesos Scheduler Driver.

Throws:

java.lang.Exception