The AlertmanagerConfig custom resource definition (CRD) defines how Alertmanager objects process Prometheus alerts. It allows to specify alert grouping and routing, notification receivers and inhibition rules.
Alertmanager objects select AlertmanagerConfig objects using label and namespace selectors.
object
spec
| Property | Type | Description |
|---|---|---|
|
|
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 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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
spec defines the specification of AlertmanagerConfigSpec |
spec defines the specification of AlertmanagerConfigSpec
object
| Property | Type | Description |
|---|---|---|
|
|
inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource’s namespace. |
|
|
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 defines the list of receivers. |
|
|
Receiver defines one or more notification integrations. |
|
|
route defines 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 defines the list of timeIntervals specifying when the routes should be muted. |
|
|
TimeInterval specifies the periods in time when notifications will be muted or active. |
inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.
array
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
object
| Property | Type | Description |
|---|---|---|
|
|
equal defines labels that must have an equal value in the source and target alert for the inhibition to take effect. This ensures related alerts are properly grouped. |
|
|
sourceMatch defines 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. These are the "trigger" alerts that cause other alerts to be inhibited. |
|
|
Matcher defines how to match on alert’s labels. |
|
|
targetMatch defines matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace. When these conditions are met, matching alerts will be inhibited (silenced). |
|
|
Matcher defines how to match on alert’s labels. |
sourceMatch defines 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. These are the "trigger" alerts that cause other alerts to be inhibited.
array
Matcher defines how to match on alert’s labels.
object
name
| Property | Type | Description |
|---|---|---|
|
|
matchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match). |
|
|
name defines the label to match. This specifies which alert label should be evaluated. |
|
|
value defines the label value to match. This is the expected value for the specified label. |
targetMatch defines matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace. When these conditions are met, matching alerts will be inhibited (silenced).
array
Matcher defines how to match on alert’s labels.
object
name
| Property | Type | Description |
|---|---|---|
|
|
matchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match). |
|
|
name defines the label to match. This specifies which alert label should be evaluated. |
|
|
value defines the label value to match. This is the expected value for the specified label. |
Receiver defines one or more notification integrations.
object
name
| Property | Type | Description |
|---|---|---|
|
|
discordConfigs defines the list of Slack configurations. |
|
|
DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config |
|
|
emailConfigs defines the list of Email configurations. |
|
|
EmailConfig configures notifications via Email. |
|
|
msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0. |
|
|
MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0. |
|
|
msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0. |
|
|
MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0. |
|
|
name defines the name of the receiver. Must be unique across all items from the list. |
|
|
opsgenieConfigs defines the list of OpsGenie configurations. |
|
|
OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config |
|
|
pagerdutyConfigs defines the List of PagerDuty configurations. |
|
|
PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config |
|
|
pushoverConfigs defines the list of Pushover configurations. |
|
|
PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config |
|
|
rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0. |
|
|
RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0. |
|
|
slackConfigs defines the list of Slack configurations. |
|
|
SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config |
|
|
snsConfigs defines the list of SNS configurations |
|
|
SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs |
|
|
telegramConfigs defines the list of Telegram configurations. |
|
|
TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config |
|
|
victoropsConfigs defines the list of VictorOps configurations. |
|
|
VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config |
|
|
webexConfigs defines the list of Webex configurations. |
|
|
WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config |
|
|
webhookConfigs defines the List of webhook configurations. |
|
|
WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config |
|
|
wechatConfigs defines the list of WeChat configurations. |
|
|
WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config |
discordConfigs defines the list of Slack configurations.
array
DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config
object
apiURL
| Property | Type | Description |
|---|---|---|
|
|
apiURL defines the secret’s key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
|
|
avatarURL defines the avatar url of the message sender. |
|
|
content defines the template of the content’s body. |
|
|
httpConfig defines HTTP client configuration. |
|
|
message defines the template of the message’s body. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
title defines the template of the message’s title. |
|
|
username defines the username of the message sender. |
apiURL defines the secret’s key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
httpConfig defines HTTP client configuration.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
emailConfigs defines the list of Email configurations.
array
EmailConfig configures notifications via Email.
object
| Property | Type | Description |
|---|---|---|
|
|
authIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism. |
|
|
authPassword defines 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 defines the secret’s key that contains the CRAM-MD5 secret. This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
|
|
authUsername defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication. |
|
|
from defines the sender address for email notifications. This appears as the "From" field in the email header. |
|
|
headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation. |
|
|
KeyValue defines a (key, value) tuple. |
|
|
hello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake. |
|
|
html defines the HTML body of the email notification. This allows for rich formatting in the email content. |
|
|
requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
smarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587". |
|
|
text defines the plain text body of the email notification. This provides a fallback for email clients that don’t support HTML. |
|
|
tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options. |
|
|
to defines the email address to send notifications to. This is the recipient address for alert notifications. |
authPassword defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
authSecret defines the secret’s key that contains the CRAM-MD5 secret. This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
array
KeyValue defines a (key, value) tuple.
object
key
value
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
|
|
value defines the value of the tuple. This is the data or content associated with the key. |
tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0.
array
MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0.
object
webhookUrl
| Property | Type | Description |
|---|---|---|
|
|
httpConfig defines the HTTP client configuration for Teams webhook requests. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
summary defines the message summary template for Teams notifications. This provides a brief overview that appears in Teams notification previews. It requires Alertmanager >= 0.27.0. |
|
|
text defines the message body template for Teams notifications. This contains the detailed content of the Teams message. |
|
|
title defines the message title template for Teams notifications. This appears as the main heading of the Teams message card. |
|
|
webhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel. |
httpConfig defines the HTTP client configuration for Teams webhook requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
webhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0.
array
MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0.
object
| Property | Type | Description |
|---|---|---|
|
|
httpConfig defines the HTTP client configuration for Teams webhook requests. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
text defines the message body template for adaptive card notifications. This contains the detailed content displayed in the Teams adaptive card format. |
|
|
title defines the message title template for adaptive card notifications. This appears as the main heading in the Teams adaptive card. |
|
|
webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows. |
httpConfig defines the HTTP client configuration for Teams webhook requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
opsgenieConfigs defines the list of OpsGenie configurations.
array
OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
object
| Property | Type | Description |
|---|---|---|
|
|
actions defines a comma separated list of actions that will be available for the alert. These appear as action buttons in the OpsGenie interface. |
|
|
apiKey defines 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 defines the URL to send OpsGenie API requests to. When not specified, defaults to the standard OpsGenie API endpoint. |
|
|
description defines the detailed description of the incident. This provides additional context beyond the message field. |
|
|
details defines a set of arbitrary key/value pairs that provide further detail about the incident. These appear as additional fields in the OpsGenie alert. |
|
|
KeyValue defines a (key, value) tuple. |
|
|
entity defines an optional field that can be used to specify which domain alert is related to. This helps group related alerts together in OpsGenie. |
|
|
httpConfig defines the HTTP client configuration for OpsGenie API requests. |
|
|
message defines the alert text limited to 130 characters. This appears as the main alert title in OpsGenie. |
|
|
note defines an additional alert note. This provides supplementary information about the alert. |
|
|
priority defines the priority level of alert. Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority. |
|
|
responders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created. |
|
|
OpsGenieConfigResponder defines a responder to an incident.
One of |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
source defines the backlink to the sender of the notification. This helps identify where the alert originated from. |
|
|
tags defines a comma separated list of tags attached to the notifications. These help categorize and filter alerts within OpsGenie. |
apiKey defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
details defines a set of arbitrary key/value pairs that provide further detail about the incident. These appear as additional fields in the OpsGenie alert.
array
KeyValue defines a (key, value) tuple.
object
key
value
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
|
|
value defines the value of the tuple. This is the data or content associated with the key. |
httpConfig defines the HTTP client configuration for OpsGenie API requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
responders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created.
array
OpsGenieConfigResponder defines a responder to an incident.
One of id, name or username has to be defined.
object
type
| Property | Type | Description |
|---|---|---|
|
|
id defines the unique identifier of the responder. This corresponds to the responder’s ID within OpsGenie. |
|
|
name defines the display name of the responder. This is used when the responder is identified by name rather than ID. |
|
|
type defines the type of responder. Valid values include "user", "team", "schedule", and "escalation". This determines how OpsGenie interprets the other identifier fields. |
|
|
username defines the username of the responder. This is typically used for user-type responders when identifying by username. |
pagerdutyConfigs defines the List of PagerDuty configurations.
array
PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
object
| Property | Type | Description |
|---|---|---|
|
|
class defines the class/type of the event. |
|
|
client defines the client identification. |
|
|
clientURL defines the backlink to the sender of notification. |
|
|
component defines the part or component of the affected system that is broken. |
|
|
description of the incident. |
|
|
details defines the arbitrary key/value pairs that provide further detail about the incident. |
|
|
KeyValue defines a (key, value) tuple. |
|
|
group defines a cluster or grouping of sources. |
|
|
httpConfig defines the HTTP client configuration. |
|
|
pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident. |
|
|
PagerDutyImageConfig attaches images to an incident |
|
|
pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident. |
|
|
PagerDutyLinkConfig attaches text links to an incident |
|
|
routingKey defines the secret’s key that contains the PagerDuty integration key (when using
Events API v2). Either this field or |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
serviceKey defines the secret’s key that contains the PagerDuty service key (when using
integration type "Prometheus"). Either this field or |
|
|
severity of the incident. |
|
|
source defines the unique location of the affected system. |
|
|
url defines the URL to send requests to. |
details defines the arbitrary key/value pairs that provide further detail about the incident.
array
KeyValue defines a (key, value) tuple.
object
key
value
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
|
|
value defines the value of the tuple. This is the data or content associated with the key. |
httpConfig defines the HTTP client configuration.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.
array
PagerDutyImageConfig attaches images to an incident
object
| Property | Type | Description |
|---|---|---|
|
|
alt is the optional alternative text for the image. |
|
|
href defines the optional URL; makes the image a clickable link. |
|
|
src of the image being attached to the incident |
pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.
array
PagerDutyLinkConfig attaches text links to an incident
object
| Property | Type | Description |
|---|---|---|
|
|
alt defines the text that describes the purpose of the link, and can be used as the link’s text. |
|
|
href defines the URL of the link to be attached |
routingKey defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
serviceKey defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
pushoverConfigs defines the list of Pushover configurations.
array
PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
object
| Property | Type | Description |
|---|---|---|
|
|
device defines the name of a specific device to send the notification to. If not specified, the notification is sent to all user’s devices. |
|
|
expire defines how long your notification will continue to be retried for, unless the user acknowledges the notification. Only applies to priority 2 notifications. |
|
|
html defines whether notification message is HTML or plain text. When true, the message can include HTML formatting tags. |
|
|
httpConfig defines the HTTP client configuration for Pushover API requests. |
|
|
message defines the notification message content. This is the main body text of the Pushover notification. |
|
|
priority defines the notification priority level. See https://pushover.net/api#priority for valid values and behavior. |
|
|
retry defines how often the Pushover servers will send the same notification to the user. Must be at least 30 seconds. Only applies to priority 2 notifications. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
sound defines the name of one of the sounds supported by device clients. This overrides the user’s default sound choice for this notification. |
|
|
title defines the notification title displayed in the Pushover message. This appears as the bold header text in the notification. |
|
|
token defines the secret’s key that contains the registered application’s API token.
See https://pushover.net/apps for application registration.
The secret needs to be in the same namespace as the AlertmanagerConfig
object and accessible by the Prometheus Operator.
Either |
|
|
tokenFile defines the token file that contains the registered application’s API token.
See https://pushover.net/apps for application registration.
Either |
|
|
ttl defines the time to live for the alert notification. This determines how long the notification remains active before expiring. |
|
|
url defines a supplementary URL shown alongside the message. This creates a clickable link within the Pushover notification. |
|
|
urlTitle defines a title for the supplementary URL. If not specified, the raw URL is shown instead. |
|
|
userKey defines the secret’s key that contains the recipient user’s user key.
The secret needs to be in the same namespace as the AlertmanagerConfig
object and accessible by the Prometheus Operator.
Either |
|
|
userKeyFile defines the user key file that contains the recipient user’s user key.
Either |
httpConfig defines the HTTP client configuration for Pushover API requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
token defines the secret’s key that contains the registered application’s API token.
See https://pushover.net/apps for application registration.
The secret needs to be in the same namespace as the AlertmanagerConfig
object and accessible by the Prometheus Operator.
Either token or tokenFile is required.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
userKey defines the secret’s key that contains the recipient user’s user key.
The secret needs to be in the same namespace as the AlertmanagerConfig
object and accessible by the Prometheus Operator.
Either userKey or userKeyFile is required.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0.
array
RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0.
object
token
tokenID
| Property | Type | Description |
|---|---|---|
|
|
actions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses. |
|
|
RocketChatActionConfig defines actions for RocketChat messages. |
|
|
apiURL defines the API URL for RocketChat. Defaults to https://open.rocket.chat/ if not specified. |
|
|
channel defines the channel to send alerts to. This can be a channel name (e.g., "#alerts") or a direct message recipient. |
|
|
color defines the message color displayed in RocketChat. This appears as a colored bar alongside the message. |
|
|
emoji defines the emoji to be displayed as an avatar. If provided, this emoji will be used instead of the default avatar or iconURL. |
|
|
fields defines additional fields for the message attachment. These appear as structured key-value pairs within the message. |
|
|
RocketChatFieldConfig defines a field for RocketChat messages. |
|
|
httpConfig defines the HTTP client configuration for RocketChat API requests. |
|
|
iconURL defines the icon URL for the message avatar. This displays a custom image as the message sender’s avatar. |
|
|
imageURL defines the image URL to display within the message. This embeds an image directly in the message attachment. |
|
|
linkNames defines whether to enable automatic linking of usernames and channels. When true, @username and #channel references become clickable links. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
shortFields defines whether to use short fields in the message layout. When true, fields may be displayed side by side to save space. |
|
|
text defines the message text to send. This is optional because attachments can be used instead of or alongside text. |
|
|
thumbURL defines the thumbnail URL for the message. This displays a small thumbnail image alongside the message content. |
|
|
title defines the message title displayed prominently in the message. This appears as bold text at the top of the message attachment. |
|
|
titleLink defines the URL that the title will link to when clicked. This makes the message title clickable in the RocketChat interface. |
|
|
token defines the sender token for RocketChat authentication. This is the personal access token or bot token used to authenticate API requests. |
|
|
tokenID defines the sender token ID for RocketChat authentication. This is the user ID associated with the token used for API requests. |
actions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses.
array
RocketChatActionConfig defines actions for RocketChat messages.
object
| Property | Type | Description |
|---|---|---|
|
|
msg defines the message to send when the button is clicked. This allows the button to post a predefined message to the channel. |
|
|
text defines the button text displayed to users. This is the label that appears on the interactive button. |
|
|
url defines the URL the button links to when clicked. This creates a clickable button that opens the specified URL. |
fields defines additional fields for the message attachment. These appear as structured key-value pairs within the message.
array
RocketChatFieldConfig defines a field for RocketChat messages.
object
| Property | Type | Description |
|---|---|---|
|
|
short defines whether this field should be a short field. When true, the field may be displayed inline with other short fields to save space. |
|
|
title defines the title of this field. This appears as bold text labeling the field content. |
|
|
value defines the value of this field, displayed underneath the title. This contains the actual data or content for the field. |
httpConfig defines the HTTP client configuration for RocketChat API requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
token defines the sender token for RocketChat authentication. This is the personal access token or bot token used to authenticate API requests.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tokenID defines the sender token ID for RocketChat authentication. This is the user ID associated with the token used for API requests.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
slackConfigs defines the list of Slack configurations.
array
SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
object
| Property | Type | Description |
|---|---|---|
|
|
actions defines a list of Slack actions that are sent with each notification. |
|
|
SlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information. |
|
|
apiURL defines the secret’s key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
|
|
callbackId defines an identifier for the message used in interactive components. |
|
|
channel defines the channel or user to send notifications to. |
|
|
color defines the color of the left border of the Slack message attachment. Can be a hex color code (e.g., "#ff0000") or a predefined color name. |
|
|
fallback defines a plain-text summary of the attachment for clients that don’t support attachments. |
|
|
fields defines a list of Slack fields that are sent with each notification. |
|
|
SlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information. |
|
|
footer defines small text displayed at the bottom of the message attachment. |
|
|
httpConfig defines the HTTP client configuration. |
|
|
iconEmoji defines the emoji to use as the bot’s avatar (e.g., ":ghost:"). |
|
|
iconURL defines the URL to an image to use as the bot’s avatar. |
|
|
imageURL defines the URL to an image file that will be displayed inside the message attachment. |
|
|
linkNames enables automatic linking of channel names and usernames in the message. When true, @channel and @username will be converted to clickable links. |
|
|
mrkdwnIn defines which fields should be parsed as Slack markdown. Valid values include "pretext", "text", and "fields". |
|
|
pretext defines optional text that appears above the message attachment block. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
shortFields determines whether fields are displayed in a compact format. When true, fields are shown side by side when possible. |
|
|
text defines the main text content of the Slack message attachment. |
|
|
thumbURL defines the URL to an image file that will be displayed as a thumbnail on the right side of the message attachment. |
|
|
title defines the title text displayed in the Slack message attachment. |
|
|
titleLink defines the URL that the title will link to when clicked. |
|
|
username defines the slack bot user name. |
actions defines a list of Slack actions that are sent with each notification.
array
SlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information.
object
text
type
| Property | Type | Description |
|---|---|---|
|
|
confirm defines an optional confirmation dialog that appears before the action is executed. When set, users must confirm their intent before the action proceeds. |
|
|
name defines a unique identifier for the action within the message. This value is sent back to your application when the action is triggered. |
|
|
style defines the visual appearance of the action element. Valid values include "default", "primary" (green), and "danger" (red). |
|
|
text defines the user-visible label displayed on the action element. For buttons, this is the button text. For select menus, this is the placeholder text. |
|
|
type defines the type of interactive component. Common values include "button" for clickable buttons and "select" for dropdown menus. |
|
|
url defines the URL to open when the action is triggered. Only applicable for button-type actions. When set, clicking the button opens this URL. |
|
|
value defines the payload sent when the action is triggered. This data is included in the callback sent to your application. |
confirm defines an optional confirmation dialog that appears before the action is executed. When set, users must confirm their intent before the action proceeds.
object
text
| Property | Type | Description |
|---|---|---|
|
|
dismissText defines the label for the cancel button in the dialog. When not specified, defaults to "Cancel". This button cancels the action. |
|
|
okText defines the label for the confirmation button in the dialog. When not specified, defaults to "Okay". This button proceeds with the action. |
|
|
text defines the main message displayed in the confirmation dialog. This should be a clear question or statement asking the user to confirm their action. |
|
|
title defines the title text displayed at the top of the confirmation dialog. When not specified, a default title will be used. |
apiURL defines the secret’s key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
fields defines a list of Slack fields that are sent with each notification.
array
SlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information.
object
title
value
| Property | Type | Description |
|---|---|---|
|
|
short determines whether this field can be displayed alongside other short fields. When true, Slack may display this field side by side with other short fields. When false or not specified, the field takes the full width of the message. |
|
|
title defines the label or header text displayed for this field. This appears as bold text above the field value in the Slack message. |
|
|
value defines the content or data displayed for this field. This appears below the title and can contain plain text or Slack markdown. |
httpConfig defines the HTTP client configuration.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
snsConfigs defines the list of SNS configurations
array
SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
object
| Property | Type | Description |
|---|---|---|
|
|
apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used. |
|
|
attributes defines SNS message attributes as key-value pairs. These provide additional metadata that can be used for message filtering and routing. |
|
|
httpConfig defines the HTTP client configuration for SNS API requests. |
|
|
message defines the message content of the SNS notification. This is the actual notification text that will be sent to subscribers. |
|
|
phoneNumber defines the phone number if message is delivered via SMS in E.164 format. If you don’t specify this value, you must specify a value for the TopicARN or TargetARN. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
sigv4 configures AWS’s Signature Verification 4 signing process to sign requests. This includes AWS credentials and region configuration for authentication. |
|
|
subject defines the subject line when the message is delivered to email endpoints. This field is only used when sending to email subscribers of an SNS topic. |
|
|
targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications. If you don’t specify this value, you must specify a value for the TopicARN or PhoneNumber. |
|
|
topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic. If you don’t specify this value, you must specify a value for the PhoneNumber or TargetARN. |
httpConfig defines the HTTP client configuration for SNS API requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
sigv4 configures AWS’s Signature Verification 4 signing process to sign requests. This includes AWS credentials and region configuration for authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
accessKey defines the AWS API key. If not specified, the environment variable
|
|
|
profile defines the named AWS profile used to authenticate. |
|
|
region defines the AWS region. If blank, the region from the default credentials chain used. |
|
|
roleArn defines the named AWS profile used to authenticate. |
|
|
secretKey defines the AWS API secret. If not specified, the environment
variable |
|
|
useFIPSSTSEndpoint defines FIPS mode for AWS STS endpoint. It requires Prometheus >= v2.54.0. |
accessKey defines the AWS API key. If not specified, the environment variable
AWS_ACCESS_KEY_ID is used.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
secretKey defines the AWS API secret. If not specified, the environment
variable AWS_SECRET_ACCESS_KEY is used.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
telegramConfigs defines the list of Telegram configurations.
array
TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config
object
chatID
| Property | Type | Description |
|---|---|---|
|
|
apiURL defines the Telegram API URL, e.g. https://api.telegram.org. If not specified, the default Telegram API URL will be used. |
|
|
botToken defines the Telegram bot token. It is mutually exclusive with |
|
|
botTokenFile defines the file to read the Telegram bot token from.
It is mutually exclusive with |
|
|
chatID defines the Telegram chat ID where messages will be sent. This can be a user ID, group ID, or channel ID (with @ prefix for public channels). |
|
|
disableNotifications controls whether Telegram notifications are sent silently. When true, users will receive the message without notification sounds. |
|
|
httpConfig defines the HTTP client configuration for Telegram API requests. |
|
|
message defines the message template for the Telegram notification. This is the content that will be sent to the specified chat. |
|
|
messageThreadID defines the Telegram Group Topic ID for threaded messages. This allows sending messages to specific topics within Telegram groups. It requires Alertmanager >= 0.26.0. |
|
|
parseMode defines the parse mode for telegram message formatting. Valid values are "MarkdownV2", "Markdown", and "HTML". This determines how text formatting is interpreted in the message. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
botToken defines the Telegram bot token. It is mutually exclusive with botTokenFile.
The secret needs to be in the same namespace as the AlertmanagerConfig
object and accessible by the Prometheus Operator.
Either botToken or botTokenFile is required.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
httpConfig defines the HTTP client configuration for Telegram API requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
victoropsConfigs defines the list of VictorOps configurations.
array
VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config
object
| Property | Type | Description |
|---|---|---|
|
|
apiKey defines the secret’s key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
|
|
apiUrl defines the VictorOps API URL. When not specified, defaults to the standard VictorOps API endpoint. |
|
|
customFields defines additional custom fields for notification. These provide extra metadata that will be included with the VictorOps incident. |
|
|
KeyValue defines a (key, value) tuple. |
|
|
entityDisplayName contains a summary of the alerted problem. This appears as the main title or identifier for the incident. |
|
|
httpConfig defines the HTTP client’s configuration for VictorOps API requests. |
|
|
messageType describes the behavior of the alert. Valid values are "CRITICAL", "WARNING", and "INFO". |
|
|
monitoringTool defines the monitoring tool the state message is from. This helps identify the source system that generated the alert. |
|
|
routingKey defines a key used to map the alert to a team. This determines which VictorOps team will receive the alert notification. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
stateMessage contains a long explanation of the alerted problem. This provides detailed context about the incident. |
apiKey defines the secret’s key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
customFields defines additional custom fields for notification. These provide extra metadata that will be included with the VictorOps incident.
array
KeyValue defines a (key, value) tuple.
object
key
value
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
|
|
value defines the value of the tuple. This is the data or content associated with the key. |
httpConfig defines the HTTP client’s configuration for VictorOps API requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
webexConfigs defines the list of Webex configurations.
array
WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config
object
roomID
| Property | Type | Description |
|---|---|---|
|
|
apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages |
|
|
httpConfig defines the HTTP client’s configuration.
You must use this configuration to supply the bot token as part of the HTTP |
|
|
message defines the message template |
|
|
roomID defines the ID of the Webex Teams room where to send the messages. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
httpConfig defines the HTTP client’s configuration.
You must use this configuration to supply the bot token as part of the HTTP Authorization header.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
webhookConfigs defines the List of webhook configurations.
array
WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
object
| Property | Type | Description |
|---|---|---|
|
|
httpConfig defines the HTTP client configuration for webhook requests. |
|
|
maxAlerts defines the maximum number of alerts to be sent per webhook message. When 0, all alerts are included in the webhook payload. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
timeout defines the maximum time to wait for a webhook request to complete, before failing the request and allowing it to be retried. It requires Alertmanager >= v0.28.0. |
|
|
url defines the URL to send HTTP POST requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. |
|
|
urlSecret defines the secret’s key that contains the webhook URL to send HTTP requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
httpConfig defines the HTTP client configuration for webhook requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
urlSecret defines the secret’s key that contains the webhook URL to send HTTP requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
wechatConfigs defines the list of WeChat configurations.
array
WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config
object
| Property | Type | Description |
|---|---|---|
|
|
agentID defines the application agent ID within WeChat Work. This identifies which WeChat Work application will send the notifications. |
|
|
apiSecret defines the secret’s key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
|
|
apiURL defines the WeChat API URL. When not specified, defaults to the standard WeChat Work API endpoint. |
|
|
corpID defines the corp id for authentication. This is the unique identifier for your WeChat Work organization. |
|
|
httpConfig defines the HTTP client configuration for WeChat API requests. |
|
|
message defines the API request data as defined by the WeChat API. This contains the actual notification content to be sent. |
|
|
messageType defines the type of message to send. Valid values include "text", "markdown", and other WeChat Work supported message types. |
|
|
sendResolved defines whether or not to notify about resolved alerts. |
|
|
toParty defines the target department(s) to receive the notification. Can be a single department ID or multiple department IDs separated by '|'. |
|
|
toTag defines the target tag(s) to receive the notification. Can be a single tag ID or multiple tag IDs separated by '|'. |
|
|
toUser defines the target user(s) to receive the notification. Can be a single user ID or multiple user IDs separated by '|'. |
apiSecret defines the secret’s key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
httpConfig defines the HTTP client configuration for WeChat API requests.
object
| Property | Type | Description |
|---|---|---|
|
|
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
bearerTokenSecret defines 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. |
|
|
enableHttp2 can be used to disable HTTP2. |
|
|
followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
| Property | Type | Description |
|---|---|---|
|
|
credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
| Property | Type | Description |
|---|---|---|
|
|
password defines a key of a Secret containing the password for authentication. |
|
|
username defines a key of a Secret containing the username for authentication. |
password defines a key of a Secret containing the password for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
username defines a key of a Secret containing the username for authentication.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
bearerTokenSecret defines 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.
object
key
name
| Property | Type | Description |
|---|---|---|
|
|
key defines the key of the secret to select from. Must be a valid secret key. |
|
|
name defines the name of the secret in the object’s namespace to select from. |
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
object
clientId
clientSecret
tokenUrl
| Property | Type | Description |
|---|---|---|
|
|
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
endpointParams configures the HTTP parameters to append to the token URL. |
|
|
noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
|
|
|
SecretKeySelector selects a key of a Secret. |
|
|
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
proxyUrl defines the HTTP proxy server to use. |
|
|
scopes defines the OAuth2 scopes used for the token request. |
|
|
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
tokenUrl defines the URL to fetch the token from. |
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
object
SecretKeySelector selects a key of a Secret.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
object
| Property | Type | Description |
|---|---|---|
|
|
ca defines the Certificate authority used when verifying server certificates. |
|
|
cert defines the Client certificate to present when doing client-authentication. |
|
|
insecureSkipVerify defines how to disable target certificate validation. |
|
|
keySecret defines the Secret containing the client key file for the targets. |
|
|
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
serverName is used to verify the hostname for the targets. |
ca defines the Certificate authority used when verifying server certificates.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
cert defines the Client certificate to present when doing client-authentication.
object
| Property | Type | Description |
|---|---|---|
|
|
configMap defines the ConfigMap containing data to use for the targets. |
|
|
secret defines the Secret containing data to use for the targets. |
configMap defines the ConfigMap containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
secret defines the Secret containing data to use for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
keySecret defines the Secret containing the client key file for the targets.
object
key
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
route defines 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.
object
| Property | Type | Description |
|---|---|---|
|
|
activeTimeIntervals is a list of TimeInterval names when this route should be active. |
|
|
continue defines the boolean indicating whether an alert should continue matching subsequent sibling nodes. It will always be overridden to true for the first-level route by the Prometheus operator. |
|
|
groupBy defines the list of labels to group by. Labels must not be repeated (unique list). Special label "…" (aggregate by all possible labels), if provided, must be the only element in the list. |
|
|
groupInterval defines how long to wait before sending an updated notification. Must match the regular expression`^(()y)?(([0-9])w)?(()d)?(([0-9])h)?(()m)?(([0-9])s)?(([0-9]+)ms)?$` Example: "5m" |
|
|
groupWait defines how long to wait before sending the initial notification. Must match the regular expression`^(()y)?(([0-9])w)?(()d)?(([0-9])h)?(()m)?(([0-9])s)?(([0-9]+)ms)?$` Example: "30s" |
|
|
matchers defines the list of matchers that the alert’s labels should match. For the first
level route, the operator removes any existing equality and regexp
matcher on the |
|
|
Matcher defines how to match on alert’s labels. |
|
|
muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched, |
|
|
receiver defines the name of the receiver for this route. If not empty, it should be listed in
the |
|
|
repeatInterval defines how long to wait before repeating the last notification. Must match the regular expression`^(()y)?(([0-9])w)?(()d)?(([0-9])h)?(()m)?(([0-9])s)?(([0-9]+)ms)?$` Example: "4h" |
|
|
routes defines the child routes. |
matchers defines the list of matchers that the alert’s labels should match. For the first
level route, the operator removes any existing equality and regexp
matcher on the namespace label and adds a namespace: <object
namespace> matcher.
array
Matcher defines how to match on alert’s labels.
object
name
| Property | Type | Description |
|---|---|---|
|
|
matchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match). |
|
|
name defines the label to match. This specifies which alert label should be evaluated. |
|
|
value defines the label value to match. This is the expected value for the specified label. |
timeIntervals defines the list of timeIntervals specifying when the routes should be muted.
array
TimeInterval specifies the periods in time when notifications will be muted or active.
object
name
| Property | Type | Description |
|---|---|---|
|
|
name of the time interval. |
|
|
timeIntervals defines a list of TimePeriod. |
|
|
TimePeriod describes periods of time. |
timeIntervals defines a list of TimePeriod.
array
TimePeriod describes periods of time.
object
| Property | Type | Description |
|---|---|---|
|
|
daysOfMonth defines a list of DayOfMonthRange |
|
|
DayOfMonthRange is an inclusive range of days of the month beginning at 1 |
|
|
months defines a list of MonthRange |
|
|
times defines a list of TimeRange |
|
|
TimeRange defines a start and end time in 24hr format |
|
|
weekdays defines a list of WeekdayRange |
|
|
years defines a list of YearRange |
daysOfMonth defines a list of DayOfMonthRange
array
DayOfMonthRange is an inclusive range of days of the month beginning at 1
object
| Property | Type | Description |
|---|---|---|
|
|
end of the inclusive range |
|
|
start of the inclusive range |
The following API endpoints are available:
/apis/monitoring.coreos.com/v1beta1/alertmanagerconfigs
GET: list objects of kind AlertmanagerConfig
/apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs
DELETE: delete collection of AlertmanagerConfig
GET: list objects of kind AlertmanagerConfig
POST: create an AlertmanagerConfig
/apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs/{name}
DELETE: delete an AlertmanagerConfig
GET: read the specified AlertmanagerConfig
PATCH: partially update the specified AlertmanagerConfig
PUT: replace the specified AlertmanagerConfig
GET
list objects of kind AlertmanagerConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
DELETE
delete collection of AlertmanagerConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
list objects of kind AlertmanagerConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
POST
create an AlertmanagerConfig
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
| Parameter | Type | Description |
|---|---|---|
|
|
name of the AlertmanagerConfig |
DELETE
delete an AlertmanagerConfig
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
GET
read the specified AlertmanagerConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified AlertmanagerConfig
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace the specified AlertmanagerConfig
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |
