v1beta1

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 26, 2024 License: Apache-2.0 Imports: 2 Imported by: 9

Documentation

Overview

Package v1beta1 contains the API Schema definitions for the Flux eventing API. +kubebuilder:object:generate=true

Index

Constants

View Source
const (
	// EventSeverityTrace represents a trace event, usually
	// informing about actions taken during reconciliation.
	EventSeverityTrace string = "trace"
	// EventSeverityInfo represents an informational event, usually
	// informing about changes.
	EventSeverityInfo string = "info"
	// EventSeverityError represent an error event, usually a warning
	// that something goes wrong.
	EventSeverityError string = "error"
)

These constants define valid event severity values.

View Source
const (
	// MetaRevisionKey is the key used to hold the source artifact revision.
	MetaRevisionKey string = "revision"
	// MetaChecksumKey is the key used to hold the source artifact checksum.
	// Deprecated: in favor of MetaDigestKey.
	MetaChecksumKey string = "checksum"
	// MetaDigestKey is the key used to hold the source artifact digest.
	MetaDigestKey string = "digest"
	// MetaTokenKey is the key used to hold an arbitrary token whose contents
	// are defined on a per-event-emitter basis for uniquely identifying the
	// contents of the event payload. For example, it could be the generation
	// of an object, or the hash of a set of configurations, or even a
	// base64-encoded set of configurations. This is useful for example for
	// rate limiting the events.
	MetaTokenKey string = "token"
	// MetaCommitStatusKey is the key used to signal a Git commit status event.
	MetaCommitStatusKey string = "commit_status"
	// MetaCommitStatusUpdateValue is the value of MetaCommitStatusKey
	// used to signal a Git commit status update.
	MetaCommitStatusUpdateValue string = "update"
)

These constants define the Event metadata keys used throughout Flux controllers.

View Source
const EventTypeTrace string = "Trace"

EventTypeTrace represents a trace event.

Variables

This section is empty.

Functions

This section is empty.

Types

type Event

type Event struct {
	// The object that this event is about.
	// +required
	InvolvedObject corev1.ObjectReference `json:"involvedObject"`

	// Severity type of this event (trace, info, error)
	// +kubebuilder:validation:Enum=trace;info;error
	// +required
	Severity string `json:"severity"`

	// The time at which this event was recorded.
	// +required
	Timestamp metav1.Time `json:"timestamp"`

	// A human-readable description of this event.
	// Maximum length 39,000 characters.
	// +kubebuilder:validation:MaxLength=39000
	// +required
	Message string `json:"message"`

	// A machine understandable string that gives the reason
	// for the transition into the object's current status.
	// +required
	Reason string `json:"reason"`

	// Metadata of this event, e.g. apply change set.
	// +optional
	Metadata map[string]string `json:"metadata,omitempty"`

	// Name of the controller that emitted this event, e.g. `source-controller`.
	// +required
	ReportingController string `json:"reportingController"`

	// ID of the controller instance, e.g. `source-controller-xyzf`.
	// +optional
	ReportingInstance string `json:"reportingInstance,omitempty"`
}

Event is a report of an event issued by a controller.

func (*Event) DeepCopy

func (in *Event) DeepCopy() *Event

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Event.

func (*Event) DeepCopyInto

func (in *Event) DeepCopyInto(out *Event)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Event) HasMetadata

func (in *Event) HasMetadata(key string, val string) bool

HasMetadata returns true if the given key/value pair is found in Metadata.

func (*Event) HasReason

func (in *Event) HasReason(reason string) bool

HasReason returns true if the Reason equals the given value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL