kairos-sdk/bus/events.go

package bus

import (
	"github.com/mudler/go-pluggable"
)

const (
	// Package events.

	// 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"

	// InitProviderInstall Kairos-init will emit this event to let providers know its time to install their stuff.
	InitProviderInstall pluggable.EventType = "init.provider.install"
	// InitProviderConfigure Kairos-init will emit this event to let providers know its time to configure their stuff. Not used for now.
	InitProviderConfigure pluggable.EventType = "init.provider.configure"
	// InitProviderInfo Kairos-init will emit this event to get info about the provider version and software.
	InitProviderInfo pluggable.EventType = "init.provider.info"
)

// EventResponseSuccess, EventResponseError and EventResponseNotApplicable are the possible responses to an event.
// You can use whatever you want as a response but we provide this constants so consumers can use the same values.
const (
	EventResponseSuccess       = "success"
	EventResponseError         = "error"
	EventResponseNotApplicable = "non-applicable"
)

// ProviderInstalledVersionPayload is the payload sent by the provider to inform about the software installed.
type ProviderInstalledVersionPayload struct {
	Provider string `json:"provider"` // What provider is installed
	Version  string `json:"version"`  // What version of the provider, can be empty to signal latest
}

// ProviderPayload is the payload sent by the user to request a provider to be installed or configured.
type ProviderPayload struct {
	Provider string `json:"provider"` // What provider the user requested
	Version  string `json:"version"`  // What version of the provider, can be empty to signal latest
	LogLevel string `json:"logLevel"` // The log level to use for the provider
	Config   string `json:"config"`   // The config file to pass to the provider, can be empty if not needed
	Family   string `json:"family"`   // The family of the system, e.g. "alpine", "debian", "rhel", etc.
}

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

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

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

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

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

// AllEvents is a convenience list of all the events streamed from the bus.
var AllEvents = []pluggable.EventType{
	EventBootstrap,
	EventChallenge,
	EventAfterReset,
	EventBeforeReset,
	EventBoot,
	EventInstall,
	EventRecovery,
	EventInteractiveInstall,
	EventRecoveryStop,
	EventAvailableReleases,
	EventVersionImage,
	InitProviderInstall,
	InitProviderConfigure,
	InitProviderInfo,
}

// 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 IsEventDefined(i interface{}, events ...pluggable.EventType) bool {
	checkEvent := func(e pluggable.EventType) bool {
		for _, ee := range append(AllEvents, events...) {
			if ee == e {
				return true
			}
		}

		return false
	}

	switch f := i.(type) {
	case string:
		return checkEvent(pluggable.EventType(f))
	case pluggable.EventType:
		return checkEvent(f)
	default:
		return false
	}
}

func EventError(err error) pluggable.EventResponse {
	return pluggable.EventResponse{Error: err.Error()}
}