Skip to content

Alert runbooks Schema

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

Return to the root config schema

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/alerts/properties/runbookUrls

Configure runbooks for alerts

Runbooks can be configured on an alert group level or per individual alert

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Forbidden none config/schemas/config.yaml*

TYPE:

object (Alert runbooks)

PROPERTIES:

Property Type Required Nullable Defined by
alertmanager object Optional cannot be null Welkin Apps Config
backupStatus object Optional cannot be null Welkin Apps Config
blackbox object Optional cannot be null Welkin Apps Config
certManager object Optional cannot be null Welkin Apps Config
clusterApi object Optional cannot be null Welkin Apps Config
clusterCapacityManagement object Optional cannot be null Welkin Apps Config
configReloaders object Optional cannot be null Welkin Apps Config
coreDns object Optional cannot be null Welkin Apps Config
dailyChecks object Optional cannot be null Welkin Apps Config
diskPerf object Optional cannot be null Welkin Apps Config
falco object Optional cannot be null Welkin Apps Config
fluentd object Optional cannot be null Welkin Apps Config
general object Optional cannot be null Welkin Apps Config
harbor object Optional cannot be null Welkin Apps Config
hnc object Optional cannot be null Welkin Apps Config
kubeStateMetrics object Optional cannot be null Welkin Apps Config
kubernetesApps object Optional cannot be null Welkin Apps Config
kubernetesResources object Optional cannot be null Welkin Apps Config
kubernetesStorage object Optional cannot be null Welkin Apps Config
kubernetesSystem object Optional cannot be null Welkin Apps Config
kured object Optional cannot be null Welkin Apps Config
missingMetrics object Optional cannot be null Welkin Apps Config
nodeExporter object Optional cannot be null Welkin Apps Config
nodeNetwork object Optional cannot be null Welkin Apps Config
opensearch object Optional cannot be null Welkin Apps Config
openstack object Optional cannot be null Welkin Apps Config
packetsDropped object Optional cannot be null Welkin Apps Config
prometheusOperator object Optional cannot be null Welkin Apps Config
prometheus object Optional cannot be null Welkin Apps Config
thanos object Optional cannot be null Welkin Apps Config
webhook object Optional cannot be null Welkin Apps Config

alertmanager

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

alertmanager

TYPE:

object (Runbooks for alerts)

backupStatus

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

backupStatus

TYPE:

object (Runbooks for alerts)

blackbox

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

blackbox

TYPE:

object (Runbooks for alerts)

certManager

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

certManager

TYPE:

object (Runbooks for alerts)

clusterApi

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

clusterApi

TYPE:

object (Runbooks for alerts)

clusterCapacityManagement

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

clusterCapacityManagement

TYPE:

object (Runbooks for alerts)

configReloaders

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

configReloaders

TYPE:

object (Runbooks for alerts)

coreDns

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

coreDns

TYPE:

object (Runbooks for alerts)

dailyChecks

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

dailyChecks

TYPE:

object (Runbooks for alerts)

diskPerf

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

diskPerf

TYPE:

object (Runbooks for alerts)

falco

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

falco

TYPE:

object (Runbooks for alerts)

fluentd

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

fluentd

TYPE:

object (Runbooks for alerts)

general

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

general

TYPE:

object (Runbooks for alerts)

harbor

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

harbor

TYPE:

object (Runbooks for alerts)

hnc

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

hnc

TYPE:

object (Runbooks for alerts)

kubeStateMetrics

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

kubeStateMetrics

TYPE:

object (Runbooks for alerts)

kubernetesApps

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

kubernetesApps

TYPE:

object (Runbooks for alerts)

kubernetesResources

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

kubernetesResources

TYPE:

object (Runbooks for alerts)

kubernetesStorage

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

kubernetesStorage

TYPE:

object (Runbooks for alerts)

kubernetesSystem

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

kubernetesSystem

TYPE:

object (Runbooks for alerts)

kured

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

kured

TYPE:

object (Runbooks for alerts)

missingMetrics

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

missingMetrics

TYPE:

object (Runbooks for alerts)

nodeExporter

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

nodeExporter

TYPE:

object (Runbooks for alerts)

nodeNetwork

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

nodeNetwork

TYPE:

object (Runbooks for alerts)

opensearch

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

opensearch

TYPE:

object (Runbooks for alerts)

openstack

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

openstack

TYPE:

object (Runbooks for alerts)

packetsDropped

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

packetsDropped

TYPE:

object (Runbooks for alerts)

prometheusOperator

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

prometheusOperator

TYPE:

object (Runbooks for alerts)

prometheus

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://runbooks.prometheus-operator.dev/runbooks/

prometheus

TYPE:

object (Runbooks for alerts)

thanos

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses upstream runbooks by default

https://github.com/thanos-io/thanos/tree/main/mixin/runbook.md

thanos

TYPE:

object (Runbooks for thanos alerts)

webhook

Example:

group: link-to-alert-group-runbook AlertName: link-to-specific-alert-runbook

Uses no upstream runbook by default

webhook

TYPE:

object (Runbooks for alerts)

Definitions

upstreamRunbook

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/alerts/properties/runbookUrls/$defs/upstreamRunbook"}
Property Type Required Nullable Defined by
group string Optional cannot be null Welkin Apps Config
Additional Properties string Optional cannot be null Welkin Apps Config

group

group

TYPE:

string (Alert group runbook URL)

PROPERTIES:

Additional properties are allowed, as long as they follow this schema:

Alert runbook URL

TYPE:

string

noUpstreamRunbook

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/alerts/properties/runbookUrls/$defs/noUpstreamRunbook"}
Property Type Required Nullable Defined by
group string Optional cannot be null Welkin Apps Config
Additional Properties string Optional cannot be null Welkin Apps Config

group

group

TYPE:

string (Alert group runbook URL)

PROPERTIES:

Additional properties are allowed, as long as they follow this schema:

Alert runbook URL

TYPE:

string

Return to the root config schema


Generated Wed Apr 2 03:52:56 UTC 2025 from elastisys/compliantkubernetes-apps@main