v1alpha1

package
v0.0.0-...-2109f09 Latest Latest
Warning

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

 Go to latest Published: Nov 19, 2024 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the monitoring.openshift.io v1alpha1 API group +kubebuilder:object:generate=true +groupName=monitoring.openshift.io

Index

Constants

View Source 
const (
	// The following values should match the kubebuilder-enumerated values for serviceMonitorType above
	ServiceMonitorTypeCoreOS = "monitoring.coreos.com"
	ServiceMonitorTypeRHOBS  = "monitoring.rhobs"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "monitoring.openshift.io", 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

func GetOpenAPIDefinitions 

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

Types

type ClusterDomainRef 

type ClusterDomainRef string

ClusterDomainRef defines the object used determine the cluster's domain By default, 'infra' is used, which references the 'infrastructures/cluster' object 

var (
	// ClusterDomainRefInfra indicates the clusterDomain should be determined from the 'infrastructures/cluster' object
	ClusterDomainRefInfra ClusterDomainRef = "infra"

	// ClusterDomainRefHCP indicates the clusterDomain should be determined from the 'hcp/cluster' object in the same namespace as the ClusterURLMonitor being reconciled
	ClusterDomainRefHCP ClusterDomainRef = "hcp"
)

type ClusterUrlMonitor 

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

	Spec   ClusterUrlMonitorSpec   `json:"spec,omitempty"`
	Status ClusterUrlMonitorStatus `json:"status,omitempty"`
}

ClusterUrlMonitor is the Schema for the clusterurlmonitors API

func (*ClusterUrlMonitor) DeepCopy 

func (in *ClusterUrlMonitor) DeepCopy() *ClusterUrlMonitor

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

func (*ClusterUrlMonitor) DeepCopyInto 

func (in *ClusterUrlMonitor) DeepCopyInto(out *ClusterUrlMonitor)

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

func (*ClusterUrlMonitor) DeepCopyObject 

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

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

type ClusterUrlMonitorList 

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

ClusterUrlMonitorList contains a list of ClusterUrlMonitor

func (*ClusterUrlMonitorList) DeepCopy 

func (in *ClusterUrlMonitorList) DeepCopy() *ClusterUrlMonitorList

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

func (*ClusterUrlMonitorList) DeepCopyInto 

func (in *ClusterUrlMonitorList) DeepCopyInto(out *ClusterUrlMonitorList)

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

func (*ClusterUrlMonitorList) DeepCopyObject 

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

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

type ClusterUrlMonitorSpec 

type ClusterUrlMonitorSpec struct {

	// Foo is an example field of ClusterUrlMonitor. Edit ClusterUrlMonitor_types.go to remove/update
	Prefix string  `json:"prefix,omitempty"`
	Suffix string  `json:"suffix,omitempty"`
	Port   string  `json:"port,omitempty"`
	Slo    SloSpec `json:"slo,omitempty"`
	// +kubebuilder:validation:Enum=infra;hcp
	// +kubebuilder:default:="infra"
	// +optional
	DomainRef ClusterDomainRef `json:"domainRef,omitempty"`

	// SkipPrometheusRule instructs the controller to skip the creation of PrometheusRule CRs.
	// One common use-case for is for alerts that are defined separately, such as for hosted clusters.
	SkipPrometheusRule bool `json:"skipPrometheusRule"`
}

ClusterUrlMonitorSpec defines the desired state of ClusterUrlMonitor

func (*ClusterUrlMonitorSpec) DeepCopy 

func (in *ClusterUrlMonitorSpec) DeepCopy() *ClusterUrlMonitorSpec

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

func (*ClusterUrlMonitorSpec) DeepCopyInto 

func (in *ClusterUrlMonitorSpec) DeepCopyInto(out *ClusterUrlMonitorSpec)

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

type ClusterUrlMonitorStatus 

type ClusterUrlMonitorStatus struct {
	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	ServiceMonitorRef NamespacedName `json:"serviceMonitorRef,omitempty"`
	PrometheusRuleRef NamespacedName `json:"prometheusRuleRef,omitempty"`
	ErrorStatus       string         `json:"errorStatus,omitempty"`
}

ClusterUrlMonitorStatus defines the observed state of ClusterUrlMonitor

func (*ClusterUrlMonitorStatus) DeepCopy 

func (in *ClusterUrlMonitorStatus) DeepCopy() *ClusterUrlMonitorStatus

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

func (*ClusterUrlMonitorStatus) DeepCopyInto 

func (in *ClusterUrlMonitorStatus) DeepCopyInto(out *ClusterUrlMonitorStatus)

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

type NamespacedName 

type NamespacedName struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace"`
}

