phase

Documentation

Index

• type Phase
  • func NewPhase(description string, tasks ...Task) *Phase
• type Runner
  • func NewRunner(config runtime.Configurator, sequence runtime.Sequence) (*Runner, error)
  • func (r *Runner) Add(phase ...*Phase)
  • func (r *Runner) Run() error
• type RuntimeArgs
  • func (r *RuntimeArgs) Config() runtime.Configurator
  • func (r *RuntimeArgs) Platform() runtime.Platform
• type Task
• type TaskFunc

Types

type Phase

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

Phase represents a phase in the boot process.

func NewPhase

func NewPhase(description string, tasks ...Task) *Phase

NewPhase initializes and returns a Phase.

type Runner

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

Runner represents a management layer for phases.

func NewRunner

func NewRunner(config runtime.Configurator, sequence runtime.Sequence) (*Runner, error)

NewRunner initializes and returns a Runner.

func (*Runner) Add

func (r *Runner) Add(phase ...*Phase)

Add adds a phase to a Runner.

func (*Runner) Run

func (r *Runner) Run() error

Run executes sequentially all phases known to a Runner.

If any phase fails, Runner aborts immediately.

type RuntimeArgs

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

RuntimeArgs represents the set of arguments passed into a TaskFunc.

func (*RuntimeArgs) Config

func (r *RuntimeArgs) Config() runtime.Configurator

Config returns the config.

func (*RuntimeArgs) Platform

func (r *RuntimeArgs) Platform() runtime.Platform

Platform returns the platform.

type Task

type Task interface {
	TaskFunc(runtime.Mode) TaskFunc
}

Task represents a task within a Phase.

type TaskFunc

type TaskFunc func(runtime.Runtime) error

TaskFunc defines the function that a task must return. The function envelopes the task logic for a given runtime mode.