# Packages
Package disk contains abstract utility function to filter disks in MachineState.Disk call.
Package emergency provides values to handle emergency (panic/unrecoverable error) handling for machined.
Package logging provides implementations of runtime.LoggingManager.
Package v1alpha1 implements a `Runtime`.
Package v1alpha2 provides runtime implementation based on os-runtime.
# Functions
DefaultControllerOptions returns the default controller options.
IsRebootError checks whether given error is RebootError.
NewDrainer creates new drainer.
NewEvent creates a new event with the provided payload and actor ID.
ParseMode returns a `Mode` that matches the specified string.
ParseSequence returns a `Sequence` that matches the specified string.
WithActorID sets up Watcher to return events filtered by given actor id.
WithFollow enables follow mode for the logs.
WithTailDuration sets up Watcher to return events with timestamp >= (now - tailDuration).
WithTailEvents sets up Watcher to return specified number of past events.
WithTailID sets up Watcher to return events with ID > TailID.
WithTailLines starts log reading from lines from the tail of the log.
WithTakeover sets the take option to true.
# Constants
MetaKV is META partition.
ModeCloud is the cloud runtime mode.
ModeContainer is the container runtime mode.
ModeMetal is the metal runtime mode.
Reboot node reboot.
Rollback node rollback.
SequenceBoot is the boot sequence.
SequenceInitialize is the initialize sequence.
SequenceInstall is the install sequence.
SequenceMaintenanceUpgrade is the upgrade sequence in maintenance mode.
SequenceNoop is the noop sequence.
SequenceReboot is the reboot sequence.
SequenceReset is the reset sequence.
SequenceShutdown is the shutdown sequence.
SequenceStageUpgrade is the stage upgrade sequence.
SequenceUpgrade is the upgrade sequence.
Shutdown node shutdown.
Upgrade node upgrade.
# Variables
ErrDontRetry indicates that log event should not be resent.
ErrInvalidSequenceData indicates that the sequencer got data the wrong data type for a sequence.
ErrLocked indicates that the sequencer is currently locked, and processing another sequence.
ErrUndefinedRuntime indicates that the sequencer's runtime is not defined.
# Structs
ActorIDCtxKey is the context key used for event actor id.
BoardInstallOptions are the board specific options for installation of various boot assets.
Drainer is used in controllers to ensure graceful shutdown.
DrainEvent is sent to the events channel when drainer starts the shutdown sequence.
DrainSubscription keeps ingoing and outgoing events channels.
Event is what is sent on the wire.
EventFatalSequencerError represents a fatal sequencer error.
EventInfo unifies event and queue information for the WatchFunc.
EventSequenceStart represents the sequence start event.
LockOptions represents the options for a controller.
LogEvent represents a log message to be send.
LogOptions for LogHandler.Reader.
PartitionOptions are the board specific options for customizing the partition table.
Phase represents a collection of tasks to be performed concurrently.
PlatformNetworkConfig describes the network configuration produced by the platform.
RebootError encapsulates unix.Reboot() cmd argument.
WatchOptions defines options for the watch call.
# Interfaces
Board defines the requirements for a SBC.
ClusterState defines the cluster state.
Controller represents the controller responsible for managing the execution of sequences.
DBusState defines the D-Bus logind mock.
EventStream defines the runtime event stream.
LoggingManager provides unified interface to publish and consume logs.
LogHandler provides interface to access particular log source.
LogSender provides common interface for log senders.
Machine defines the runtime parameters.
MachineState defines the machined state.
Meta defines the access to META partition.
PartitionTarget provides interface to the disk partition.
Platform defines the requirements for a platform.
Publisher defines a runtime event publisher.
ResetOptions are parameters to Reset sequence.
Runtime defines the runtime parameters.
Sequencer describes the set of sequences required for the lifecycle management of the operating system.
State defines the state.
V1Alpha2Controller provides glue into v2alpha1 controller runtime.
V1Alpha2State defines the next generation (v2) interface binding into v1 runtime.
Watcher defines a runtime event watcher.
# Type aliases
LockOption represents an option setter.
LogOption provides functional options for LogHandler.Reader.
Mode is a runtime mode.
ModeCapability describes mode capability flags.
Sequence represents a sequence type.
TaskExecutionFunc defines the function that a task will execute for a specific runtime mode.
TaskSetupFunc defines the function that a task will execute for a specific runtime mode.
WatchFunc defines the watcher callback function.
WatchOptionFunc defines the options for the watcher.