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

AlertingPolicy is the Schema for the alertingpolicies API

AlertingPolicy

AlertingPolicy is the Schema for the alertingpolicies API

Full name:
alertingpolicies.sre.smm.cisco.com
Group:
sre.smm.cisco.com
Singular name:
alertingpolicy
Plural name:
alertingpolicies
Scope:
Namespaced
Versions:
v1alpha1

Version v1alpha1

Properties

.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

AlertingPolicySpec defines the desired state of AlertingPolicy

.spec.alert

object

Alert defines a new alert based on an existing Alerting template

.spec.alert.description

string

Description is the description of this alerting

.spec.alert.parameters

object

Parameters contain the list of additional parameter to use when instantiating the rules inside AlertingTemplate object

.spec.alert.subject

object Required

Subject defines which object this Alert is specific to

.spec.alert.subject.kind

string Required

.spec.alert.subject.name

string Required

.spec.alert.subject.namespace

string Required

.spec.alert.template

object Required

Template references the AlertingTemplate object this alert is based on

.spec.alert.template.name

string Required

.spec.alert.template.namespace

string Required

.spec.burnRate

object

BurnRate defines a burn rate based alert configuration

.spec.burnRate.conditionMetDuration

string

ConditionMetDuration configures the duration for which the alerting condition has to be fulfilled continuously to trigger an alert

.spec.burnRate.lookBackWindow

string Required

LookBackWindow is the duration for which the error rate is averaged

.spec.burnRate.secondaryWindow

string Required

SecondaryWindow is a shorter duration for which the error rate is averaged at the end of the longer duration

.spec.burnRate.severity

string

Severity can be set for an alert: page or ticket

.spec.burnRate.sloRef

object Required

SLORef has to reference an existing ServiceLevelObjective CR based on which the alerts are evaluated

.spec.burnRate.sloRef.name

string Required

.spec.burnRate.sloRef.namespace

string Required

.spec.burnRate.threshold

string Required

Threshold is the burn rate value, when it is exceeded for the given time periods an alert is triggered

.status

object

AlertingPolicyStatus defines the observed state of AlertingPolicy

.status.alertState

string

AlertState represents the actual state of the alert: inactive, pending or firing

.status.currentValue

string

CurrentValue is the last calculated value for the alert metric

.status.inStateFrom

string

InStateFrom is the timestamp starting from the alert is in the current state