com.mesosphere.sdk.scheduler.recovery

Class DefaultRecoveryPlanManager

java.lang.Object

com.mesosphere.sdk.scheduler.recovery.DefaultRecoveryPlanManager

All Implemented Interfaces:

PlanManager

public class DefaultRecoveryPlanManager
extends java.lang.Object
implements PlanManager

DefaultRecoveryPlanManager enables monitoring and management of recovery plan.

This is an implementation of PlanManager that performs task recovery using dynamically generated Plan. DefaultRecoveryPlanManager tracks currently failed (permanent) and stopped (transient) tasks, generates a new DefaultRecoveryStep for them and adds them to the recovery Plan, if not already added.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigStore<ServiceSpec>	configStore
static java.lang.String	DEFAULT_RECOVERY_PHASE_NAME
static java.lang.String	DEFAULT_RECOVERY_PLAN_NAME
protected FailureMonitor	failureMonitor
protected LaunchConstrainer	launchConstrainer
protected Logger	logger
protected Plan	plan
protected java.lang.Object	planLock
protected StateStore	stateStore

Constructor Summary

Constructors

Constructor and Description
DefaultRecoveryPlanManager(StateStore stateStore, ConfigStore<ServiceSpec> configStore, java.util.Set<java.lang.String> recoverableTaskNames, LaunchConstrainer launchConstrainer, FailureMonitor failureMonitor)
DefaultRecoveryPlanManager(StateStore stateStore, ConfigStore<ServiceSpec> configStore, java.util.Set<java.lang.String> recoverableTaskNames, LaunchConstrainer launchConstrainer, FailureMonitor failureMonitor, java.util.List<RecoveryPlanOverrider> overrideRecoveryManagers)

Method Summary

Modifier and Type	Method and Description
(package private) java.util.List<Phase>	createPhases(java.util.Collection<PodInstanceRequirement> podInstanceRequirements)
(package private) Step	createStep(PodInstanceRequirement podInstanceRequirement)
java.util.Collection<? extends Step>	getCandidates(java.util.Collection<PodInstanceRequirement> dirtyAssets) Determines the next Steps that should be considered for scheduling.
java.util.Set<PodInstanceRequirement>	getDirtyAssets() Returns a Set of assets that are dirty, i.e.
Plan	getPlan()
protected void	setPlan(Plan plan)
void	update(Protos.TaskStatus status) Updates the recovery plan if necessary.
protected void	updatePlan(java.util.Collection<PodInstanceRequirement> dirtyAssets)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RECOVERY_PLAN_NAME

public static final java.lang.String DEFAULT_RECOVERY_PLAN_NAME

See Also:

Constant Field Values

DEFAULT_RECOVERY_PHASE_NAME

public static final java.lang.String DEFAULT_RECOVERY_PHASE_NAME

See Also:

Constant Field Values

logger

protected final Logger logger

configStore

protected final ConfigStore<ServiceSpec> configStore

plan

protected volatile Plan plan

stateStore

protected final StateStore stateStore

failureMonitor

protected final FailureMonitor failureMonitor

launchConstrainer

protected final LaunchConstrainer launchConstrainer

planLock

protected final java.lang.Object planLock

Constructor Detail

DefaultRecoveryPlanManager

public DefaultRecoveryPlanManager(StateStore stateStore,
                                  ConfigStore<ServiceSpec> configStore,
                                  java.util.Set<java.lang.String> recoverableTaskNames,
                                  LaunchConstrainer launchConstrainer,
                                  FailureMonitor failureMonitor)

DefaultRecoveryPlanManager

public DefaultRecoveryPlanManager(StateStore stateStore,
                                  ConfigStore<ServiceSpec> configStore,
                                  java.util.Set<java.lang.String> recoverableTaskNames,
                                  LaunchConstrainer launchConstrainer,
                                  FailureMonitor failureMonitor,
                                  java.util.List<RecoveryPlanOverrider> overrideRecoveryManagers)

Method Detail

getPlan

public Plan getPlan()

Specified by:

getPlan in interface PlanManager

Returns:

the Plan being managed by this instance

setPlan

protected void setPlan(Plan plan)

getCandidates

public java.util.Collection<? extends Step> getCandidates(java.util.Collection<PodInstanceRequirement> dirtyAssets)

Description copied from interface: PlanManager

Determines the next Steps that should be considered for scheduling. Steps that are being selected by other PlanManagers are provided as dirtyAssets as a hint to this PlanManager to assist with scheduling.

Specified by:

getCandidates in interface PlanManager

Parameters:

dirtyAssets - Other Steps/assets that are already claimed for scheduling elsewhere

Returns:

One or more Steps that can be scheduled or an empty Collection when there is no Step to schedule, which may happen if for example all incomplete Steps are already being worked on by other PlanManagers

update

public void update(Protos.TaskStatus status)

Updates the recovery plan if necessary.

1. Updates existing steps. 2. If the needs recovery and doesn't yet have a step in the plan, removes any COMPLETED steps for this task (at most one step for a given task can exist) and creates a new PENDING step.

Specified by:

update in interface PlanManager

Parameters:

status - task status

updatePlan

protected void updatePlan(java.util.Collection<PodInstanceRequirement> dirtyAssets)

createPhases

java.util.List<Phase> createPhases(java.util.Collection<PodInstanceRequirement> podInstanceRequirements)

createStep

Step createStep(PodInstanceRequirement podInstanceRequirement)

getDirtyAssets

public java.util.Set<PodInstanceRequirement> getDirtyAssets()

Description copied from interface: PlanManager

Returns a Set of assets that are dirty, i.e. being worked upon by the Plan that this PlanManager is working on.

Specified by:

getDirtyAssets in interface PlanManager

Returns:

A Set containing assets that are dirty