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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for thanos alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: object (Runbooks for alerts)

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: string (Alert group runbook URL)

• cannot be null

• defined in: Welkin Apps Config

TYPE:

string (Alert group runbook URL)

PROPERTIES:

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

Alert runbook URL

• is optional

• Type: string

• cannot be null

• defined in: Welkin Apps Config

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

• is optional

• Type: string (Alert group runbook URL)

• cannot be null

• defined in: Welkin Apps Config

TYPE:

string (Alert group runbook URL)

PROPERTIES:

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

Alert runbook URL

• is optional

• Type: string

• cannot be null

• defined in: Welkin Apps Config

TYPE:

string

Return to the root config schema

---

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