v1

Documentation

Overview

Package v1 contains API Schema definitions for the eventlogger v1 API group +k8s:deepcopy-gen=package,register +groupName=eventlogger.bakito.ch

Package v1 contains API Schema definitions for the eventlogger v1 API group +k8s:deepcopy-gen=package,register +groupName=eventlogger.bakito.ch

Index

• Variables
• func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
• type EventLogger
  • func (in *EventLogger) DeepCopy() *EventLogger
  • func (in *EventLogger) DeepCopyInto(out *EventLogger)
  • func (in *EventLogger) DeepCopyObject() runtime.Object
  • func (el *EventLogger) UpdateStatus(logger logr.Logger, err error, c client.Client) error
• type EventLoggerList
  • func (in *EventLoggerList) DeepCopy() *EventLoggerList
  • func (in *EventLoggerList) DeepCopyInto(out *EventLoggerList)
  • func (in *EventLoggerList) DeepCopyObject() runtime.Object
• type EventLoggerSpec
  • func (in *EventLoggerSpec) DeepCopy() *EventLoggerSpec
  • func (in *EventLoggerSpec) DeepCopyInto(out *EventLoggerSpec)
• type EventLoggerStatus
  • func (in *EventLoggerStatus) DeepCopy() *EventLoggerStatus
  • func (in *EventLoggerStatus) DeepCopyInto(out *EventLoggerStatus)
• type Kind
  • func (in *Kind) DeepCopy() *Kind
  • func (in *Kind) DeepCopyInto(out *Kind)
• type LogField
  • func (in *LogField) DeepCopy() *LogField
  • func (in *LogField) DeepCopyInto(out *LogField)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "eventlogger.bakito.ch", Version: "v1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

Functions

func GetOpenAPIDefinitions

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

Types

type EventLogger

type EventLogger struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// +optional
	Spec   EventLoggerSpec   `json:"spec"`
	Status EventLoggerStatus `json:"status,omitempty"`
}

EventLogger is the Schema for the eventloggers API +k8s:openapi-gen=true +kubebuilder:resource:path=eventloggers,scope=Namespaced

func (*EventLogger) DeepCopy

func (in *EventLogger) DeepCopy() *EventLogger

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

func (*EventLogger) DeepCopyInto

func (in *EventLogger) DeepCopyInto(out *EventLogger)

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

func (*EventLogger) DeepCopyObject

func (in *EventLogger) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*EventLogger) UpdateStatus

func (el *EventLogger) UpdateStatus(logger logr.Logger, err error, c client.Client) error

UpdateStatus update the status of the current event logger

type EventLoggerList

type EventLoggerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []EventLogger `json:"items"`
}

EventLoggerList contains a list of EventLogger

func (*EventLoggerList) DeepCopy

func (in *EventLoggerList) DeepCopy() *EventLoggerList

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

func (*EventLoggerList) DeepCopyInto

func (in *EventLoggerList) DeepCopyInto(out *EventLoggerList)

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

func (*EventLoggerList) DeepCopyObject

func (in *EventLoggerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type EventLoggerSpec

type EventLoggerSpec struct {

	// Kinds the kinds to log the events for
	// +kubebuilder:validation:MinItems=1
	Kinds []Kind `json:"kinds,omitempty"`

	// EventTypes the event types to log. If empty all events are logged.
	// +kubebuilder:validation:MinItems=0
	EventTypes []string `json:"eventTypes,omitempty"`

	// Labels additional labels for the logger pod
	Labels map[string]string `json:"labels,omitempty"`

	// Labels additional annotations for the logger pod
	Annotations map[string]string `json:"annotations,omitempty"`

	// ScrapeMetrics if true, prometheus scrape annotations are added to the pod
	ScrapeMetrics *bool `json:"scrapeMetrics,omitempty"`

	// Namespace the namespace to watch on, may be an empty string
	// +nullable
	// +optional
	Namespace *string `json:"namespace,omitempty"`

	// ServiceAccount the service account to use for the logger pod
	ServiceAccount string `json:"serviceAccount,omitempty"`

	// LogFields fields ot the event to be logged.
	LogFields []LogField `json:"logFields,omitempty"`
}

EventLoggerSpec defines the desired state of EventLogger +k8s:openapi-gen=true

func (*EventLoggerSpec) DeepCopy

func (in *EventLoggerSpec) DeepCopy() *EventLoggerSpec

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

func (*EventLoggerSpec) DeepCopyInto

func (in *EventLoggerSpec) DeepCopyInto(out *EventLoggerSpec)

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

type EventLoggerStatus

type EventLoggerStatus struct {
	// OperatorVersion the version of the operator that processed the cr
	OperatorVersion string `json:"operatorVersion"`
	// LastProcessed the timestamp the cr was last processed
	LastProcessed metav1.Time `json:"lastProcessed"`

	// Error
	Error string `json:"error,omitempty"`
}

EventLoggerStatus defines the observed state of EventLogger +k8s:openapi-gen=true

func (*EventLoggerStatus) DeepCopy

func (in *EventLoggerStatus) DeepCopy() *EventLoggerStatus

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

func (*EventLoggerStatus) DeepCopyInto

func (in *EventLoggerStatus) DeepCopyInto(out *EventLoggerStatus)

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

type Kind

type Kind struct {
	// +kubebuilder:validation:MinLength=3
	Name string `json:"name"`

	// EventTypes the event types to log. If empty events are logged as defined in spec.
	// +kubebuilder:validation:MinItems=0
	EventTypes []string `json:"eventTypes,omitempty"`

	// MatchingPatterns optional regex pattern that must be contained in the message to be logged
	// +kubebuilder:validation:MinItems=0
	MatchingPatterns []string `json:"matchingPatterns,omitempty"`

	// SkipOnMatch skip the entry if matched
	SkipOnMatch *bool `json:"skipOnMatch,omitempty"`
}

Kind defines a kind to loge events for +k8s:openapi-gen=true

func (*Kind) DeepCopy

func (in *Kind) DeepCopy() *Kind

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

func (*Kind) DeepCopyInto

func (in *Kind) DeepCopyInto(out *Kind)

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

type LogField

type LogField struct {
	// Name of the log field
	Name string `json:"name"`
	// Path within the corev1.Event struct https://github.com/kubernetes/api/blob/master/core/v1/types.go
	// +kubebuilder:validation:MinItems=1
	Path []string `json:"path,omitempty"`
}

Kind defines a kind to loge events for +k8s:openapi-gen=true

func (*LogField) DeepCopy

func (in *LogField) DeepCopy() *LogField

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

func (*LogField) DeepCopyInto

func (in *LogField) DeepCopyInto(out *LogField)

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