v1alpha1

package
v2.0.0-...-6ed2e0c Latest Latest
Warning

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

 Go to latest Published: Dec 13, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the marketplace v1alpha1 API group +kubebuilder:object:generate=true +groupName=marketplace.redhat.com

Index

Constants

View Source 
const (

	// license not accepted condition, operator will not process events
	ConditionNoLicense       status.ConditionType   = "NoLicense"
	ReasonLicenseNotAccepted status.ConditionReason = "LicenseNotAccepted"

	// problem with data upload to data service
	ConditionUploadFailure status.ConditionType   = "UploadFailed"
	ReasonUploadFailed     status.ConditionReason = "UploadFailed"

	// unable to connect to data service
	ConditionConnectionFailure status.ConditionType   = "DataServiceConnectionFailed"
	ReasonConnectionFailure    status.ConditionReason = "DataServiceConnectionFailed"

	// datafilter configuration is invalid
	ConditionDataFilterInvalid status.ConditionType   = "DataFilterInvalid"
	ReasonDataFilterInvalid    status.ConditionReason = "DataFilterInvalid"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "marketplace.redhat.com", Version: "v1alpha1"}

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

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type ApiHandlerConfig 

type ApiHandlerConfig struct {
	// HandlerTimeout is the timeout for the datareporter operator api handler
	HandlerTimeout metav1.Duration `json:"handlerTimeout,omitempty"`

	// ConfirmDelivery configures the api handler
	// true: skips the EventEngine accumulator and generates 1 report with 1 event
	// The handler will wait for 200 OK for DataService delivery before returning 200 OK
	// false: enters the event into the EventEngine accumulator and generates 1 report with N events
	// The handler will return a 200 OK for DataService delivery as long as the event json is valid
	ConfirmDelivery *bool `json:"confirmDelivery,omitempty"`
}

func (*ApiHandlerConfig) DeepCopy 

func (in *ApiHandlerConfig) DeepCopy() *ApiHandlerConfig

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

func (*ApiHandlerConfig) DeepCopyInto 

func (in *ApiHandlerConfig) DeepCopyInto(out *ApiHandlerConfig)

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

type Authorization 

type Authorization struct {
	// URL is the authorization endpoint (https://hostname:port/path).
	URL string `json:"url"`

	// Sets the sources of the headers to pass to the client when calling the authorization URL.
	// +optional
	Header Header `json:"header,omitempty"`

	// Sets the additional header map key to set on the Destination header ("Authorization").
	// +optional
	AuthDestHeader string `json:"authDestHeader,omitempty"`

	// AuthDestHeaderPrefix: the additional prefix map string value to set on the destHeader ("Bearer ").
	// +optional
	AuthDestHeaderPrefix string `json:"authDestHeaderPrefix,omitempty"`

	// TokenExpr is a jsonpath expression used to parse the authorization response in order to extract the token.
	// +optional
	TokenExpr string `json:"tokenExpr,omitempty"`

	// BodyData refers to a SecretKeyRef containing body data to POST to authorization endpoint, such as an api key.
	// +optional
	BodyData SecretKeyRef `json:"bodyData,omitempty"`
}

Authorization defines an endpoint to request a token from.

func (*Authorization) DeepCopy 

func (in *Authorization) DeepCopy() *Authorization

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

func (*Authorization) DeepCopyInto 

func (in *Authorization) DeepCopyInto(out *Authorization)

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

type Certificate 

type Certificate struct {
	// ClientCert refers to the SecretKeyRef that contains the client cert PEM
	ClientCert SecretKeyRef `json:"clientCert,omitempty"`
	// ClientKey refers to the SecretKeyRef that contains the client key PEM
	ClientKey SecretKeyRef `json:"clientKey,omitempty"`
}

Certificate refers to the the X509KeyPair, consisting of the secrets containing the key and cert pem.

func (*Certificate) DeepCopy 

func (in *Certificate) DeepCopy() *Certificate

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

func (*Certificate) DeepCopyInto 

func (in *Certificate) DeepCopyInto(out *Certificate)

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

