v1

Documentation

Overview

Package v1 contains API Schema definitions for the adx-mon v1 API group +kubebuilder:object:generate=true +groupName=adx-mon.azure.com

Index

• Variables
• type AlertRule
  • func (in *AlertRule) DeepCopy() *AlertRule
  • func (in *AlertRule) DeepCopyInto(out *AlertRule)
  • func (in *AlertRule) DeepCopyObject() runtime.Object
• type AlertRuleList
  • func (in *AlertRuleList) DeepCopy() *AlertRuleList
  • func (in *AlertRuleList) DeepCopyInto(out *AlertRuleList)
  • func (in *AlertRuleList) DeepCopyObject() runtime.Object
• type AlertRuleSpec
  • func (in *AlertRuleSpec) DeepCopy() *AlertRuleSpec
  • func (in *AlertRuleSpec) DeepCopyInto(out *AlertRuleSpec)
  • func (a *AlertRuleSpec) UnmarshalJSON(data []byte) error
• type AlertRuleStatus
  • func (in *AlertRuleStatus) DeepCopy() *AlertRuleStatus
  • func (in *AlertRuleStatus) DeepCopyInto(out *AlertRuleStatus)
• type Function
  • func (in *Function) DeepCopy() *Function
  • func (in *Function) DeepCopyInto(out *Function)
  • func (in *Function) DeepCopyObject() runtime.Object
• type FunctionList
  • func (in *FunctionList) DeepCopy() *FunctionList
  • func (in *FunctionList) DeepCopyInto(out *FunctionList)
  • func (in *FunctionList) DeepCopyObject() runtime.Object
• type FunctionSpec
  • func (in *FunctionSpec) DeepCopy() *FunctionSpec
  • func (in *FunctionSpec) DeepCopyInto(out *FunctionSpec)
• type FunctionStatus
  • func (in *FunctionStatus) DeepCopy() *FunctionStatus
  • func (in *FunctionStatus) DeepCopyInto(out *FunctionStatus)
• type FunctionStatusEnum

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "adx-mon.azure.com", 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
)

Types

type AlertRule

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

	Spec   AlertRuleSpec   `json:"spec,omitempty"`
	Status AlertRuleStatus `json:"status,omitempty"`
}

AlertRule is the Schema for the alertrules API

func (*AlertRule) DeepCopy

func (in *AlertRule) DeepCopy() *AlertRule

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

func (*AlertRule) DeepCopyInto

func (in *AlertRule) DeepCopyInto(out *AlertRule)

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

func (*AlertRule) DeepCopyObject

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

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

type AlertRuleList

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

AlertRuleList contains a list of AlertRule

func (*AlertRuleList) DeepCopy

func (in *AlertRuleList) DeepCopy() *AlertRuleList

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

func (*AlertRuleList) DeepCopyInto

func (in *AlertRuleList) DeepCopyInto(out *AlertRuleList)

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

func (*AlertRuleList) DeepCopyObject

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

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

type AlertRuleSpec

type AlertRuleSpec struct {
	Database          string          `json:"database,omitempty"`
	Interval          metav1.Duration `json:"interval,omitempty"`
	Query             string          `json:"query,omitempty"`
	AutoMitigateAfter metav1.Duration `json:"autoMitigateAfter,omitempty"`
	Destination       string          `json:"destination,omitempty"`

	// Key/Value pairs used to determine when an alert can execute.  If empty, always execute.  Keys and values
	// are deployment specific and configured on alerter instances.  For example, an alerter instance may be
	// started with `--tag cloud=public`. If an AlertRule has `criteria: {cloud: public}`, then the rule will only
	// execute on that alerter. Any key/values pairs must match (case-insensitive) for the rule to execute.
	Criteria map[string][]string `json:"criteria,omitempty"`
}

AlertRuleSpec defines the desired state of AlertRule

func (*AlertRuleSpec) DeepCopy

