state

Documentation

Index

• Variables
• func TotalTaskMinAvailable(job *vcbatch.Job) int32
• func TotalTasks(job *vcbatch.Job) int32
• type ActionFn
• type KillActionFn
• type PhaseMap
• type State
  • func NewState(jobInfo *apis.JobInfo) State
• type UpdateStatusFn

Variables

var (
	// SyncJob will create or delete Pods according to Job's spec.
	SyncJob ActionFn
	// KillJob kill all Pods of Job with phase not in podRetainPhase.
	KillJob KillActionFn
)

var PodRetainPhaseNone = PhaseMap{}

PodRetainPhaseNone stores no phase.

var PodRetainPhaseSoft = PhaseMap{
	v1.PodSucceeded: {},
	v1.PodFailed:    {},
}

PodRetainPhaseSoft stores PodSucceeded and PodFailed Phase.

Functions

func TotalTaskMinAvailable

func TotalTaskMinAvailable(job *vcbatch.Job) int32

TotalTaskMinAvailable returns the sum of task minAvailable

func TotalTasks

func TotalTasks(job *vcbatch.Job) int32

TotalTasks returns number of tasks in a given volcano job.

Types

type ActionFn

type ActionFn func(job *apis.JobInfo, fn UpdateStatusFn) error

ActionFn will create or delete Pods according to Job's spec.

type KillActionFn

type KillActionFn func(job *apis.JobInfo, podRetainPhase PhaseMap, fn UpdateStatusFn) error

KillActionFn kill all Pods of Job with phase not in podRetainPhase.

type PhaseMap

type PhaseMap map[v1.PodPhase]struct{}

PhaseMap to store the pod phases.

type State

type State interface {
	// Execute executes the actions based on current state.
	Execute(act v1alpha1.Action) error
}

State interface.

func NewState

func NewState(jobInfo *apis.JobInfo) State

NewState gets the state from the volcano job Phase.

type UpdateStatusFn

type UpdateStatusFn func(status *vcbatch.JobStatus) (jobPhaseChanged bool)

UpdateStatusFn updates the job status.