types

Documentation

Index

• type Runbook
• type Target
• type TargetFactory
• type Targets
• type Task
• type TaskConfig
• type Tasks

Types

type Runbook

type Runbook struct {
	Targets map[string]Target
	Tasks   map[string]*Task
}

A Runbook describes how to perform a series of tasks

type Target

type Target interface {
	Analyze() error
	ConcurrencyLimit() int
	Handle(context.Context, TaskConfig) error
	NewTaskConfig(class string) (TaskConfig, error)
	Start() error
	Stop() error
}

A Target executes tasks

type TargetFactory

type TargetFactory interface {
	NewTarget() Target
}

A TargetFactory instantiates new targets

type Targets

type Targets map[string]Target

Targets maps target IDs to targets

type Task

type Task struct {
	Target  string
	After   []string
	Message string
	Config  TaskConfig
}

Task contains data common to all tasks

type TaskConfig

type TaskConfig interface {
	Check() error
}

A TaskConfig contains task-specific data

type Tasks

type Tasks map[string]*Task

Tasks maps task IDs to tasks