Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the metrics v1 API group +kubebuilder:object:generate=true +groupName=metrics.keptn.sh
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "metrics.keptn.sh", Version: "v1"} // 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 IntervalResult ¶
type IntervalResult struct {
// Value represents the resulting value
Value string `json:"value"`
// Range represents the time range for which this data was queried
Range *RangeSpec `json:"range"`
// LastUpdated represents the time when the status data was last updated
LastUpdated metav1.Time `json:"lastUpdated"`
// ErrMsg represents the error details when the query could not be evaluated
// +optional
ErrMsg string `json:"errMsg,omitempty"`
}
func (*IntervalResult) DeepCopy ¶
func (in *IntervalResult) DeepCopy() *IntervalResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IntervalResult.
func (*IntervalResult) DeepCopyInto ¶
func (in *IntervalResult) DeepCopyInto(out *IntervalResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeptnMetric ¶
type KeptnMetric struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// +optional
Spec KeptnMetricSpec `json:"spec,omitempty"`
// +optional
Status KeptnMetricStatus `json:"status,omitempty"`
}
KeptnMetric is the Schema for the keptnmetrics API
func (*KeptnMetric) DeepCopy ¶
func (in *KeptnMetric) DeepCopy() *KeptnMetric
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeptnMetric.
func (*KeptnMetric) DeepCopyInto ¶
func (in *KeptnMetric) DeepCopyInto(out *KeptnMetric)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeptnMetric) DeepCopyObject ¶
func (in *KeptnMetric) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeptnMetricList ¶
type KeptnMetricList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty"`
Items []KeptnMetric `json:"items"`
}
KeptnMetricList contains a list of KeptnMetric resources
func (*KeptnMetricList) DeepCopy ¶
func (in *KeptnMetricList) DeepCopy() *KeptnMetricList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeptnMetricList.
func (*KeptnMetricList) DeepCopyInto ¶
func (in *KeptnMetricList) DeepCopyInto(out *KeptnMetricList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeptnMetricList) DeepCopyObject ¶
func (in *KeptnMetricList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeptnMetricSpec ¶
type KeptnMetricSpec struct {
// Provider represents the provider object
Provider ProviderRef `json:"provider"`
// Query represents the query to be run
Query string `json:"query"`
// FetchIntervalSeconds represents the update frequency in seconds that is used to update the metric
FetchIntervalSeconds uint `json:"fetchIntervalSeconds"`
// Range represents the time range for which data is to be queried
// +optional
Range *RangeSpec `json:"range,omitempty"`
}
KeptnMetricSpec defines the desired state of KeptnMetric
func (*KeptnMetricSpec) DeepCopy ¶
func (in *KeptnMetricSpec) DeepCopy() *KeptnMetricSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeptnMetricSpec.
func (*KeptnMetricSpec) DeepCopyInto ¶
func (in *KeptnMetricSpec) DeepCopyInto(out *KeptnMetricSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeptnMetricStatus ¶
type KeptnMetricStatus struct {
// Value represents the resulting value
// +optional
Value string `json:"value,omitempty"`
// RawValue represents the resulting value in raw format
// +optional
RawValue []byte `json:"rawValue,omitempty"`
// LastUpdated represents the time when the status data was last updated
// +optional
LastUpdated metav1.Time `json:"lastUpdated,omitempty"`
// ErrMsg represents the error details when the query could not be evaluated
// +optional
ErrMsg string `json:"errMsg,omitempty"`
// IntervalResults contain a slice of all the interval results
// +optional
IntervalResults []IntervalResult `json:"intervalResults,omitempty"`
}
KeptnMetricStatus defines the observed state of KeptnMetric
func (*KeptnMetricStatus) DeepCopy ¶
func (in *KeptnMetricStatus) DeepCopy() *KeptnMetricStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeptnMetricStatus.
func (*KeptnMetricStatus) DeepCopyInto ¶
func (in *KeptnMetricStatus) DeepCopyInto(out *KeptnMetricStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProviderRef ¶
type ProviderRef struct {
// Name of the provider
Name string `json:"name"`
}
ProviderRef represents the provider object
func (*ProviderRef) DeepCopy ¶
func (in *ProviderRef) DeepCopy() *ProviderRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderRef.
func (*ProviderRef) DeepCopyInto ¶
func (in *ProviderRef) DeepCopyInto(out *ProviderRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RangeSpec ¶
type RangeSpec struct {
// Interval specifies the duration of the time interval for the data query
// +kubebuilder:default:="5m"
// +optional
Interval string `json:"interval,omitempty"`
// Step represents the query resolution step width for the data query
// +optional
Step string `json:"step,omitempty"`
// Aggregation defines the type of aggregation function to be applied on the data. Accepted values: p90, p95, p99, max, min, avg, median
// +kubebuilder:validation:Enum:=p90;p95;p99;max;min;avg;median
// +optional
Aggregation string `json:"aggregation,omitempty"`
// StoredResults indicates the upper limit of how many past results should be stored in the status of a KeptnMetric
// +kubebuilder:validation:Maximum:=255
// +optional
StoredResults uint `json:"storedResults,omitempty"`
}
RangeSpec defines the time range for which data is to be queried
func (*RangeSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RangeSpec.
func (*RangeSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files