func (in *AlertRuleSpec) DeepCopy() *AlertRuleSpec

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

func (*AlertRuleSpec) DeepCopyInto

func (in *AlertRuleSpec) DeepCopyInto(out *AlertRuleSpec)

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

func (*AlertRuleSpec) UnmarshalJSON

func (a *AlertRuleSpec) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for backward compatibility with and older version of the Criteria field. The older version was a map[string]string. This function will convert the older version to the new version.

type AlertRuleStatus

type AlertRuleStatus struct {
	Status        string      `json:"status,omitempty"`
	Message       string      `json:"message,omitempty"`
	LastQueryTime metav1.Time `json:"lastQueryTime,omitempty"`
	LastAlertTime metav1.Time `json:"lastAlertTime,omitempty"`
}

AlertRuleStatus defines the observed state of AlertRule

func (*AlertRuleStatus) DeepCopy

func (in *AlertRuleStatus) DeepCopy() *AlertRuleStatus

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

func (*AlertRuleStatus) DeepCopyInto

func (in *AlertRuleStatus) DeepCopyInto(out *AlertRuleStatus)

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

type Function

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

	Spec   FunctionSpec   `json:"spec,omitempty"`
	Status FunctionStatus `json:"status,omitempty"`
}

Function defines a KQL function to be maintained in the Kusto cluster

func (*Function) DeepCopy

func (in *Function) DeepCopy() *Function

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

func (*Function) DeepCopyInto

func (in *Function) DeepCopyInto(out *Function)

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

func (*Function) DeepCopyObject

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

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

type FunctionList

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

FunctionList contains a list of Function

func (*FunctionList) DeepCopy

func (in *FunctionList) DeepCopy() *FunctionList

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

func (*FunctionList) DeepCopyInto

func (in *FunctionList) DeepCopyInto(out *FunctionList)

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

func (*FunctionList) DeepCopyObject

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

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

type FunctionSpec

type FunctionSpec struct {

	// This flag tells the controller to suspend subsequent executions, it does
	// not apply to already started executions.  Defaults to false.
	// +optional
	Suspend *bool `json:"suspend,omitempty"`

	// Database is the name of the database in which the function will be created
	Database string `json:"database"`
	// Body is the KQL body of the function
	Body string `json:"body"`
}

FunctionSpec defines the desired state of Function

func (*FunctionSpec) DeepCopy

func (in *FunctionSpec) DeepCopy() *FunctionSpec

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

func (*FunctionSpec) DeepCopyInto

func (in *FunctionSpec) DeepCopyInto(out *FunctionSpec)

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

type FunctionStatus

type FunctionStatus struct {
	// ObservedGeneration is the most recent generation observed for this Function
	ObservedGeneration int64 `json:"observedGeneration"`
	// LastTimeReconciled is the last time the Function was reconciled
	LastTimeReconciled metav1.Time `json:"lastTimeReconciled"`
	// Message is a human-readable message indicating details about the Function
	Message string `json:"message,omitempty"`
	// Reason is a string that communicates the reason for a transition
	Reason string `json:"reason,omitempty"`
	// Status is an enum that represents the status of the Function
	Status FunctionStatusEnum `json:"status"`
	// Error is a string that communicates any error message if one exists
	Error string `json:"error,omitempty"`
}

FunctionStatus defines the observed state of Function

func (*FunctionStatus) DeepCopy

func (in *FunctionStatus) DeepCopy() *FunctionStatus

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

func (*FunctionStatus) DeepCopyInto

func (in *FunctionStatus) DeepCopyInto(out *FunctionStatus)

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

type FunctionStatusEnum

type FunctionStatusEnum string

FunctionStatusEnum defines the possible status values for FunctionStatus

const (
	PermanentFailure FunctionStatusEnum = "PermanentFailure"
	Failed           FunctionStatusEnum = "Failed"
	Success          FunctionStatusEnum = "Success"
)