Documentation
¶
Overview ¶
Package v1beta1 contains API Schema definitions for the kuadrant v1beta1 API group +kubebuilder:object:generate=true +groupName=kuadrant.io
Index ¶
- Variables
- func ControllerObjectToMachineryObject(cObj controller.Object) machinery.Object
- func LinkKuadrantToAuthorino(objs controller.Store) machinery.LinkFunc
- func LinkKuadrantToGatewayClasses(objs controller.Store) machinery.LinkFunc
- func LinkKuadrantToLimitador(objs controller.Store) machinery.LinkFunc
- func LinkKuadrantToPodMonitor(objs controller.Store) machinery.LinkFunc
- func LinkKuadrantToServiceMonitor(objs controller.Store) machinery.LinkFunc
- func LinkLimitadorToDeployment(objs controller.Store) machinery.LinkFunc
- type Components
- type DataPlane
- type DeveloperPortal
- type Kuadrant
- func (in *Kuadrant) DeepCopy() *Kuadrant
- func (in *Kuadrant) DeepCopyInto(out *Kuadrant)
- func (in *Kuadrant) DeepCopyObject() runtime.Object
- func (k *Kuadrant) GetLocator() string
- func (k *Kuadrant) IsDeveloperPortalEnabled() bool
- func (k *Kuadrant) IsMTLSAuthorinoEnabled() bool
- func (k *Kuadrant) IsMTLSLimitadorEnabled() bool
- type KuadrantList
- type KuadrantSpec
- type KuadrantStatus
- type LogLevel
- type MTLS
- type Observability
- type Tracing
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "kuadrant.io", Version: "v1beta1"} // 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 )
var ( KuadrantGroupKind = schema.GroupKind{Group: GroupVersion.Group, Kind: "Kuadrant"} KuadrantsResource = GroupVersion.WithResource("kuadrants") )
var ( LimitadorGroupKind = schema.GroupKind{Group: limitadorv1alpha1.GroupVersion.Group, Kind: "Limitador"} AuthorinoGroupKind = schema.GroupKind{Group: authorinooperatorv1beta1.GroupVersion.Group, Kind: "Authorino"} LimitadorsResource = limitadorv1alpha1.GroupVersion.WithResource("limitadors") AuthorinosResource = authorinooperatorv1beta1.GroupVersion.WithResource("authorinos") DeploymentGroupKind = appsv1.SchemeGroupVersion.WithKind("Deployment").GroupKind() DeploymentsResource = appsv1.SchemeGroupVersion.WithResource("deployments") )
Functions ¶
func ControllerObjectToMachineryObject ¶ added in v1.3.0
func ControllerObjectToMachineryObject(cObj controller.Object) machinery.Object
func LinkKuadrantToAuthorino ¶
func LinkKuadrantToAuthorino(objs controller.Store) machinery.LinkFunc
func LinkKuadrantToGatewayClasses ¶
func LinkKuadrantToGatewayClasses(objs controller.Store) machinery.LinkFunc
func LinkKuadrantToLimitador ¶
func LinkKuadrantToLimitador(objs controller.Store) machinery.LinkFunc
func LinkKuadrantToPodMonitor ¶ added in v1.1.0
func LinkKuadrantToPodMonitor(objs controller.Store) machinery.LinkFunc
func LinkKuadrantToServiceMonitor ¶ added in v1.1.0
func LinkKuadrantToServiceMonitor(objs controller.Store) machinery.LinkFunc
func LinkLimitadorToDeployment ¶ added in v1.3.0
func LinkLimitadorToDeployment(objs controller.Store) machinery.LinkFunc
Types ¶
type Components ¶ added in v1.4.0
type Components struct {
// +optional
// DeveloperPortal enables the developer portal integration including APIProduct and APIKeyRequest CRDs
DeveloperPortal *DeveloperPortal `json:"developerPortal,omitempty"`
}
func (*Components) DeepCopy ¶ added in v1.4.0
func (in *Components) DeepCopy() *Components
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Components.
func (*Components) DeepCopyInto ¶ added in v1.4.0
func (in *Components) DeepCopyInto(out *Components)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DataPlane ¶ added in v1.4.0
type DataPlane struct {
// DefaultLevels specifies the default logging levels and their activation predicates.
// Each entry defines a log level (debug, info, warn, error) and an optional CEL expression
// that determines when that level should be active for a given request.
// +optional
DefaultLevels []LogLevel `json:"defaultLevels,omitempty"`
// HTTPHeaderIdentifier specifies the HTTP header name used to identify and correlate
// requests in logs and traces (e.g., "x-request-id", "x-correlation-id").
// If set, this header value will be included in log output for request correlation.
// +optional
HTTPHeaderIdentifier *string `json:"httpHeaderIdentifier"`
}
DataPlane configures logging and observability for data plane components. It controls logging behavior and request-level observability features.
func (*DataPlane) DeepCopy ¶ added in v1.4.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DataPlane.
func (*DataPlane) DeepCopyInto ¶ added in v1.4.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DeveloperPortal ¶ added in v1.4.0
type DeveloperPortal struct {
Enabled bool `json:"enabled,omitempty"`
}
func (*DeveloperPortal) DeepCopy ¶ added in v1.4.0
func (in *DeveloperPortal) DeepCopy() *DeveloperPortal
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeveloperPortal.
func (*DeveloperPortal) DeepCopyInto ¶ added in v1.4.0
func (in *DeveloperPortal) DeepCopyInto(out *DeveloperPortal)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Kuadrant ¶
type Kuadrant struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KuadrantSpec `json:"spec,omitempty"`
Status KuadrantStatus `json:"status,omitempty"`
}
Kuadrant configures installations of Kuadrant Service Protection components
func (*Kuadrant) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Kuadrant.
func (*Kuadrant) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Kuadrant) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Kuadrant) GetLocator ¶
func (*Kuadrant) IsDeveloperPortalEnabled ¶ added in v1.4.0
func (*Kuadrant) IsMTLSAuthorinoEnabled ¶ added in v1.3.0
func (*Kuadrant) IsMTLSLimitadorEnabled ¶ added in v1.3.0
type KuadrantList ¶
type KuadrantList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Kuadrant `json:"items"`
}
KuadrantList contains a list of Kuadrant
func (*KuadrantList) DeepCopy ¶
func (in *KuadrantList) DeepCopy() *KuadrantList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KuadrantList.
func (*KuadrantList) DeepCopyInto ¶
func (in *KuadrantList) DeepCopyInto(out *KuadrantList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KuadrantList) DeepCopyObject ¶
func (in *KuadrantList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KuadrantSpec ¶
type KuadrantSpec struct {
Observability Observability `json:"observability,omitempty"`
// +optional
// MTLS is an optional entry which when enabled is set to true, kuadrant-operator
// will add the configuration required to enable mTLS between an Istio provided
// gateway and the Kuadrant components.
MTLS *MTLS `json:"mtls,omitempty"`
// +optional
// Components configures optional Kuadrant components
Components *Components `json:"components,omitempty"`
}
KuadrantSpec defines the desired state of Kuadrant
func (*KuadrantSpec) DeepCopy ¶
func (in *KuadrantSpec) DeepCopy() *KuadrantSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KuadrantSpec.
func (*KuadrantSpec) DeepCopyInto ¶
func (in *KuadrantSpec) DeepCopyInto(out *KuadrantSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KuadrantStatus ¶
type KuadrantStatus struct {
// ObservedGeneration reflects the generation of the most recently observed spec.
// +optional
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
// Represents the observations of a foo's current state.
// Known .status.conditions.type are: "Available"
// +patchMergeKey=type
// +patchStrategy=merge
// +listType=map
// +listMapKey=type
Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
// Mtls Authorino reflects the mtls feature state regarding comms with authorino.
// +optional
MtlsAuthorino *bool `json:"mtlsAuthorino,omitempty"`
// Mtls Limitador reflects the mtls feature state regarding comms with limitador.
// +optional
MtlsLimitador *bool `json:"mtlsLimitador,omitempty"`
}
KuadrantStatus defines the observed state of Kuadrant
func (*KuadrantStatus) DeepCopy ¶
func (in *KuadrantStatus) DeepCopy() *KuadrantStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KuadrantStatus.
func (*KuadrantStatus) DeepCopyInto ¶
func (in *KuadrantStatus) DeepCopyInto(out *KuadrantStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KuadrantStatus) Equals ¶
func (r *KuadrantStatus) Equals(other *KuadrantStatus, logger logr.Logger) bool
type LogLevel ¶ added in v1.4.0
type LogLevel struct {
// Debug level - highest verbosity
// +optional
Debug *string `json:"debug,omitempty"`
// Info level
// +optional
Info *string `json:"info,omitempty"`
// Warn level
// +optional
Warn *string `json:"warn,omitempty"`
// Error level - lowest verbosity
// +optional
Error *string `json:"error,omitempty"`
}
LogLevel defines a logging level with its activation predicate Only one field should be set per LogLevel entry
func (*LogLevel) DeepCopy ¶ added in v1.4.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LogLevel.
func (*LogLevel) DeepCopyInto ¶ added in v1.4.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MTLS ¶ added in v1.3.0
type MTLS struct {
Enable bool `json:"enable,omitempty"`
// +optional
Authorino *bool `json:"authorino,omitempty"`
// +optional
Limitador *bool `json:"limitador,omitempty"`
}
func (*MTLS) DeepCopy ¶ added in v1.3.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MTLS.
func (*MTLS) DeepCopyInto ¶ added in v1.3.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MTLS) IsAuthorinoEnabled ¶ added in v1.3.0
func (*MTLS) IsLimitadorEnabled ¶ added in v1.3.0
type Observability ¶ added in v1.1.0
type Observability struct {
// Enable controls whether observability features are active.
// When false, no additional logging or tracing configuration is applied.
Enable bool `json:"enable,omitempty"`
// DataPlane configures observability settings for the data plane components.
// +optional
DataPlane *DataPlane `json:"dataPlane,omitempty"`
// Tracing configures distributed tracing for request flows through the system.
// +optional
Tracing *Tracing `json:"tracing"`
}
Observability configures telemetry and monitoring settings for Kuadrant components. When enabled, it configures logging, tracing, and other observability features for both the control plane and data plane components.
func (*Observability) DeepCopy ¶ added in v1.1.0
func (in *Observability) DeepCopy() *Observability
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Observability.
func (*Observability) DeepCopyInto ¶ added in v1.1.0
func (in *Observability) DeepCopyInto(out *Observability)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Tracing ¶ added in v1.4.0
type Tracing struct {
// DefaultEndpoint is the default URL of the tracing collector backend where spans should be sent.
// This endpoint is used by Auth (Authorino), RateLimiting (Limitador) and WASM services for exporting trace data.
// If tracing endpoints have been configured directly in Authorino or Limitador CRs, those take precedence
// over this default value.
// Note: Per-gateway overrides are not currently supported.
DefaultEndpoint string `json:"defaultEndpoint,omitempty"`
// Insecure controls whether to skip TLS certificate verification.
Insecure bool `json:"insecure,omitempty"`
}
Tracing configures distributed tracing integration for request flows. It enables tracing spans to be exported to external tracing systems (e.g., Jaeger, Zipkin).
func (*Tracing) DeepCopy ¶ added in v1.4.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tracing.
func (*Tracing) DeepCopyInto ¶ added in v1.4.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.