planner

Documentation

Overview

Package planner provides a simple interface for creating and executing plans.

Index

• type Plan
• type Procedure

Types

type Plan

type Plan interface {
	// Create will perform the plan and will return a list of operations/procedures
	// that need to be run to accomplish the plan
	Create(ctx context.Context) ([]Procedure, error)
}

Plan represents an interface for a plan of operations.

type Procedure

type Procedure interface {
	// Name is the name of the procedure/operation
	Name() string
	// Do will perform the operation/procedure
	Do(ctx context.Context) error
}

Procedure represents a procedure/operation that will be carried out as part of executing a plan.