AlertingTemplate CRD schema reference (group sre.smm.cisco.com)

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 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

AlertingTemplateSpec specifies a template for alerting purposes (without SLOs)

Category should be used on the frontend to categorize multiple ATs

Additional details to show to the user, when eximinging the Alert

Description is the one paragraph long description of the health indicator scenario

MetricUnit contains the unit in which the given metric is measured

RelatedGraphs specify what additional information we can show the end user for better troubleshooting capabilities

RelatedGraphsConfiguration defines the additional graphs configuration that can help the end-user to troubleshoot the given health indicator issue.

Name is the five-word description of the health indicator scenario

Series is the specification of the prometheus based series to show on this graph

SeriesQueryConfiguration defines a series that should be shown on the related graphs

Name is the additional description appended to the given series, useful for differentiating series coming from different sources, should be only used when showing multiple series

Query defines the prometheus query to be executed to fetch the graph’s data. The same go templating variables are available as with .spec.condition.query

Stack describes if the graph should be displayed in stacked manner, default: false

Thresholds can show some thresholds on the graphs based on promql queries if desired, useful for showing moving averages the health indicators are relative to.

RelatedGraphThresholdConfiguration specifies a threshold line on the graph itself

Name is the name of the threshold shown on the user interface

Query defines the prometheus query to be executed to fetch the threshold’s data. The same go templating variables are available as with .spec.condition.query. If it returns multiple labels the first label will be used for grouping.

Unit describes the unit of values shown on the graph, if empty defaults to the parent object’s unit (HealthIndicator or Group)

When, if not an empty string, contain a go template for a PromQL query. Before showing the graph, the query is executed and the graph is only shown if the query returns any data

ShortName is the five-word description of the health indicator scenario

Definitions of the parameters the Rules are depending on

Rules is the template that is to be used to render the final PrometheusRule each field is subject to template rendering the same way as with SLI Templates

RuleGroup is a list of sequentially evaluated recording and alerting rules. Note: PartialResponseStrategy is only used by ThanosRuler and will be ignored by Prometheus instances. Valid values for this field are ‘warn’ or ‘abort’. More info: https://github.com/thanos-io/thanos/blob/master/docs/components/rule.md#partial-response

Rule describes an alerting or recording rule.

Scope specifies if this is a service or workload specific template, right now only services are supported

AlertingTemplateStatus describes the status of an AlertingTemplate