type ComponentConfig 

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

	ApiHandlerConfig  `json:"apiHandlerConfig,omitempty"`
	EventEngineConfig `json:"eventHandlerConfig,omitempty"`
	ManagerConfig     `json:"managerConfig,omitempty"`
	TLSConfig         `json:"tlsConfig,omitempty"`
	Status            ComponentConfigStatus `json:"status,omitempty"`
}

ComponentConfig is the Schema for the componentconfigs API The TLSConfig in ComponentConfig modifies the TLSConfig of the DataService Client

func NewComponentConfig 

func NewComponentConfig() *ComponentConfig

func (*ComponentConfig) DeepCopy 

func (in *ComponentConfig) DeepCopy() *ComponentConfig

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

func (*ComponentConfig) DeepCopyInto 

func (in *ComponentConfig) DeepCopyInto(out *ComponentConfig)

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

func (*ComponentConfig) DeepCopyObject 

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

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

type ComponentConfigList 

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

ComponentConfigList contains a list of ComponentConfig

func (*ComponentConfigList) DeepCopy 

func (in *ComponentConfigList) DeepCopy() *ComponentConfigList

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

func (*ComponentConfigList) DeepCopyInto 

func (in *ComponentConfigList) DeepCopyInto(out *ComponentConfigList)

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

func (*ComponentConfigList) DeepCopyObject 

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

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

type ComponentConfigStatus 

type ComponentConfigStatus struct {
}

ComponentConfigStatus defines the observed state of ComponentConfig

func (*ComponentConfigStatus) DeepCopy 

func (in *ComponentConfigStatus) DeepCopy() *ComponentConfigStatus

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

func (*ComponentConfigStatus) DeepCopyInto 

func (in *ComponentConfigStatus) DeepCopyInto(out *ComponentConfigStatus)

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

type DataFilter 

type DataFilter struct {
	// +optional
	Selector Selector `json:"selector,omitempty"`
	// +optional
	ManifestType string `json:"manifestType,omitempty"`
	// +optional
	Transformer Transformer `json:"transformer,omitempty"`
	// +optional
	AltDestinations []Destination `json:"altDestinations,omitempty"`
}

DataFilter defines json transformation and alternate event payload destinations based on selector criteria. No Selector indicates match all.

func (*DataFilter) DeepCopy 

func (in *DataFilter) DeepCopy() *DataFilter

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

func (*DataFilter) DeepCopyInto 

func (in *DataFilter) DeepCopyInto(out *DataFilter)

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

type DataReporterConfig 

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

	Spec   DataReporterConfigSpec   `json:"spec,omitempty"`
	Status DataReporterConfigStatus `json:"status,omitempty"`
}

DataReporterConfig is the Schema for the datareporterconfigs API

func (*DataReporterConfig) DeepCopy 

func (in *DataReporterConfig) DeepCopy() *DataReporterConfig

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

func (*DataReporterConfig) DeepCopyInto 

func (in *DataReporterConfig) DeepCopyInto(out *DataReporterConfig)

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

func (*DataReporterConfig) DeepCopyObject 

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

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

type DataReporterConfigList 

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

DataReporterConfigList contains a list of DataReporterConfig

func (*DataReporterConfigList) DeepCopy 

func (in *DataReporterConfigList) DeepCopy() *DataReporterConfigList

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

func (*DataReporterConfigList) DeepCopyInto 

func (in *DataReporterConfigList) DeepCopyInto(out *DataReporterConfigList)

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

func (*DataReporterConfigList) DeepCopyObject 

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

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

type DataReporterConfigSpec 

type DataReporterConfigSpec struct {
	// +optional
	UserConfigs []UserConfig `json:"userConfig,omitempty"`
	// DataFilter to match incoming event payload against.
	// The first Selector match in the DataFilters array will be applied.
	// +optional
	DataFilters []DataFilter `json:"dataFilters,omitempty"`
	// TLSConfig specifies TLS configuration parameters for outbound https requests from the client.
	// +optional
	TLSConfig *TLSConfig `json:"tlsConfig,omitempty"`
	// ConfirmDelivery configures the api handler. Takes priority over configuring ComponentConfig.
	// true: skips the EventEngine accumulator and generates 1 report with 1 event.
	// The handler will wait for 200 OK for DataService delivery before returning 200 OK.
	// false: enters the event into the EventEngine accumulator and generates 1 report with N events.
	// The handler will return a 200 OK for DataService delivery as long as the event json is valid.
	ConfirmDelivery *bool `json:"confirmDelivery,omitempty"`
}

DataReporterConfigSpec defines the desired state of DataReporterConfig.

func (*DataReporterConfigSpec) DeepCopy 

func (in *DataReporterConfigSpec) DeepCopy() *DataReporterConfigSpec

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

func (*DataReporterConfigSpec) DeepCopyInto 

func (in *DataReporterConfigSpec) DeepCopyInto(out *DataReporterConfigSpec)

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

type DataReporterConfigStatus 

type DataReporterConfigStatus struct {
	// Conditions represent the latest available observations of an object's stateconfig
	// +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true
	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:io.kubernetes.conditions"
	// +optional
	Conditions status.Conditions `json:"conditions,omitempty"`
}

DataReporterConfigStatus defines the observed state of DataReporterConfig

func (*DataReporterConfigStatus) DeepCopy 

func (in *DataReporterConfigStatus) DeepCopy() *DataReporterConfigStatus

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

func (*DataReporterConfigStatus) DeepCopyInto 

func (in *DataReporterConfigStatus) DeepCopyInto(out *DataReporterConfigStatus)

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

type Destination 

type Destination struct {
	// Transformer refers to the Transformer to apply.
	// +optional
	Transformer Transformer `json:"transformer,omitempty"`

	// URL is the destination endpoint (https://hostname:port/path).
	URL string `json:"url"`

	// URLSuffixExpr is a jsonpath expression used to parse the event. The result is appended to the destination URL.
	// https://example/path/{URLSuffixExprResult}
	// +optional
	URLSuffixExpr string `json:"urlSuffixExpr,omitempty"`

	// Sets the sources of the headers to pass to the client when calling the destination URL.
	// +optional
	Header Header `json:"header,omitempty"`

	// Sets an optional authorization endpoint to first request a token from.
	// The Authorization endpoint is called if the call to the destination URL results in a 403.
	// +optional
	Authorization Authorization `json:"authorization,omitempty"`
}

Destination defines an additional endpoint to forward a transformed event payload to.

func (*Destination) DeepCopy 

func (in *Destination) DeepCopy() *Destination

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

func (*Destination) DeepCopyInto 

func (in *Destination) DeepCopyInto(out *Destination)

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

type EventEngineConfig 

type EventEngineConfig struct {
	// AccMemoryLimit is the event accumulator memory limit
	AccMemoryLimit resource.Quantity `json:"memoryLimit,omitempty"`

	// MaxFlushTimeout is the max time before events are flushed
	MaxFlushTimeout metav1.Duration `json:"maxFlushTimeout,omitempty"`

	// MaxEventEntries is the max entries per key allowed in the event accumulator
	MaxEventEntries int `json:"maxEventEntries,omitempty"`

	DataServiceTokenFile string `json:"dataServiceTokenFile,omitempty"`

	DataServiceCertFile string `json:"dataServiceCertFile,omitempty"`
}

func (*EventEngineConfig) DeepCopy 

func (in *EventEngineConfig) DeepCopy() *EventEngineConfig

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

func (*EventEngineConfig) DeepCopyInto 

func (in *EventEngineConfig) DeepCopyInto(out *EventEngineConfig)

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

type Header struct {
	// Sets the name of the secret that contains the headers. Secret map key/value pairs will be used for the header.
	// +optional
	Secret corev1.LocalObjectReference `json:"secret,omitempty"`
}

Sources of headers to append to request.

func (*Header) DeepCopy 

func (in *Header) DeepCopy() *Header

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

func (*Header) DeepCopyInto 

func (in *Header) DeepCopyInto(out *Header)

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

type ManagerConfig 

type ManagerConfig struct {
	LeaderElectionID string `json:"leaderElectionId,omitempty"`

	cfg.ControllerManagerConfigurationSpec `json:",inline"`
}

