events

Documentation

Index

• func GetListOfEvents() []string
• func HandleErrorWithEvents(err error, successEvent EventType, failEvent EventType)
• func RecordEvent(event EventType)
• type EventType
• type Events

Functions

func GetListOfEvents

func GetListOfEvents() []string

GetListOfEvents gets the list of events that were registered with the event recorder

func HandleErrorWithEvents

func HandleErrorWithEvents(err error, successEvent EventType, failEvent EventType)

HandleErrorWithEvents records events depending on the error state.

func RecordEvent

func RecordEvent(event EventType)

RecordEvent records the given event in the global events instance

Types

type EventType

type EventType string

EventType is the type of event to record

const (

	// InstallSuccessful when the cluster has successfully provisioned.
	InstallSuccessful EventType = "InstallSuccessful"

	// FailedClusterProvision when the cluster has not been successfully provisioned.
	InstallFailed EventType = "InstallFailed"

	// HealthCheckSuccessful when the cluster health check has succeeded.
	HealthCheckSuccessful EventType = "HealthCheckSuccessful"

	// HealthCheckFailed when the cluster health check has failed.
	HealthCheckFailed EventType = "HealthCheckFailed"

	// UpgradeSuccessful when the upgrade was successful.
	UpgradeSuccessful EventType = "UpgradeSuccessful"

	// UpgradeFailed when the upgrade failed.
	UpgradeFailed EventType = "UpgradeFailed"

	// NoHiveLogs when no logs from Hive were collected after a cluster provisioning event.
	NoHiveLogs EventType = "NoHiveLogs"

	// InstallKubeconfigRetrievalSuccess when the Kubeconfig was retrieved successfully.
	InstallKubeconfigRetrievalSuccess EventType = "InstallKubeconfigRetrievalSuccess"

	// InstallKubeconfigRetrievalFailure when the Kubeconfig was not retrieved successfully.
	InstallKubeconfigRetrievalFailure EventType = "InstallKubeconfigRetrievalFailure"

	// InstallAddonsSuccessful when the addons installed successfully.
	InstallAddonsSuccessful EventType = "InstallAddonsSuccessful"

	// InstallAddonsFailed when the addons failed to install.
	InstallAddonsFailed EventType = "InstallAddonsFailed"
)

This file defines different event types. Please add new types here so that we can easily track them.

type Events

type Events struct {
	Events map[string]bool
}

Events records individual events that occur during the execution of osde2e

var Instance *Events

Instance is the global Events instance