fsm

Documentation

Index

• func New(config Config) (*libfsm.FSM, error)
• func NewOperationPlan(operation ops.SiteOperation, servers []storage.Server, ...) (*storage.OperationPlan, error)
• type Config

Functions

func New

func New(config Config) (*libfsm.FSM, error)

New returns a new state machine for garbage collection

func NewOperationPlan

func NewOperationPlan(operation ops.SiteOperation, servers []storage.Server, remoteApps []storage.Application) (*storage.OperationPlan, error)

NewOperationPlan returns a new plan for the specified operation and the given set of servers

Types

type Config

type Config struct {
	// Operation references the active garbage collection operation
	Operation *ops.SiteOperation
	// Packages is the cluster package service
	Packages libpack.PackageService
	// App references the cluster application
	App *storage.Application
	// RemoteApps lists optional applications from remote clusters
	RemoteApps []storage.Application
	// Apps is the cluster application service
	Apps app.Applications
	// Operator is the cluster operator service
	Operator ops.Operator
	// LocalPackages is the machine-local pack service
	LocalPackages libpack.PackageService
	// RuntimePath is the path to the runtime container's rootfs
	RuntimePath string
	// FieldLogger is the logger
	log.FieldLogger
	// Spec specifies the function that resolves to an executor
	Spec libfsm.FSMSpecFunc
	// Runner specifies the remote command runner
	Runner rpc.RemoteRunner
	// Silent controls whether the process outputs messages to stdout
	localenv.Silent
}

Config describes configuration of the cluster garbage collector