Documentation ¶
Overview ¶
Package v1beta1 contains API Schema definitions for the observability v1beta1 API group +kubebuilder:object:generate=true +groupName=observability.open-cluster-management.io
Index ¶
- Variables
- type AvailabilityType
- type MultiClusterObservability
- func (dst *MultiClusterObservability) ConvertFrom(srcRaw conversion.Hub) error
- func (src *MultiClusterObservability) ConvertTo(dstRaw conversion.Hub) error
- func (in *MultiClusterObservability) DeepCopy() *MultiClusterObservability
- func (in *MultiClusterObservability) DeepCopyInto(out *MultiClusterObservability)
- func (in *MultiClusterObservability) DeepCopyObject() runtime.Object
- type MultiClusterObservabilityList
- type MultiClusterObservabilitySpec
- type MultiClusterObservabilityStatus
- type ObservabilityAddon
- type ObservabilityAddonList
- type ObservabilityAddonStatus
- type StatusCondition
- type StorageConfigObject
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "observability.open-cluster-management.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 )
Functions ¶
This section is empty.
Types ¶
type AvailabilityType ¶
type AvailabilityType string
AvailabilityType ...
const ( // HABasic stands up most app subscriptions with a replicaCount of 1 HABasic AvailabilityType = "Basic" // HAHigh stands up most app subscriptions with a replicaCount of 2 HAHigh AvailabilityType = "High" )
type MultiClusterObservability ¶
type MultiClusterObservability struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MultiClusterObservabilitySpec `json:"spec,omitempty"` Status MultiClusterObservabilityStatus `json:"status,omitempty"` }
MultiClusterObservability defines the configuration for the Observability installation on Hub and Managed Clusters all through this one custom resource. +kubebuilder:pruning:PreserveUnknownFields +kubebuilder:resource:path=multiclusterobservabilities,scope=Cluster,shortName=mco +operator-sdk:csv:customresourcedefinitions:displayName="MultiClusterObservability"
func (*MultiClusterObservability) ConvertFrom ¶
func (dst *MultiClusterObservability) ConvertFrom(srcRaw conversion.Hub) error
ConvertFrom converts from the Hub version (observabilityv1beta2) to this version.
func (*MultiClusterObservability) ConvertTo ¶
func (src *MultiClusterObservability) ConvertTo(dstRaw conversion.Hub) error
ConvertTo is expected to modify its argument to contain the converted object. Most of the conversion is straightforward copying, except for converting our changed field.
ConvertTo converts this MultiClusterObservability to the Hub version (v1beta2).
func (*MultiClusterObservability) DeepCopy ¶
func (in *MultiClusterObservability) DeepCopy() *MultiClusterObservability
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiClusterObservability.
func (*MultiClusterObservability) DeepCopyInto ¶
func (in *MultiClusterObservability) DeepCopyInto(out *MultiClusterObservability)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MultiClusterObservability) DeepCopyObject ¶
func (in *MultiClusterObservability) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MultiClusterObservabilityList ¶
type MultiClusterObservabilityList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MultiClusterObservability `json:"items"` }
MultiClusterObservabilityList contains a list of MultiClusterObservability
func (*MultiClusterObservabilityList) DeepCopy ¶
func (in *MultiClusterObservabilityList) DeepCopy() *MultiClusterObservabilityList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiClusterObservabilityList.
func (*MultiClusterObservabilityList) DeepCopyInto ¶
func (in *MultiClusterObservabilityList) DeepCopyInto(out *MultiClusterObservabilityList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MultiClusterObservabilityList) DeepCopyObject ¶
func (in *MultiClusterObservabilityList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MultiClusterObservabilitySpec ¶
type MultiClusterObservabilitySpec struct { // ReplicaCount for HA support. Does not affect data stores. // Enabled will toggle HA support. This will provide better support in cases of failover // but consumes more resources. Options are: Basic and High (default). // +optional // +kubebuilder:default:=High AvailabilityConfig AvailabilityType `json:"availabilityConfig,omitempty"` // Enable or disable the downsample. // The default value is false. // This is not recommended as querying long time ranges // without non-downsampled data is not efficient and useful. // +optional // +kubebuilder:default:=false EnableDownSampling bool `json:"enableDownSampling"` // Pull policy of the MultiClusterObservability images // +optional // +kubebuilder:default:=IfNotPresent ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"` // Pull secret of the MultiClusterObservability images // +optional // +kubebuilder:default:=multiclusterhub-operator-pull-secret ImagePullSecret string `json:"imagePullSecret,omitempty"` // Spec of NodeSelector // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // Tolerations causes all components to tolerate any taints. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // How long to retain raw samples in a bucket. // +optional // +kubebuilder:default:="5d" RetentionResolutionRaw string `json:"retentionResolutionRaw,omitempty"` // How long to retain samples of resolution 1 (5 minutes) in bucket. // +optional // +kubebuilder:default:="14d" RetentionResolution5m string `json:"retentionResolution5m,omitempty"` // How long to retain samples of resolution 2 (1 hour) in bucket. // +optional // +kubebuilder:default:="30d" RetentionResolution1h string `json:"retentionResolution1h,omitempty"` // Specifies the storage to be used by Observability // +required StorageConfig *StorageConfigObject `json:"storageConfigObject,omitempty"` // The ObservabilityAddonSpec defines the global settings for all managed // clusters which have observability add-on enabled. // +optional ObservabilityAddonSpec *observabilityshared.ObservabilityAddonSpec `json:"observabilityAddonSpec,omitempty"` }
MultiClusterObservabilitySpec defines the desired state of MultiClusterObservability
func (*MultiClusterObservabilitySpec) DeepCopy ¶
func (in *MultiClusterObservabilitySpec) DeepCopy() *MultiClusterObservabilitySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiClusterObservabilitySpec.
func (*MultiClusterObservabilitySpec) DeepCopyInto ¶
func (in *MultiClusterObservabilitySpec) DeepCopyInto(out *MultiClusterObservabilitySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MultiClusterObservabilityStatus ¶
type MultiClusterObservabilityStatus struct { // Represents the status of each deployment // +optional Conditions []observabilityshared.Condition `json:"conditions,omitempty"` }
MultiClusterObservabilityStatus defines the observed state of MultiClusterObservability
func (*MultiClusterObservabilityStatus) DeepCopy ¶
func (in *MultiClusterObservabilityStatus) DeepCopy() *MultiClusterObservabilityStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiClusterObservabilityStatus.
func (*MultiClusterObservabilityStatus) DeepCopyInto ¶
func (in *MultiClusterObservabilityStatus) DeepCopyInto(out *MultiClusterObservabilityStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ObservabilityAddon ¶
type ObservabilityAddon struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec observabilityshared.ObservabilityAddonSpec `json:"spec,omitempty"` Status ObservabilityAddonStatus `json:"status,omitempty"` }
ObservabilityAddon is the Schema for the observabilityaddon API +kubebuilder:resource:path=observabilityaddons,scope=Namespaced,shortName=oba +operator-sdk:csv:customresourcedefinitions:displayName="ObservabilityAddon"
func (*ObservabilityAddon) DeepCopy ¶
func (in *ObservabilityAddon) DeepCopy() *ObservabilityAddon
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObservabilityAddon.
func (*ObservabilityAddon) DeepCopyInto ¶
func (in *ObservabilityAddon) DeepCopyInto(out *ObservabilityAddon)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ObservabilityAddon) DeepCopyObject ¶
func (in *ObservabilityAddon) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ObservabilityAddonList ¶
type ObservabilityAddonList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ObservabilityAddon `json:"items"` }
ObservabilityAddonList contains a list of ObservabilityAddon
func (*ObservabilityAddonList) DeepCopy ¶
func (in *ObservabilityAddonList) DeepCopy() *ObservabilityAddonList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObservabilityAddonList.
func (*ObservabilityAddonList) DeepCopyInto ¶
func (in *ObservabilityAddonList) DeepCopyInto(out *ObservabilityAddonList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ObservabilityAddonList) DeepCopyObject ¶
func (in *ObservabilityAddonList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ObservabilityAddonStatus ¶
type ObservabilityAddonStatus struct {
Conditions []StatusCondition `json:"conditions"`
}
ObservabilityAddonStatus defines the observed state of ObservabilityAddon
func (*ObservabilityAddonStatus) DeepCopy ¶
func (in *ObservabilityAddonStatus) DeepCopy() *ObservabilityAddonStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObservabilityAddonStatus.
func (*ObservabilityAddonStatus) DeepCopyInto ¶
func (in *ObservabilityAddonStatus) DeepCopyInto(out *ObservabilityAddonStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StatusCondition ¶
type StatusCondition struct { Type string `json:"type"` Status metav1.ConditionStatus `json:"status"` LastTransitionTime metav1.Time `json:"lastTransitionTime"` Reason string `json:"reason"` Message string `json:"message"` }
StatusCondition contains condition information for an observability addon
func (*StatusCondition) DeepCopy ¶
func (in *StatusCondition) DeepCopy() *StatusCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatusCondition.
func (*StatusCondition) DeepCopyInto ¶
func (in *StatusCondition) DeepCopyInto(out *StatusCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StorageConfigObject ¶
type StorageConfigObject struct { // Object store config secret for metrics // +required MetricObjectStorage *observabilityshared.PreConfiguredStorage `json:"metricObjectStorage,omitempty"` // The amount of storage applied to the Observability stateful sets, i.e. // Thanos store, Rule, compact and receiver. // +optional // +kubebuilder:default:="10Gi" StatefulSetSize string `json:"statefulSetSize,omitempty"` // Specify the storageClass Stateful Sets. This storage class will also // be used for Object Storage if MetricObjectStorage was configured for // the system to create the storage. // +optional // +kubebuilder:default:=gp2 StatefulSetStorageClass string `json:"statefulSetStorageClass,omitempty"` }
StorageConfigObject is the spec of object storage.
func (*StorageConfigObject) DeepCopy ¶
func (in *StorageConfigObject) DeepCopy() *StorageConfigObject
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageConfigObject.
func (*StorageConfigObject) DeepCopyInto ¶
func (in *StorageConfigObject) DeepCopyInto(out *StorageConfigObject)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.