fsm

Documentation

Index

• Constants
• func Events() fsm.Events
• func HandleProvisioningEvent(log *slog.Logger, ec *metal.ProvisioningEventContainer, ...) (*metal.ProvisioningEventContainer, error)

Constants

const SelfTransitionState = "self_transition"

Functions

func Events

func Events() fsm.Events

func HandleProvisioningEvent

func HandleProvisioningEvent(log *slog.Logger, ec *metal.ProvisioningEventContainer, event *metal.ProvisioningEvent) (*metal.ProvisioningEventContainer, error)

HandleProvisioningEvent can be called to determine whether the given incoming event follows an expected lifecycle of a machine considering the event history of the given provisioning event container.

The function returns a new provisioning event container that can then be safely persisted in the database. If an error is returned, the incoming event is not supposed to be persisted in the database.

Among other things, this function can detect crash loops or other irregularities within a machine lifecycle and enriches the returned provisioning event container with this information.