bus

Documentation

Index

• Constants
• Variables
• func EventError(err error) pluggable.EventResponse
• func IsEventDefined(i interface{}) bool
• func RunHookScript(s string) error
• type BootstrapPayload
• type EventPayload
• type InstallPayload
• type VersionImagePayload
• type YAMLPrompt

Constants

const (

	// EventChallenge is issued before installation begins to gather information about how the device should be provisioned.
	EventChallenge pluggable.EventType = "agent.install.challenge"

	// EventInstall is issues before the os is installed to allow the device to be configured.
	EventInstall pluggable.EventType = "agent.install"

	// EventBoot is issues on every startup, excluding live and recovery mode, in the initramfs stage.
	EventBoot pluggable.EventType = "agent.boot"

	// EventBootstrap is issued to run any initial cluster configuration.
	EventBootstrap pluggable.EventType = "agent.bootstrap"

	// EventInstallPrompt is issued to request which config are required to ask to the user.
	EventInstallPrompt pluggable.EventType = "agent.installprompt"

	// EventRecovery emitted while booting into recovery mode.
	EventRecovery     pluggable.EventType = "agent.recovery"
	EventRecoveryStop pluggable.EventType = "agent.recovery.stop"

	EventAvailableReleases pluggable.EventType = "agent.available_releases"
	EventVersionImage      pluggable.EventType = "agent.version_image"

	EventInteractiveInstall pluggable.EventType = "agent.interactive-install"

	EventAfterReset  pluggable.EventType = "agent.reset.after"
	EventBeforeReset pluggable.EventType = "agent.reset.before"
)

Variables

var AllEvents = []pluggable.EventType{
	EventBootstrap,
	EventChallenge,
	EventAfterReset,
	EventBeforeReset,
	EventBoot,
	EventInstall,
	EventRecovery,
	EventInteractiveInstall,
	EventRecoveryStop,
	EventAvailableReleases,
	EventVersionImage,
}

AllEvents is a convenience list of all the events streamed from the bus.

Functions

func EventError

func EventError(err error) pluggable.EventResponse

func IsEventDefined

func IsEventDefined(i interface{}) bool

IsEventDefined checks wether an event is defined in the bus. It accepts strings or EventType, returns a boolean indicating that the event was defined among the events emitted by the bus.

func RunHookScript

func RunHookScript(s string) error

Types

type BootstrapPayload

type BootstrapPayload struct {
	APIAddress string `json:"api"`
	Config     string `json:"config"`
	Logfile    string `json:"logfile"`
}

type EventPayload

type EventPayload struct {
	Config string `json:"config"`
}

type InstallPayload

type InstallPayload struct {
	Token  string `json:"token"`
	Config string `json:"config"`
}

type VersionImagePayload

type VersionImagePayload struct {
	Version string `json:"version"`
}

type YAMLPrompt

type YAMLPrompt struct {
	YAMLSection string
	Bool        bool
	Prompt      string
	Default     string
	AskFirst    bool
	AskPrompt   string
	IfEmpty     string
	PlaceHolder string
}