v1alpha1

Documentation

Overview

Package v1alpha1 contains the v1alpha1 group Sample resources of the cortex provider. +kubebuilder:object:generate=true +groupName=rules.cortex.crossplane.io +versionName=v1alpha1

Index

• Constants
• Variables
• type RuleGroup
  • func (in *RuleGroup) DeepCopy() *RuleGroup
  • func (in *RuleGroup) DeepCopyInto(out *RuleGroup)
  • func (in *RuleGroup) DeepCopyObject() runtime.Object
  • func (mg *RuleGroup) GetCondition(ct xpv1.ConditionType) xpv1.Condition
  • func (mg *RuleGroup) GetDeletionPolicy() xpv1.DeletionPolicy
  • func (mg *RuleGroup) GetProviderConfigReference() *xpv1.Reference
  • func (mg *RuleGroup) GetProviderReference() *xpv1.Reference
  • func (mg *RuleGroup) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
  • func (mg *RuleGroup) GetWriteConnectionSecretToReference() *xpv1.SecretReference
  • func (mg *RuleGroup) SetConditions(c ...xpv1.Condition)
  • func (mg *RuleGroup) SetDeletionPolicy(r xpv1.DeletionPolicy)
  • func (mg *RuleGroup) SetProviderConfigReference(r *xpv1.Reference)
  • func (mg *RuleGroup) SetProviderReference(r *xpv1.Reference)
  • func (mg *RuleGroup) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
  • func (mg *RuleGroup) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
• type RuleGroupList
  • func (in *RuleGroupList) DeepCopy() *RuleGroupList
  • func (in *RuleGroupList) DeepCopyInto(out *RuleGroupList)
  • func (in *RuleGroupList) DeepCopyObject() runtime.Object
  • func (l *RuleGroupList) GetItems() []resource.Managed
• type RuleGroupObservation
  • func (in *RuleGroupObservation) DeepCopy() *RuleGroupObservation
  • func (in *RuleGroupObservation) DeepCopyInto(out *RuleGroupObservation)
• type RuleGroupParameters
  • func (in *RuleGroupParameters) DeepCopy() *RuleGroupParameters
  • func (in *RuleGroupParameters) DeepCopyInto(out *RuleGroupParameters)
• type RuleGroupSpec
  • func (in *RuleGroupSpec) DeepCopy() *RuleGroupSpec
  • func (in *RuleGroupSpec) DeepCopyInto(out *RuleGroupSpec)
• type RuleGroupStatus
  • func (in *RuleGroupStatus) DeepCopy() *RuleGroupStatus
  • func (in *RuleGroupStatus) DeepCopyInto(out *RuleGroupStatus)
• type RuleNode
  • func (in *RuleNode) DeepCopy() *RuleNode
  • func (in *RuleNode) DeepCopyInto(out *RuleNode)

Constants

const (
	Group   = "rules.cortex.crossplane.io"
	Version = "v1alpha1"
)

Package type metadata.

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}

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

var (
	RuleGroupKind             = reflect.TypeOf(RuleGroup{}).Name()
	RuleGroupGroupKind        = schema.GroupKind{Group: Group, Kind: RuleGroupKind}.String()
	RuleGroupKindAPIVersion   = RuleGroupKind + "." + SchemeGroupVersion.String()
	RuleGroupGroupVersionKind = SchemeGroupVersion.WithKind(RuleGroupKind)
)

RuleGroup type metadata.

Types

type RuleGroup

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

	Spec   RuleGroupSpec   `json:"spec"`
	Status RuleGroupStatus `json:"status,omitempty"`
}

A RuleGroup is an example API type. +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,cortex}

func (*RuleGroup) DeepCopy

func (in *RuleGroup) DeepCopy() *RuleGroup

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

func (*RuleGroup) DeepCopyInto

func (in *RuleGroup) DeepCopyInto(out *RuleGroup)

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

func (*RuleGroup) DeepCopyObject

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

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

func (*RuleGroup) GetCondition

func (mg *RuleGroup) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this RuleGroup.

func (*RuleGroup) GetDeletionPolicy

func (mg *RuleGroup) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this RuleGroup.

func (*RuleGroup) GetProviderConfigReference

func (mg *RuleGroup) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this RuleGroup.

func (*RuleGroup) GetProviderReference

func (mg *RuleGroup) GetProviderReference() *xpv1.Reference

GetProviderReference of this RuleGroup. Deprecated: Use GetProviderConfigReference.

func (*RuleGroup) GetPublishConnectionDetailsTo

func (mg *RuleGroup) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this RuleGroup.

func (*RuleGroup) GetWriteConnectionSecretToReference

func (mg *RuleGroup) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this RuleGroup.

func (*RuleGroup) SetConditions

func (mg *RuleGroup) SetConditions(c ...xpv1.Condition)

SetConditions of this RuleGroup.

func (*RuleGroup) SetDeletionPolicy

func (mg *RuleGroup) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this RuleGroup.

func (*RuleGroup) SetProviderConfigReference

