machine

package

v0.0.1 Latest Latest Go to latest Published: Aug 24, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Handler func(ctx context.Context, info *ReconcileInfo, instance interface{}) (StateType, ctrl.Result, error)

Handler is a state handle function. If an error isn't nil or ctrl.Result.Requeue is true the state machine will requeue the Request again

type Instance interface {
	runtime.Object
	GetState() StateType
	SetState(state StateType)
	SetError(err error)
}

Instance is a object for the CR need be reconcile NOTE: Instance must be a pointer

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

Machine is a state machine

func New(info *ReconcileInfo, instance Instance, handlers map[StateType]Handler) Machine

New a state machine NOTE: The paramater of instance must be a pointer

func (m *Machine) Reconcile(ctx context.Context) (bool, ctrl.Result, error)

Reconcile state machine. If dirty is true, it means the instance has changed

type ReconcileInfo struct {
	Client client.Client
	Logger logr.Logger
}

ReconcileInfo is the information need by reconcile

type StateType string

StateType is the type of .status.state