AlertmanagerConfig [monitoring.coreos.com/v1beta1]

inhibitRules

array

List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.

inhibitRules[]

object

InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule

receivers

array

List of receivers.

receivers[]

object

Receiver defines one or more notification integrations.

route

object

The Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route.

timeIntervals

array

List of TimeInterval specifying when the routes should be muted or active.

timeIntervals[]

object

TimeInterval specifies the periods in time when notifications will be muted or active.

equal

array (string)

Labels that must have an equal value in the source and target alert for the inhibition to take effect.

sourceMatch

array

Matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace.

sourceMatch[]

object

Matcher defines how to match on alert’s labels.

targetMatch

array

Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace.

targetMatch[]

object

Matcher defines how to match on alert’s labels.

matchType

string

Match operator, one of = (equal to), != (not equal to), =~ (regex match) or !~ (not regex match). Negative operators (!= and !~) require Alertmanager >= v0.22.0.

name

string

Label to match.

value

string

Label value to match.

matchType

string

Match operator, one of = (equal to), != (not equal to), =~ (regex match) or !~ (not regex match). Negative operators (!= and !~) require Alertmanager >= v0.22.0.

name

string

Label to match.

value

string

Label value to match.

emailConfigs

array

List of Email configurations.

emailConfigs[]

object

EmailConfig configures notifications via Email.

name

string

Name of the receiver. Must be unique across all items from the list.

opsgenieConfigs

array

List of OpsGenie configurations.

opsgenieConfigs[]

object

OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config

pagerdutyConfigs

array

List of PagerDuty configurations.

pagerdutyConfigs[]

object

PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config

pushoverConfigs

array

List of Pushover configurations.

pushoverConfigs[]

object

PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config

slackConfigs

array

List of Slack configurations.

slackConfigs[]

object

SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config

snsConfigs

array

List of SNS configurations

snsConfigs[]

object

SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs

telegramConfigs

array

List of Telegram configurations.

telegramConfigs[]

object

TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config

victoropsConfigs

array

List of VictorOps configurations.

victoropsConfigs[]

object

VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config

webhookConfigs

array

List of webhook configurations.

webhookConfigs[]

object

WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config

wechatConfigs

array

List of WeChat configurations.

wechatConfigs[]

object

WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config

authIdentity

string

The identity to use for authentication.

authPassword

object

The secret’s key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

authSecret

object

The secret’s key that contains the CRAM-MD5 secret. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

authUsername

string

The username to use for authentication.

from

string

The sender address.

headers

array

Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.

headers[]

object

KeyValue defines a (key, value) tuple.

hello

string

The hostname to identify to the SMTP server.

html

string

The HTML body of the email notification.

requireTLS

boolean

The SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.

sendResolved

boolean

Whether or not to notify about resolved alerts.

smarthost

string

The SMTP host and port through which emails are sent. E.g. example.com:25

text

string

The text body of the email notification.

tlsConfig

object

TLS configuration

to

string

The email address to send notifications to.

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

The name of the secret in the object’s namespace to select from.

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

The name of the secret in the object’s namespace to select from.

key

string

Key of the tuple.

value

string

Value of the tuple.

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

actions

string

Comma separated list of actions that will be available for the alert.

apiKey

object

The secret’s key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

apiURL

string

The URL to send OpsGenie API requests to.

description

string

Description of the incident.

details

array

A set of arbitrary key/value pairs that provide further detail about the incident.

details[]

object

KeyValue defines a (key, value) tuple.

entity

string

Optional field that can be used to specify which domain alert is related to.

httpConfig

object

HTTP client configuration.

message

string

Alert text limited to 130 characters.

note

string

Additional alert note.

priority

string

Priority level of alert. Possible values are P1, P2, P3, P4, and P5.

responders

array

List of responders responsible for notifications.

responders[]

object

OpsGenieConfigResponder defines a responder to an incident. One of id, name or username has to be defined.

sendResolved

boolean

Whether or not to notify about resolved alerts.

source

string

Backlink to the sender of the notification.

tags

string

Comma separated list of tags attached to the notifications.

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

The name of the secret in the object’s namespace to select from.

key

string

Key of the tuple.

value

string

Value of the tuple.

authorization

object

Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.

basicAuth

object

BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

followRedirects

boolean

FollowRedirects specifies whether the client should follow HTTP 3xx redirects.

oauth2

object

OAuth2 client credentials used to fetch a token for the targets.

proxyURL

string

Optional proxy URL.

tlsConfig

object

TLS configuration for the client.

credentials

object

The secret’s key that contains the credentials of the request

type

string

Set the authentication type. Defaults to Bearer, Basic will cause an error

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

The name of the secret in the object’s namespace to select from.

clientId

object

The secret or configmap containing the OAuth2 client id

clientSecret

object

The secret containing the OAuth2 client secret

endpointParams

object (string)

Parameters to append to the token URL

scopes

array (string)

OAuth2 scopes used for the token request

tokenUrl

string

The URL to fetch the token from

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

id

string

ID of the responder.

name

string

Name of the responder.

type

string

Type of responder.

username

string

Username of the responder.

class

string

The class/type of the event.

client

string

Client identification.

clientURL

string

Backlink to the sender of notification.

component

string

The part or component of the affected system that is broken.

description

string

Description of the incident.

details

array

Arbitrary key/value pairs that provide further detail about the incident.

details[]

object

KeyValue defines a (key, value) tuple.

group

string

A cluster or grouping of sources.

httpConfig

object

HTTP client configuration.

pagerDutyImageConfigs

array

A list of image details to attach that provide further detail about an incident.

pagerDutyImageConfigs[]

object

PagerDutyImageConfig attaches images to an incident

pagerDutyLinkConfigs

array

A list of link details to attach that provide further detail about an incident.

pagerDutyLinkConfigs[]

object

PagerDutyLinkConfig attaches text links to an incident

routingKey

object

The secret’s key that contains the PagerDuty integration key (when using Events API v2). Either this field or serviceKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

sendResolved

boolean

Whether or not to notify about resolved alerts.

serviceKey

object

The secret’s key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or routingKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

severity

string

Severity of the incident.

url

string

The URL to send requests to.

key

string

Key of the tuple.

value

string

Value of the tuple.

authorization

object

Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.

basicAuth

object

BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

bearerTokenSecret

object

The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

followRedirects

boolean

FollowRedirects specifies whether the client should follow HTTP 3xx redirects.

oauth2

object

OAuth2 client credentials used to fetch a token for the targets.

proxyURL

string

Optional proxy URL.

tlsConfig

object

TLS configuration for the client.

credentials

object

The secret’s key that contains the credentials of the request

type

string

Set the authentication type. Defaults to Bearer, Basic will cause an error

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

The name of the secret in the object’s namespace to select from.

clientId

object

The secret or configmap containing the OAuth2 client id

clientSecret

object

The secret containing the OAuth2 client secret

endpointParams

object (string)

Parameters to append to the token URL

scopes

array (string)

OAuth2 scopes used for the token request

tokenUrl

string

The URL to fetch the token from

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined