scheduler

Documentation

Index

• type Config
• type ExecutionGraph
  • func NewExecutionGraph(steps ...dag.Step) (*ExecutionGraph, error)
  • func NewExecutionGraphForRetry(nodes ...*Node) (*ExecutionGraph, error)
  • func (g *ExecutionGraph) Duration() time.Duration
  • func (g *ExecutionGraph) Finish()
  • func (g *ExecutionGraph) FinishAt() time.Time
  • func (g *ExecutionGraph) IsFinished() bool
  • func (g *ExecutionGraph) IsRunning() bool
  • func (g *ExecutionGraph) IsStarted() bool
  • func (g *ExecutionGraph) Nodes() []*Node
  • func (g *ExecutionGraph) Start()
  • func (g *ExecutionGraph) StartAt() time.Time
• type Node
  • func NewNode(step dag.Step, state NodeState) *Node
  • func (n *Node) Execute(ctx context.Context) error
  • func (n *Node) SetError(err error)
  • func (n *Node) State() NodeState
  • func (n *Node) Step() dag.Step
• type NodeState
• type NodeStatus
  • func (s NodeStatus) String() string
• type Scheduler
  • func (sc *Scheduler) Cancel(g *ExecutionGraph)
  • func (sc *Scheduler) HandlerNode(name string) *Node
  • func (sc *Scheduler) Schedule(ctx context.Context, g *ExecutionGraph, done chan *Node) error
  • func (sc *Scheduler) Signal(g *ExecutionGraph, sig os.Signal, done chan bool, allowOverride bool)
  • func (sc *Scheduler) Status(g *ExecutionGraph) Status
• type Status
  • func (s Status) String() string

Types

type Config

type Config struct {
	LogDir        string
	MaxActiveRuns int
	Delay         time.Duration
	Dry           bool
	OnExit        *dag.Step
	OnSuccess     *dag.Step
	OnFailure     *dag.Step
	OnCancel      *dag.Step
	RequestId     string
}

type ExecutionGraph

type ExecutionGraph struct {
	// contains filtered or unexported fields
}

ExecutionGraph represents a graph of steps.

func NewExecutionGraph

func NewExecutionGraph(steps ...dag.Step) (*ExecutionGraph, error)

NewExecutionGraph creates a new execution graph with the given steps.

func NewExecutionGraphForRetry

func NewExecutionGraphForRetry(nodes ...*Node) (*ExecutionGraph, error)

NewExecutionGraphForRetry creates a new execution graph for retry with given nodes.

func (*ExecutionGraph) Duration

func (g *ExecutionGraph) Duration() time.Duration

Duration returns the duration of the execution.

func (*ExecutionGraph) Finish

func (g *ExecutionGraph) Finish()

func (*ExecutionGraph) FinishAt

func (g *ExecutionGraph) FinishAt() time.Time

func (*ExecutionGraph) IsFinished

func (g *ExecutionGraph) IsFinished() bool

func (*ExecutionGraph) IsRunning

func (g *ExecutionGraph) IsRunning() bool

func (*ExecutionGraph) IsStarted

func (g *ExecutionGraph) IsStarted() bool

func (*ExecutionGraph) Nodes

func (g *ExecutionGraph) Nodes() []*Node

Nodes returns the nodes of the execution graph.

func (*ExecutionGraph) Start

func (g *ExecutionGraph) Start()

func (*ExecutionGraph) StartAt

func (g *ExecutionGraph) StartAt() time.Time

type Node

type Node struct {
	NodeState
	// contains filtered or unexported fields
}

Node is a node in a DAG. It executes a command.

func NewNode

func NewNode(step dag.Step, state NodeState) *Node

func (*Node) Execute

func (n *Node) Execute(ctx context.Context) error

Execute runs the command synchronously and returns error if any.

func (*Node) SetError

func (n *Node) SetError(err error)

func (*Node) State

func (n *Node) State() NodeState

func (*Node) Step

func (n *Node) Step() dag.Step

type NodeState

type NodeState struct {
	Status     NodeStatus
	Log        string
	StartedAt  time.Time
	FinishedAt time.Time
	RetryCount int
	RetriedAt  time.Time
	DoneCount  int
	Error      error
}

NodeState is the state of a node.

type NodeStatus

type NodeStatus int

const (
	NodeStatusNone NodeStatus = iota
	NodeStatusRunning
	NodeStatusError
	NodeStatusCancel
	NodeStatusSuccess
	NodeStatusSkipped
)

func (NodeStatus) String

func (s NodeStatus) String() string

type Scheduler

type Scheduler struct {
	*Config
	// contains filtered or unexported fields
}

Scheduler is a scheduler that runs a graph of steps.

func (*Scheduler) Cancel

func (sc *Scheduler) Cancel(g *ExecutionGraph)

Cancel sends -1 signal to all nodes.

func (*Scheduler) HandlerNode

func (sc *Scheduler) HandlerNode(name string) *Node

HandlerNode returns the handler node with the given name.

func (*Scheduler) Schedule

func (sc *Scheduler) Schedule(ctx context.Context, g *ExecutionGraph, done chan *Node) error

Schedule runs the graph of steps. nolint // cognitive complexity

func (*Scheduler) Signal

func (sc *Scheduler) Signal(g *ExecutionGraph, sig os.Signal, done chan bool, allowOverride bool)

Signal sends a signal to the scheduler. for a node with repeat policy, it does not stop the node and wait to finish current run.

func (*Scheduler) Status

func (sc *Scheduler) Status(g *ExecutionGraph) Status

Status returns the status of the scheduler.

type Status

type Status int

const (
	StatusNone Status = iota
	StatusRunning
	StatusError
	StatusCancel
	StatusSuccess
)

func (Status) String

func (s Status) String() string