func (mg *RuleGroup) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this RuleGroup.

func (*RuleGroup) SetProviderReference

func (mg *RuleGroup) SetProviderReference(r *xpv1.Reference)

SetProviderReference of this RuleGroup. Deprecated: Use SetProviderConfigReference.

func (*RuleGroup) SetPublishConnectionDetailsTo

func (mg *RuleGroup) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this RuleGroup.

func (*RuleGroup) SetWriteConnectionSecretToReference

func (mg *RuleGroup) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this RuleGroup.

type RuleGroupList

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

RuleGroupList contains a list of RuleGroup

func (*RuleGroupList) DeepCopy

func (in *RuleGroupList) DeepCopy() *RuleGroupList

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

func (*RuleGroupList) DeepCopyInto

func (in *RuleGroupList) DeepCopyInto(out *RuleGroupList)

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

func (*RuleGroupList) DeepCopyObject

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

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

func (*RuleGroupList) GetItems

func (l *RuleGroupList) GetItems() []resource.Managed

GetItems of this RuleGroupList.

type RuleGroupObservation

type RuleGroupObservation struct {
	Status    string `json:"status,omitempty"`
	Data      string `json:"data,omitempty"`
	ErrorType string `json:"errorType,omitempty"`
	Error     string `json:"error,omitempty"`
}

RuleGroupObservation are the observable fields of a RuleGroup.

func (*RuleGroupObservation) DeepCopy

func (in *RuleGroupObservation) DeepCopy() *RuleGroupObservation

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

func (*RuleGroupObservation) DeepCopyInto

func (in *RuleGroupObservation) DeepCopyInto(out *RuleGroupObservation)

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

type RuleGroupParameters

type RuleGroupParameters struct {
	// The ruler API uses the concept of a “namespace” when creating rule groups.
	// This is a stand in for the name of the rule file in Prometheus and rule
	// groups must be named uniquely within a namespace.
	// This property is required.
	// +immutable
	Namespace string `json:"namespace"`

	// How often rules in the group are evaluated.
	// +optional
	Interval *string `json:"interval,omitempty"`

	// Recording and alerting rules exist in a rule group. Rules within a group
	// are run sequentially at a regular interval, with the same evaluation
	// time.
	// https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules
	// This property is required.
	Rules []RuleNode `json:"rules"`
}

RuleGroupParameters are the configurable fields of a RuleGroup.

func (*RuleGroupParameters) DeepCopy

func (in *RuleGroupParameters) DeepCopy() *RuleGroupParameters

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

func (*RuleGroupParameters) DeepCopyInto

func (in *RuleGroupParameters) DeepCopyInto(out *RuleGroupParameters)

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

type RuleGroupSpec

type RuleGroupSpec struct {
	xpv1.ResourceSpec `json:",inline"`
	ForProvider       RuleGroupParameters `json:"forProvider"`
}

A RuleGroupSpec defines the desired state of a RuleGroup.

func (*RuleGroupSpec) DeepCopy

func (in *RuleGroupSpec) DeepCopy() *RuleGroupSpec

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

func (*RuleGroupSpec) DeepCopyInto

func (in *RuleGroupSpec) DeepCopyInto(out *RuleGroupSpec)

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

type RuleGroupStatus

type RuleGroupStatus struct {
	xpv1.ResourceStatus `json:",inline"`
	AtProvider          RuleGroupObservation `json:"atProvider,omitempty"`
}

A RuleGroupStatus represents the observed state of a RuleGroup.

func (*RuleGroupStatus) DeepCopy

func (in *RuleGroupStatus) DeepCopy() *RuleGroupStatus

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

func (*RuleGroupStatus) DeepCopyInto

func (in *RuleGroupStatus) DeepCopyInto(out *RuleGroupStatus)

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

type RuleNode

type RuleNode struct {
	// The name of the time series to output to. Must be a valid metric name.
	// Either 'Record' or 'Alert' is required
	// +optional
	Record *string `json:"record,omitempty"`

	// The name of the alert. Must be a valid label value.
	// Either 'Record' or 'Alert' is required
	// +optional
	Alert *string `json:"alert,omitempty"`

	// The PromQL expression to evaluate. Every evaluation cycle this is
	// evaluated at the current time, and the result recorded as a new set of
	// time series with the metric name as given by 'record', or if an 'alert'
	// is provided all resultant time series become pending/firing alerts.
	// This property is required.
	Expr string `json:"expr"`

	// Alerts are considered firing once they have been returned for this long.
	// Alerts which have not yet fired for long enough are considered pending.
	// +optional
	For *string `json:"for,omitempty"`

	// Labels to add or overwrite
	// +optional
	Labels map[string]string `json:"labels,omitempty"`

	// Annotations to add to each alert.
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
}

func (*RuleNode) DeepCopy

func (in *RuleNode) DeepCopy() *RuleNode

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

func (*RuleNode) DeepCopyInto

func (in *RuleNode) DeepCopyInto(out *RuleNode)

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