events

Documentation

Index

• func IsEventDisabled(name EventName) bool
• type Event
• type EventConfig
• type EventName
• type EventRecorder
  • func NewEventRecorder(c client.Writer, s *runtime.Scheme, o EventRecorderOptions) EventRecorder
• type EventRecorderOptions
• type EventSchema
  • func GetEvent(name EventName) (*EventSchema, error)
• type EventType

Functions

func IsEventDisabled

func IsEventDisabled(name EventName) bool

Types

type Event

type Event struct {
	// Object is the reference of the k8s object which this event corresponds to
	Object runtime.Object
	// RelatedObject is the ref to related object (optional)
	RelatedObject runtime.Object
	// ReportingInstance is the name of the reporting instance
	ReportingInstance string
	// Name is the name of the event to be looked up in event schema
	Name EventName
}

type EventConfig

type EventConfig struct {
	DisabledEvents []string
}

type EventName

type EventName string

var (
	EventLicenseSecretNotFound                                        EventName = "LicenseSecretNotFound"
	EventMachineFileNotFound                                          EventName = "MachineFileNotFound"
	EventMachineFileInvalid                                           EventName = "MachineFileInvalid"
	EventLicenseKeyInvalid                                            EventName = "LicenseKeyInvalid"
	EventLicenseExpired                                               EventName = "LicenseExpired"
	EventLicenseExpiredGracePeriodOn                                  EventName = "LicenseExpiredGracePeriodOn"
	EventMachineFingerPrintErr                                        EventName = "MachineFingerPrintErr"
	EventGotMachineFingerPrint                                        EventName = "GotMachineFingerPrint"
	EventConfigMapErr                                                 EventName = "ConfigMapErr"
	EventGotConfigMap                                                 EventName = "GotConfigMap"
	EventLicenseProxyUnreachable                                      EventName = "LicenseProxyUnreachable"
	EventLicenseDeployError                                           EventName = "LicenseDeployError"
	EventLicenseDeploySuccess                                         EventName = "LicenseDeploySuccess"
	EventClusterMetadataCollectionFailed                              EventName = "ClusterMetadataCollectionFailed"
	EventClusterMetadataCollectionSuccess                             EventName = "ClusterMetadataCollectionSuccess"
	EventLicenseDataFetchError                                        EventName = "LicenseDataFetchError"
	EventLicenseDataFetchSuccess                                      EventName = "LicenseDataFetchSuccess"
	EventLicenseSecretCreationFailed                                  EventName = "LicenseSecretCreationFailed"
	EventLicenseSecretCreationSuccess                                 EventName = "LicenseSecretCreationSuccess"
	EventProjectDeleted                                               EventName = "ProjectDeleted"
	EventProjectDeletionFailed                                        EventName = "ProjectDeletionFailed"
	EventClusterDeleted                                               EventName = "ClusterDeleted"
	EventClusterDeletionFailed                                        EventName = "ClusterDeletionFailed"
	EventSliceConfigDeleted                                           EventName = "SliceConfigDeleted"
	EventSliceConfigDeletionFailed                                    EventName = "SliceConfigDeletionFailed"
	EventServiceExportConfigDeleted                                   EventName = "ServiceExportConfigDeleted"
	EventServiceExportConfigDeletionFailed                            EventName = "ServiceExportConfigDeletionFailed"
	EventSliceQoSConfigDeleted                                        EventName = "SliceQoSConfigDeleted"
	EventSliceQoSConfigDeletionFailed                                 EventName = "SliceQoSConfigDeletionFailed"
	EventSecretDeleted                                                EventName = "SecretDeleted"
	EventSecretDeletionFailed                                         EventName = "SecretDeletionFailed"
	EventNamespaceCreated                                             EventName = "NamespaceCreated"
	EventNamespaceCreationFailed                                      EventName = "NamespaceCreationFailed"
	EventNamespaceDeleted                                             EventName = "NamespaceDeleted"
	EventNamespaceDeletionFailed                                      EventName = "NamespaceDeletionFailed"
	EventWorkerClusterRoleCreated                                     EventName = "WorkerClusterRoleCreated"
	EventWorkerClusterRoleCreationFailed                              EventName = "WorkerClusterRoleCreationFailed"
	EventWorkerClusterRoleUpdated                                     EventName = "WorkerClusterRoleUpdated"
	EventWorkerClusterRoleUpdateFailed                                EventName = "WorkerClusterRoleUpdateFailed"
	EventReadOnlyRoleCreated                                          EventName = "ReadOnlyRoleCreated"
	EventReadOnlyRoleCreationFailed                                   EventName = "ReadOnlyRoleCreationFailed"
	EventReadOnlyRoleUpdated                                          EventName = "ReadOnlyRoleUpdated"
	EventReadOnlyRoleUpdateFailed                                     EventName = "ReadOnlyRoleUpdateFailed"
	EventReadWriteRoleCreated                                         EventName = "ReadWriteRoleCreated"
	EventReadWriteRoleCreationFailed                                  EventName = "ReadWriteRoleCreationFailed"
	EventReadWriteRoleUpdated                                         EventName = "ReadWriteRoleUpdated"
	EventReadWriteRoleUpdateFailed                                    EventName = "ReadWriteRoleUpdateFailed"
	EventServiceAccountCreated                                        EventName = "ServiceAccountCreated"
	EventServiceAccountCreationFailed                                 EventName = "ServiceAccountCreationFailed"
	EventServiceAccountSecretCreated                                  EventName = "ServiceAccountSecretCreated"
	EventServiceAccountSecretCreationFailed                           EventName = "ServiceAccountSecretCreationFailed"
	EventDefaultRoleBindingCreated                                    EventName = "DefaultRoleBindingCreated"
	EventDefaultRoleBindingCreationFailed                             EventName = "DefaultRoleBindingCreationFailed"
	EventDefaultRoleBindingUpdated                                    EventName = "DefaultRoleBindingUpdated"
	EventDefaultRoleBindingUpdateFailed                               EventName = "DefaultRoleBindingUpdateFailed"
	EventDefaultRoleBindingDeleted                                    EventName = "DefaultRoleBindingDeleted"
	EventDefaultRoleBindingDeletionFailed                             EventName = "DefaultRoleBindingDeletionFailed"
	EventInactiveRoleBindingDeleted                                   EventName = "InactiveRoleBindingDeleted"
	EventInactiveRoleBindingDeletionFailed                            EventName = "InactiveRoleBindingDeletionFailed"
	EventInactiveServiceAccountDeleted                                EventName = "InactiveServiceAccountDeleted"
	EventInactiveServiceAccountDeletionFailed                         EventName = "InactiveServiceAccountDeletionFailed"
	EventServiceAccountDeleted                                        EventName = "ServiceAccountDeleted"
	EventServiceAccountDeletionFailed                                 EventName = "ServiceAccountDeletionFailed"
	EventDefaultDeploymentSliceRoleTemplateCreationFailed             EventName = "DefaultDeploymentSliceRoleTemplateCreationFailed"
	EventDefaultDeploymentSliceRoleTemplateCreated                    EventName = "DefaultDeploymentSliceRoleTemplateCreated"
	EventDefaultReaderSliceRoleTemplateCreationFailed                 EventName = "DefaultReaderSliceRoleTemplateCreationFailed"
	EventDefaultReaderSliceRoleTemplateCreated                        EventName = "DefaultReaderSliceRoleTemplateCreated"
	EventSliceResourceQuotaCreationFailed                             EventName = "SliceResourceQuotaCreationFailed"
	EventSliceResourceQuotaCreatedOnSliceConfigCreation               EventName = "SliceResourceQuotaCreatedOnSliceConfigCreation"
	EventSliceNodeAffinityDeletionFailed                              EventName = "SliceNodeAffinityDeletionFailed"
	EventSliceNodeAffinityDeleted                                     EventName = "SliceNodeAffinityDeleted"
	EventSetSliceConfigAsOwnerOfSliceNodeAffinityFailed               EventName = "SetSliceConfigAsOwnerOfSliceNodeAffinityFailed"
	EventSetSliceConfigAsOwnerOfSliceNodeAffinitySucceeded            EventName = "SetSliceConfigAsOwnerOfSliceNodeAffinitySucceeded"
	EventSliceResourceQuotaDeletionFailed                             EventName = "SliceResourceQuotaDeletionFailed"
	EventSliceResourceQuotaDeleted                                    EventName = "SliceResourceQuotaDeleted"
	EventSliceResourceQuotaRecreationFailed                           EventName = "SliceResourceQuotaRecreationFailed"
	EventSliceResourceQuotaRecreated                                  EventName = "SliceResourceQuotaRecreated"
	EventSetSliceConfigAsOwnerOfSliceResourceQuotaFailed              EventName = "SetSliceConfigAsOwnerOfSliceResourceQuotaFailed"
	EventSetSliceConfigAsOwnerOfSliceResourceQuotaSucceeded           EventName = "SetSliceConfigAsOwnerOfSliceResourceQuotaSucceeded"
	EventSliceResourceQuotaCreated                                    EventName = "SliceResourceQuotaCreated"
	EventSliceResourceQuotaUpdated                                    EventName = "SliceResourceQuotaUpdated"
	EventAllRQSpecificationViolationMetricsResetSuccess               EventName = "AllRQSpecificationViolationMetricsResetSuccess"
	EventSliceRQSpecificationViolationMetricsResetSuccess             EventName = "SliceRQSpecificationViolationMetricsResetSuccess"
	EventClusterRQSpecificationViolationMetricsResetSuccess           EventName = "ClusterRQSpecificationViolationMetricsResetSuccess"
	EventOutdatedNamespaceRQSpecificationViolationMetricsResetSuccess EventName = "OutdatedNamespaceRQSpecificationViolationMetricsResetSuccess"
	EventOutdatedClusterRQSpecificationViolationMetricsResetSuccess   EventName = "OutdatedClusterRQSpecificationViolationMetricsResetSuccess"
	EventSliceRoleBindingDeletingFailed                               EventName = "SliceRoleBindingDeletingFailed"
	EventSliceRoleBindingDeleted                                      EventName = "SliceRoleBindingDeleted"
	EventSetSliceConfigAsOwnerOfSliceRoleBindingFailed                EventName = "SetSliceConfigAsOwnerOfSliceRoleBindingFailed"
	EventSetSliceConfigAsOwnerOfSliceRoleBindingSucceeded             EventName = "SetSliceConfigAsOwnerOfSliceRoleBindingSucceeded"
	EventSliceRoleTemplateDeletionFailed                              EventName = "SliceRoleTemplateDeletionFailed"
	EventSliceRoleTemplateDeleted                                     EventName = "SliceRoleTemplateDeleted"
	EventWorkerSliceRoleBindingReconciliationSuccess                  EventName = "WorkerSliceRoleBindingReconciliationSuccess"
	EventWorkerSliceNodeAffinityDeletedForcefully                     EventName = "WorkerSliceNodeAffinityDeletedForcefully"
	EventWorkerSliceNodeAffinityRecreationFailed                      EventName = "WorkerSliceNodeAffinityRecreationFailed"
	EventWorkerSliceNodeAffinityRecreated                             EventName = "WorkerSliceNodeAffinityRecreated"
	EventNodeAffinityRilesExpansionFailed                             EventName = "NodeAffinityRilesExpansionFailed"
	EventSliceNodeAffinityConfigDeepCopyFailed                        EventName = "SliceNodeAffinityConfigDeepCopyFailed"
	EventWorkerSliceNodeAffinityCreationFailed                        EventName = "WorkerSliceNodeAffinityCreationFailed"
	EventWorkerSliceNodeAffinityCreated                               EventName = "WorkerSliceNodeAffinityCreated"
	EventWorkerSliceNodeAffinityUpdateFailed                          EventName = "WorkerSliceNodeAffinityUpdateFailed"
	EventWorkerSliceNodeAffinityUpdated                               EventName = "WorkerSliceNodeAffinityUpdated"
	EventWorkerSliceNodeAffinityDeletionFailed                        EventName = "WorkerSliceNodeAffinityDeletionFailed"
	EventWorkerSliceNodeAffinityDeleted                               EventName = "WorkerSliceNodeAffinityDeleted"
	EventWorkerSliceResourceQuotaDeletedForcefully                    EventName = "WorkerSliceResourceQuotaDeletedForcefully"
	EventWorkerSliceResourceQuotaRecreationFailed                     EventName = "WorkerSliceResourceQuotaRecreationFailed"
	EventWorkerSliceResourceQuotaRecreated                            EventName = "WorkerSliceResourceQuotaRecreated"
	EventOffBoardedNamespaceUtilizationMetricsReset                   EventName = "OffBoardedNamespaceUtilizationMetricsReset"
	EventResourceQuotaMetricsPopulated                                EventName = "ResourceQuotaMetricsPopulated"
	EventClusterCPULimitViolated                                      EventName = "ClusterCPULimitViolated"
	EventClusterMemoryLimitViolated                                   EventName = "ClusterMemoryLimitViolated"
	EventClusterPodCountViolated                                      EventName = "ClusterPodCountViolated"
	EventClusterEphemeralStorageLimitViolated                         EventName = "ClusterEphemeralStorageLimitViolated"
	EventClusterCPURequestViolated                                    EventName = "ClusterCPURequestViolated"
	EventClusterMemoryRequestViolated                                 EventName = "ClusterMemoryRequestViolated"
	EventClusterEphemeralStorageRequestViolated                       EventName = "ClusterEphemeralStorageRequestViolated"
	EventNamespaceCPULimitViolated                                    EventName = "NamespaceCPULimitViolated"
	EventNamespaceMemoryLimitViolated                                 EventName = "NamespaceMemoryLimitViolated"
	EventNamespacePodCountViolated                                    EventName = "NamespacePodCountViolated"
	EventNamespaceEphemeralStorageLimitViolated                       EventName = "NamespaceEphemeralStorageLimitViolated"
	EventNamespaceCPURequestViolated                                  EventName = "NamespaceCPURequestViolated"
	EventNamespaceMemoryRequestViolated                               EventName = "NamespaceMemoryRequestViolated"
	EventNamespaceEphemeralStorageRequestViolated                     EventName = "NamespaceEphemeralStorageRequestViolated"
	EventSliceCPULimitViolated                                        EventName = "SliceCPULimitViolated"
	EventSliceMemoryLimitViolated                                     EventName = "SliceMemoryLimitViolated"
	EventSlicePodCountViolated                                        EventName = "SlicePodCountViolated"
	EventSliceEphemeralStorageLimitViolated                           EventName = "SliceEphemeralStorageLimitViolated"
	EventSliceCPURequestViolated                                      EventName = "SliceCPURequestViolated"
	EventSliceMemoryRequestViolated                                   EventName = "SliceMemoryRequestViolated"
	EventSliceEphemeralStorageRequestViolated                         EventName = "SliceEphemeralStorageRequestViolated"
	EventWorkerSliceResourceQuotaCreationFailed                       EventName = "WorkerSliceResourceQuotaCreationFailed"
	EventWorkerSliceResourceQuotaCreated                              EventName = "WorkerSliceResourceQuotaCreated"
	EventWorkerSliceResourceQuotaUpdateFailed                         EventName = "WorkerSliceResourceQuotaUpdateFailed"
	EventWorkerSliceResourceQuotaUpdated                              EventName = "WorkerSliceResourceQuotaUpdated"
	EventWorkerSliceResourceQuotaDeletionFailed                       EventName = "WorkerSliceResourceQuotaDeletionFailed"
	EventWorkerSliceResourceQuotaDeleted                              EventName = "WorkerSliceResourceQuotaDeleted"
	EventWorkerSliceRoleBindingDeletedForcefully                      EventName = "WorkerSliceRoleBindingDeletedForcefully"
	EventWorkerSliceRoleBindingRecreationFailed                       EventName = "WorkerSliceRoleBindingRecreationFailed"
	EventWorkerSliceRoleBindingRecreated                              EventName = "WorkerSliceRoleBindingRecreated"
	EventWorkerSliceRoleBindingCreationFailed                         EventName = "WorkerSliceRoleBindingCreationFailed"
	EventWorkerSliceRoleBindingCreated                                EventName = "WorkerSliceRoleBindingCreated"
	EventWorkerSliceRoleBindingUpdateFailed                           EventName = "WorkerSliceRoleBindingUpdateFailed"
	EventWorkerSliceRoleBindingUpdated                                EventName = "WorkerSliceRoleBindingUpdated"
	EventWorkerSliceRoleBindingDeletionFailed                         EventName = "WorkerSliceRoleBindingDeletionFailed"
	EventWorkerSliceRoleBindingDeleted                                EventName = "WorkerSliceRoleBindingDeleted"
	EventNetPolViolation                                              EventName = "NetPolViolation"
	EventClusterUnhealthy                                             EventName = "ClusterUnhealthy"
	EventClusterHealthy                                               EventName = "ClusterHealthy"
)

