GrafanaAlertRuleGroup v1beta1 — grafana.integreatly.org

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object required

GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup

allowCrossNamespaceImport boolean

Allow the Operator to match this resource with Grafanas outside the current namespace

editable boolean

Whether to enable or disable editing of the alert rule group in Grafana UI

folderRef string

Match GrafanaFolders CRs to infer the uid

folderUID string

UID of the folder containing this rule group Overrides the FolderSelector

instanceSelector object required

Selects Grafana instances for import

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchLabels object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

interval string required

pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$

format: duration

name string

Name of the alert rule group. If not specified, the resource name will be used.

resyncPeriod string

How often the resource is synced, defaults to 10m0s if not set

pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$

rules []object required

minItems: 1

annotations object

condition string required

dashboardUid string

Deprecated: The field is not used, use rules[].annotations.__dashboardUid__

data []object required

datasourceUid string

Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation.

model object

JSON is the raw JSON query and includes the above properties as well as custom properties.

queryType string

QueryType is an optional identifier for the type of query. It can be used to distinguish different types of queries.

refId string

RefID is the unique identifier of the query, set by the frontend call.

relativeTimeRange object

relative time range

from integer

from

format: int64

to integer

format: int64

execErrState string required

enum: OK, Alerting, Error, KeepLast

for string required

pattern: ^([0-9]+(\.[0-9]+)?(s|m|h|d|w))+$

isPaused boolean

keepFiringFor string

pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$

format: duration

labels object

missingSeriesEvalsToResolve integer

The number of missing series evaluations that must occur before the rule is considered to be resolved.

format: int64

noDataState string required

enum: Alerting, NoData, OK, KeepLast

notificationSettings object

active_time_intervals []string

ActiveTimeIntervals defines the time intervals during which notifications should NOT be muted.

group_by []string

GroupBy defines the labels by which incoming alerts are grouped together.

group_interval string

GroupInterval defines how long to wait before sending a notification about new alerts added to a group for which an initial notification has already been sent. (e.g. 5m)

group_wait string

GroupWait defines how long to initially wait to send a notification for a group of alerts. (e.g. 30s)

mute_time_intervals []string

MuteTimeIntervals defines the time intervals during which notifications should be muted. These must match the name of a mute time interval defined in the Alertmanager configuration.

receiver string required

Receiver is the name of the receiver to send notifications to.

minLength: 1

repeat_interval string

RepeatInterval defines how long to wait before sending a notification again if it has already been sent successfully for an alert. (e.g. 4h) Should not be less than GroupInterval.

panelId integer

Deprecated: The field is not used, use rules[].annotations.__panelId__

record object

from string required

metric string required

targetDatasourceUid string

title string required

minLength: 1

maxLength: 190

uid string required

UID of the alert rule. Can be any string consisting of alphanumeric characters, - and _ with a maximum length of 40

pattern: ^[a-zA-Z0-9-_]+$

maxLength: 40

suspend boolean

Suspend pauses synchronizing attempts and tells the operator to ignore changes

status object

The most recent observed state of a Grafana resource

conditions []object

Results when synchronizing resource with Grafana instances

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

format: date-time

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

minimum: 0

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

type of condition in CamelCase or in foo.example.com/CamelCase.

pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

maxLength: 316

lastResync string

Last time the resource was synchronized with Grafana instances

format: date-time