func (*ManagerConfig) DeepCopy 

func (in *ManagerConfig) DeepCopy() *ManagerConfig

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

func (*ManagerConfig) DeepCopyInto 

func (in *ManagerConfig) DeepCopyInto(out *ManagerConfig)

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

type SecretKeyRef 

type SecretKeyRef struct {
	SecretKeyRef *corev1.SecretKeySelector `json:"secretKeyRef,omitempty"`
}

SecretKeyRef refers to a SecretKeySelector

func (*SecretKeyRef) DeepCopy 

func (in *SecretKeyRef) DeepCopy() *SecretKeyRef

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

func (*SecretKeyRef) DeepCopyInto 

func (in *SecretKeyRef) DeepCopyInto(out *SecretKeyRef)

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

type Selector 

type Selector struct {
	// MatchExpressions is a list of jsonpath expressions.
	// To match the Selector, all jsonpath expressions must produce a result (AND).
	// +optional
	MatchExpressions []string `json:"matchExpressions,omitempty"`

	// MatchUsers is a list of users that the dataFilter applies to.
	// If MatchUsers is not specified, the DataFilter applies to all users.
	// +optional
	MatchUsers []string `json:"matchUsers,omitempty"`
}

Selector defines criteria for matching incoming event payload.

func (*Selector) DeepCopy 

func (in *Selector) DeepCopy() *Selector

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

func (*Selector) DeepCopyInto 

func (in *Selector) DeepCopyInto(out *Selector)

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

type TLSConfig 

type TLSConfig struct {
	// CACertsSecret refers to a list of secret keys that contains CA certificates in PEM. crypto/tls Config.RootCAs.
	// +optional
	CACerts []corev1.SecretKeySelector `json:"caCerts,omitempty"`
	// Certificates refers to a list of X509KeyPairs consisting of the client public/private key. crypto/tls Config.Certificates.
	// +optional
	Certificates []Certificate `json:"certificates,omitempty"`
	// If true, skips creation of TLSConfig with certs and creates an empty TLSConfig. crypto/tls Config.InsecureSkipVerify (Defaults to false).
	// +optional
	InsecureSkipVerify bool `json:"insecureSkipVerify,omitempty" protobuf:"varint,4,opt,name=insecureSkipVerify"`
	// CipherSuites is a list of enabled cipher suites. crypto/tls Config.CipherSuites.
	// +optional
	CipherSuites []string `json:"cipherSuites,omitempty"`
	// MinVersion contains the minimum TLS version that is acceptable crypto/tls Config.MinVersion.
	// +optional
	MinVersion string `json:"minVersion,omitempty"`
}

TLSConfig refers to TLS configuration options.

func (*TLSConfig) DeepCopy 

func (in *TLSConfig) DeepCopy() *TLSConfig

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

func (*TLSConfig) DeepCopyInto 

func (in *TLSConfig) DeepCopyInto(out *TLSConfig)

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

type Transformer 

type Transformer struct {
	// type is the transformation engine use
	// supported types: kazaam
	TransformerType string `json:"type,omitempty"`
	// configMapKeyRef refers to the transformation configuration residing in a ConfigMap
	ConfigMapKeyRef *corev1.ConfigMapKeySelector `json:"configMapKeyRef,omitempty" protobuf:"bytes,3,opt,name=configMapKeyRef"`
}

Transformer defines the type of transformer to use, and where to load the transformation configuration from.

func (*Transformer) DeepCopy 

func (in *Transformer) DeepCopy() *Transformer

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

func (*Transformer) DeepCopyInto 

func (in *Transformer) DeepCopyInto(out *Transformer)

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

type UserConfig 

type UserConfig struct {
	// Required.
	UserName string `json:"userName,omitempty"`
	// +optional
	Metadata map[string]string `json:"metadata,omitempty"`
}

UserConfig defines additional metadata added to a specified users report.

func (*UserConfig) DeepCopy 

func (in *UserConfig) DeepCopy() *UserConfig

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

func (*UserConfig) DeepCopyInto 

func (in *UserConfig) DeepCopyInto(out *UserConfig)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.