type EventRecorder

type EventRecorder interface {
	// RecordEvent is used to record a new event
	RecordEvent(context.Context, *Event) error
	// WithSlice returns a new recorder with slice name added
	WithSlice(string) EventRecorder
	// WithNamespace returns a new recorder with namespace name added
	WithNamespace(string) EventRecorder
}

EventRecorder is used to record events from a component

func NewEventRecorder

func NewEventRecorder(c client.Writer, s *runtime.Scheme, o EventRecorderOptions) EventRecorder

type EventRecorderOptions

type EventRecorderOptions struct {
	// Version is the version of the component
	Version string
	// Cluster  is the name of the cluster
	Cluster string
	// Project is the name of the project
	Project string
	// Slice is the name of the slice (optional)
	Slice string
	// Namespace is the namespace this event recorder corresponds to (optional)
	Namespace string
	// Component is the component which uses the event recorder
	Component string
}

type EventSchema

type EventSchema struct {
	Name                EventName
	Reason              string
	Action              string
	Type                EventType
	ReportingController string `yaml:"reportingController"`
	Message             string
}

func GetEvent

func GetEvent(name EventName) (*EventSchema, error)

type EventType

type EventType string

var (
	EventTypeWarning EventType = "Warning"
	EventTypeNormal  EventType = "Normal"
)