plan

Documentation

Index

• type Planner
  • func NewPlanner(logger log.Logger) Planner
• type ResourceState
• type State

Types

type Planner

type Planner interface {
	Plan(ctx context.Context, expected []model.Resource, current []model.Resource) ([]State, error)
}

Planner knows how to make an plan of resource state based on an old group of resources and a new one.

func NewPlanner

func NewPlanner(logger log.Logger) Planner

NewPlanner returns a new planner.

type ResourceState

type ResourceState int

ResourceState represents the state of a resource.

const (
	// ResourceStateUnknown represents an unknown state
	ResourceStateUnknown ResourceState = iota
	// ResourceStateExists represents a state where the resource should exists.
	ResourceStateExists
	// ResourceStateMissing represents a state where the resource should be missing.
	ResourceStateMissing
)

type State

type State struct {
	State    ResourceState
	Resource model.Resource
}

State is the state of a plan of states.