Skip to content

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

Configure alerting.

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 (Alerts Config)

PROPERTIES:

Property Type Required Nullable Defined by
alertTo string Optional cannot be null Welkin Apps Config
customReceivers array Optional cannot be null Welkin Apps Config
customRoutes array Optional cannot be null Welkin Apps Config
opsGenie object Optional cannot be null Welkin Apps Config
opsGenieHeartbeat object Optional cannot be null Welkin Apps Config
slack object Optional cannot be null Welkin Apps Config

alertTo

alertTo

TYPE:

string (Alert To)

customReceivers

Additional receivers that will be added to the configuration of alertmanager

Note

See the upstream documentation for reference.

customReceivers

TYPE:

array (Alert Custom Receivers)

customRoutes

Additional route receivers that will be added to the configuration of alertmanager

Note

See the upstream documentation for reference.

customRoutes

TYPE:

array (Additional custom routes)

DEFAULTS:

The default value is:

[]

opsGenie

Configure alerting to OpsGenie.

opsGenie

TYPE:

object (Alert OpsGenie Config)

opsGenieHeartbeat

Configure heartbeats to OpsGenie.

opsGenieHeartbeat

TYPE:

object (Alert OpsGenie Heartbeat)

slack

Configure alerting to Slack.

slack

TYPE:

object (Alert Slack Config)

Return to the root config schema


Generated Tue Feb 18 13:39:13 UTC 2025 from elastisys/compliantkubernetes-apps@main