NamespacedName contains the name of a object and its namespace

func (*NamespacedName) DeepCopy 

func (in *NamespacedName) DeepCopy() *NamespacedName

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

func (*NamespacedName) DeepCopyInto 

func (in *NamespacedName) DeepCopyInto(out *NamespacedName)

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

type RouteMonitor 

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

	Spec   RouteMonitorSpec   `json:"spec,omitempty"`
	Status RouteMonitorStatus `json:"status,omitempty"`
}

RouteMonitor is the Schema for the routemonitors API

func (*RouteMonitor) DeepCopy 

func (in *RouteMonitor) DeepCopy() *RouteMonitor

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

func (*RouteMonitor) DeepCopyInto 

func (in *RouteMonitor) DeepCopyInto(out *RouteMonitor)

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

func (*RouteMonitor) DeepCopyObject 

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

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

type RouteMonitorList 

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

RouteMonitorList contains a list of RouteMonitor

func (*RouteMonitorList) DeepCopy 

func (in *RouteMonitorList) DeepCopy() *RouteMonitorList

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

func (*RouteMonitorList) DeepCopyInto 

func (in *RouteMonitorList) DeepCopyInto(out *RouteMonitorList)

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

func (*RouteMonitorList) DeepCopyObject 

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

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

type RouteMonitorRouteSpec 

type RouteMonitorRouteSpec struct {
	// Name is the name of the Route
	Name string `json:"name,omitempty"`
	// Namespace is the namespace of the Route
	Namespace string `json:"namespace,omitempty"`

	// Port optionally defines the port we should use while probing
	Port int64 `json:"port,omitempty"`

	// Suffix optionally defines the path we should probe (/livez /readyz etc)
	Suffix string `json:"suffix,omitempty"`
}

RouteMonitorRouteSpec references the observed Route resource

func (*RouteMonitorRouteSpec) DeepCopy 

func (in *RouteMonitorRouteSpec) DeepCopy() *RouteMonitorRouteSpec

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

func (*RouteMonitorRouteSpec) DeepCopyInto 

func (in *RouteMonitorRouteSpec) DeepCopyInto(out *RouteMonitorRouteSpec)

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

type RouteMonitorSpec 

type RouteMonitorSpec struct {
	Route RouteMonitorRouteSpec `json:"route,omitempty"`
	Slo   SloSpec               `json:"slo,omitempty"`

	// SkipPrometheusRule instructs the controller to skip the creation of PrometheusRule CRs.
	// One common use-case for is for alerts that are defined separately, such as for hosted clusters.
	SkipPrometheusRule bool `json:"skipPrometheusRule"`

	// InsecureSkipTLSVerify indicates that the blackbox exporter module used to probe this route
	// should *not* use https
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify"`

	// ServiceMonitorType dictates the type of ServiceMonitor the RouteMonitor should create
	ServiceMonitorType string `json:"serviceMonitorType,omitempty"`
}

RouteMonitorSpec defines the desired state of RouteMonitor

func (*RouteMonitorSpec) DeepCopy 

func (in *RouteMonitorSpec) DeepCopy() *RouteMonitorSpec

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

func (*RouteMonitorSpec) DeepCopyInto 

func (in *RouteMonitorSpec) DeepCopyInto(out *RouteMonitorSpec)

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

type RouteMonitorStatus 

type RouteMonitorStatus struct {
	// RouteURL is the url extracted from the Route resource
	RouteURL          string         `json:"routeURL,omitempty"`
	ServiceMonitorRef NamespacedName `json:"serviceMonitorRef,omitempty"`
	PrometheusRuleRef NamespacedName `json:"prometheusRuleRef,omitempty"`
	ErrorStatus       string         `json:"errorStatus,omitempty"`
}

RouteMonitorStatus defines the observed state of RouteMonitor

func (*RouteMonitorStatus) DeepCopy 

func (in *RouteMonitorStatus) DeepCopy() *RouteMonitorStatus

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

func (*RouteMonitorStatus) DeepCopyInto 

func (in *RouteMonitorStatus) DeepCopyInto(out *RouteMonitorStatus)

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

type SloSpec 

type SloSpec struct {
	// TargetAvailabilityPercent defines the percent number to be used
	TargetAvailabilityPercent string `json:"targetAvailabilityPercent"`
}

SloSpec defines what is the percentage

func (*SloSpec) DeepCopy 

func (in *SloSpec) DeepCopy() *SloSpec

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

func (*SloSpec) DeepCopyInto 

func (in *SloSpec) DeepCopyInto(out *SloSpec)

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

func (SloSpec) IsValid 

func (s SloSpec) IsValid() (bool, string)

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.