AlertingPolicy CRD schema reference (group sre.smm.cisco.com)
AlertingPolicy
AlertingPolicy is the Schema for the alertingpolicies API
Version v1alpha1
Properties
.apiVersion
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
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
.spec
AlertingPolicySpec defines the desired state of AlertingPolicy
.spec.alert
Alert defines a new alert based on an existing Alerting template
.spec.alert.description
Description is the description of this alerting
.spec.alert.parameters
Parameters contain the list of additional parameter to use when instantiating the rules inside AlertingTemplate object
.spec.alert.subject
Subject defines which object this Alert is specific to
.spec.alert.subject.kind
.spec.alert.subject.name
.spec.alert.subject.namespace
.spec.alert.template
Template references the AlertingTemplate object this alert is based on
.spec.alert.template.name
.spec.alert.template.namespace
.spec.burnRate
BurnRate defines a burn rate based alert configuration
.spec.burnRate.conditionMetDuration
ConditionMetDuration configures the duration for which the alerting condition has to be fulfilled continuously to trigger an alert
.spec.burnRate.lookBackWindow
LookBackWindow is the duration for which the error rate is averaged
.spec.burnRate.secondaryWindow
SecondaryWindow is a shorter duration for which the error rate is averaged at the end of the longer duration
.spec.burnRate.severity
Severity can be set for an alert: page or ticket
.spec.burnRate.sloRef
SLORef has to reference an existing ServiceLevelObjective CR based on which the alerts are evaluated
.spec.burnRate.sloRef.name
.spec.burnRate.sloRef.namespace
.spec.burnRate.threshold
Threshold is the burn rate value, when it is exceeded for the given time periods an alert is triggered
.status
AlertingPolicyStatus defines the observed state of AlertingPolicy
.status.alertState
AlertState represents the actual state of the alert: inactive, pending or firing
.status.currentValue
CurrentValue is the last calculated value for the alert metric
.status.inStateFrom
InStateFrom is the timestamp starting from the alert is in the current state