← Back to index Esc
Kind
Alertmanagerconfig
Group
monitoring.coreos.com
Version
v1alpha1
apiVersion: monitoring.coreos.com/v1alpha1 kind: Alertmanagerconfig metadata: name: example
View raw schema
apiVersion string
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 string
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
metadata object
spec object required
spec defines the specification of AlertmanagerConfigSpec
inhibitRules []object
inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource's namespace.
equal []string
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 []object
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.
matchType string
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).
enum: !=, =, =~, !~
name string required
name defines the label to match. This specifies which alert label should be evaluated.
minLength: 1
regex boolean
regex defines whether to match on equality (false) or regular-expression (true). Deprecated: for AlertManager >= v0.22.0, `matchType` should be used instead.
value string
value defines the label value to match. This is the expected value for the specified label.
targetMatch []object
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).
matchType string
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).
enum: !=, =, =~, !~
name string required
name defines the label to match. This specifies which alert label should be evaluated.
minLength: 1
regex boolean
regex defines whether to match on equality (false) or regular-expression (true). Deprecated: for AlertManager >= v0.22.0, `matchType` should be used instead.
value string
value defines the label value to match. This is the expected value for the specified label.
muteTimeIntervals []object
muteTimeIntervals defines the list of MuteTimeInterval specifying when the routes should be muted.
name string required
name of the time interval
timeIntervals []object
timeIntervals defines a list of TimeInterval
daysOfMonth []object
daysOfMonth defines a list of DayOfMonthRange
end integer
end of the inclusive range
minimum: -31
maximum: 31
start integer
start of the inclusive range
minimum: -31
maximum: 31
months []string
months defines a list of MonthRange
times []object
times defines a list of TimeRange
endTime string
endTime defines the end time in 24hr format.
pattern: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)
startTime string
startTime defines the start time in 24hr format.
pattern: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)
weekdays []string
weekdays defines a list of WeekdayRange
years []string
years defines a list of YearRange
receivers []object
receivers defines the list of receivers.
discordConfigs []object
discordConfigs defines the list of Slack configurations.
apiURL object required
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
avatarURL string
avatarURL defines the avatar url of the message sender.
pattern: ^https?://.+$
content string
content defines the template of the content's body.
minLength: 1
httpConfig object
httpConfig defines the HTTP client configuration.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
message string
message defines the template of the message's body.
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
title string
title defines the template of the message's title.
username string
username defines the username of the message sender.
minLength: 1
emailConfigs []object
emailConfigs defines the list of Email configurations.
authIdentity string
authIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism.
minLength: 1
authPassword object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
authSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
authUsername string
authUsername defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication.
minLength: 1
forceImplicitTLS boolean
forceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security. true: force use of implicit TLS (direct TLS connection on any port) false: force disable implicit TLS (use explicit TLS/STARTTLS if required) nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility It requires Alertmanager >= v0.31.0.
from string
from defines the sender address for email notifications. This appears as the "From" field in the email header.
minLength: 1
headers []object
headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
key string required
key defines the key of the tuple. This is the identifier or name part of the key-value pair.
minLength: 1
value string required
value defines the value of the tuple. This is the data or content associated with the key.
hello string
hello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake.
minLength: 1
html string
html defines the HTML body of the email notification. This allows for rich formatting in the email content.
requireTLS boolean
requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
smarthost string
smarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587".
minLength: 1
text string
text defines the plain text body of the email notification. This provides a fallback for email clients that don't support HTML.
minLength: 1
tlsConfig object
tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
to string
to defines the email address to send notifications to. This is the recipient address for alert notifications.
minLength: 1
msteamsConfigs []object
msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0.
httpConfig object
httpConfig defines the HTTP client configuration for Teams webhook requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
summary string
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 string
text defines the message body template for Teams notifications. This contains the detailed content of the Teams message.
title string
title defines the message title template for Teams notifications. This appears as the main heading of the Teams message card.
webhookUrl object required
webhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
msteamsv2Configs []object
msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0.
httpConfig object
httpConfig defines the HTTP client configuration for Teams webhook requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
text string
text defines the message body template for adaptive card notifications. This contains the detailed content displayed in the Teams adaptive card format.
minLength: 1
title string
title defines the message title template for adaptive card notifications. This appears as the main heading in the Teams adaptive card.
minLength: 1
webhookURL object
webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
name string required
name defines the name of the receiver. Must be unique across all items from the list.
minLength: 1
opsgenieConfigs []object
opsgenieConfigs defines the list of OpsGenie configurations.
actions string
actions defines a comma separated list of actions that will be available for the alert. These appear as action buttons in the OpsGenie interface.
minLength: 1
apiKey object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
apiURL string
apiURL defines the URL to send OpsGenie API requests to. When not specified, defaults to the standard OpsGenie API endpoint.
pattern: ^https?://.+$
description string
description defines the detailed description of the incident. This provides additional context beyond the message field.
minLength: 1
details []object
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.
key string required
key defines the key of the tuple. This is the identifier or name part of the key-value pair.
minLength: 1
value string required
value defines the value of the tuple. This is the data or content associated with the key.
entity string
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.
minLength: 1
httpConfig object
httpConfig defines the HTTP client configuration for OpsGenie API requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
message string
message defines the alert text limited to 130 characters. This appears as the main alert title in OpsGenie.
minLength: 1
note string
note defines an additional alert note. This provides supplementary information about the alert.
minLength: 1
priority string
priority defines the priority level of alert. Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority.
minLength: 1
responders []object
responders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created.
id string
id defines the unique identifier of the responder. This corresponds to the responder's ID within OpsGenie.
minLength: 1
name string
name defines the display name of the responder. This is used when the responder is identified by name rather than ID.
minLength: 1
type string required
type defines the type of responder. Valid values include "user", "team", "schedule", and "escalation". This determines how OpsGenie interprets the other identifier fields.
enum: team, teams, user, escalation, schedule
minLength: 1
username string
username defines the username of the responder. This is typically used for user-type responders when identifying by username.
minLength: 1
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
source string
source defines the backlink to the sender of the notification. This helps identify where the alert originated from.
minLength: 1
tags string
tags defines a comma separated list of tags attached to the notifications. These help categorize and filter alerts within OpsGenie.
minLength: 1
updateAlerts boolean
updateAlerts defines Whether to update message and description of the alert in OpsGenie if it already exists By default, the alert is never updated in OpsGenie, the new message only appears in activity log.
pagerdutyConfigs []object
pagerdutyConfigs defines the List of PagerDuty configurations.
class string
class defines the class/type of the event.
minLength: 1
client string
client defines the client identification.
minLength: 1
clientURL string
clientURL defines the backlink to the sender of notification.
component string
component defines the part or component of the affected system that is broken.
minLength: 1
description string
description of the incident.
minLength: 1
details []object
details defines the arbitrary key/value pairs that provide further detail about the incident.
key string required
key defines the key of the tuple. This is the identifier or name part of the key-value pair.
minLength: 1
value string required
value defines the value of the tuple. This is the data or content associated with the key.
group string
group defines a cluster or grouping of sources.
minLength: 1
httpConfig object
httpConfig defines the HTTP client configuration.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
pagerDutyImageConfigs []object
pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.
alt string
alt is the optional alternative text for the image.
minLength: 1
href string
href defines the optional URL; makes the image a clickable link.
src string
src of the image being attached to the incident
minLength: 1
pagerDutyLinkConfigs []object
pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.
alt string
alt defines the text that describes the purpose of the link, and can be used as the link's text.
minLength: 1
href string
href defines the URL of the link to be attached
routingKey object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
serviceKey object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
severity string
severity of the incident.
minLength: 1
source string
source defines the unique location of the affected system.
minLength: 1
timeout string
timeout is the maximum time allowed to invoke the pagerduty It requires Alertmanager >= v0.30.0.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
url string
url defines the URL to send requests to.
pattern: ^https?://.+$
pushoverConfigs []object
pushoverConfigs defines the list of Pushover configurations.
device string
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.
minLength: 1
expire string
expire defines how long your notification will continue to be retried for, unless the user acknowledges the notification. Only applies to priority 2 notifications.
pattern: ^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
html boolean
html defines whether notification message is HTML or plain text. When true, the message can include HTML formatting tags. html and monospace formatting are mutually exclusive.
httpConfig object
httpConfig defines the HTTP client configuration for Pushover API requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
message string
message defines the notification message content. This is the main body text of the Pushover notification.
minLength: 1
monospace boolean
monospace optional HTML/monospace formatting for the message, see https://pushover.net/api#html html and monospace formatting are mutually exclusive.
priority string
priority defines the notification priority level. See https://pushover.net/api#priority for valid values and behavior.
minLength: 1
retry string
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.
pattern: ^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
sound string
sound defines the name of one of the sounds supported by device clients. This overrides the user's default sound choice for this notification.
minLength: 1
title string
title defines the notification title displayed in the Pushover message. This appears as the bold header text in the notification.
minLength: 1
token object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
tokenFile string
tokenFile defines the token file that contains the registered application's API token. See https://pushover.net/apps for application registration. Either `token` or `tokenFile` is required. It requires Alertmanager >= v0.26.0.
minLength: 1
ttl string
ttl defines the time to live for the alert notification. This determines how long the notification remains active before expiring.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
url string
url defines a supplementary URL shown alongside the message. This creates a clickable link within the Pushover notification.
urlTitle string
urlTitle defines a title for the supplementary URL. If not specified, the raw URL is shown instead.
minLength: 1
userKey object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
userKeyFile string
userKeyFile defines the user key file that contains the recipient user's user key. Either `userKey` or `userKeyFile` is required. It requires Alertmanager >= v0.26.0.
minLength: 1
rocketchatConfigs []object
rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0.
actions []object
actions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses.
minItems: 1
msg string
msg defines the message to send when the button is clicked. This allows the button to post a predefined message to the channel.
minLength: 1
text string
text defines the button text displayed to users. This is the label that appears on the interactive button.
minLength: 1
url string
url defines the URL the button links to when clicked. This creates a clickable button that opens the specified URL.
apiURL string
apiURL defines the API URL for RocketChat. Defaults to https://open.rocket.chat/ if not specified.
pattern: ^https?://.+$
channel string
channel defines the channel to send alerts to. This can be a channel name (e.g., "#alerts") or a direct message recipient.
minLength: 1
color string
color defines the message color displayed in RocketChat. This appears as a colored bar alongside the message.
minLength: 1
emoji string
emoji defines the emoji to be displayed as an avatar. If provided, this emoji will be used instead of the default avatar or iconURL.
minLength: 1
fields []object
fields defines additional fields for the message attachment. These appear as structured key-value pairs within the message.
minItems: 1
short boolean
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 string
title defines the title of this field. This appears as bold text labeling the field content.
minLength: 1
value string
value defines the value of this field, displayed underneath the title. This contains the actual data or content for the field.
minLength: 1
httpConfig object
httpConfig defines the HTTP client configuration for RocketChat API requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
iconURL string
iconURL defines the icon URL for the message avatar. This displays a custom image as the message sender's avatar.
imageURL string
imageURL defines the image URL to display within the message. This embeds an image directly in the message attachment.
linkNames boolean
linkNames defines whether to enable automatic linking of usernames and channels. When true, @username and #channel references become clickable links.
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
shortFields boolean
shortFields defines whether to use short fields in the message layout. When true, fields may be displayed side by side to save space.
text string
text defines the message text to send. This is optional because attachments can be used instead of or alongside text.
minLength: 1
thumbURL string
thumbURL defines the thumbnail URL for the message. This displays a small thumbnail image alongside the message content.
title string
title defines the message title displayed prominently in the message. This appears as bold text at the top of the message attachment.
minLength: 1
titleLink string
titleLink defines the URL that the title will link to when clicked. This makes the message title clickable in the RocketChat interface.
minLength: 1
token object required
token defines the sender token for RocketChat authentication. This is the personal access token or bot token used to authenticate API requests. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
tokenID object required
tokenID defines the sender token ID for RocketChat authentication. This is the user ID associated with the token used for API requests. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
slackConfigs []object
slackConfigs defines the list of Slack configurations.
actions []object
actions defines a list of Slack actions that are sent with each notification.
minItems: 1
confirm object
confirm defines an optional confirmation dialog that appears before the action is executed. When set, users must confirm their intent before the action proceeds.
dismissText string
dismissText defines the label for the cancel button in the dialog. When not specified, defaults to "Cancel". This button cancels the action.
minLength: 1
okText string
okText defines the label for the confirmation button in the dialog. When not specified, defaults to "Okay". This button proceeds with the action.
minLength: 1
text string required
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.
minLength: 1
title string
title defines the title text displayed at the top of the confirmation dialog. When not specified, a default title will be used.
minLength: 1
name string
name defines a unique identifier for the action within the message. This value is sent back to your application when the action is triggered.
minLength: 1
style string
style defines the visual appearance of the action element. Valid values include "default", "primary" (green), and "danger" (red).
minLength: 1
text string required
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.
minLength: 1
type string required
type defines the type of interactive component. Common values include "button" for clickable buttons and "select" for dropdown menus.
minLength: 1
url string
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 string
value defines the payload sent when the action is triggered. This data is included in the callback sent to your application.
minLength: 1
apiURL object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
callbackId string
callbackId defines an identifier for the message used in interactive components.
minLength: 1
channel string
channel defines the channel or user to send notifications to.
minLength: 1
color string
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.
minLength: 1
fallback string
fallback defines a plain-text summary of the attachment for clients that don't support attachments.
minLength: 1
fields []object
fields defines a list of Slack fields that are sent with each notification.
minItems: 1
short boolean
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 string required
title defines the label or header text displayed for this field. This appears as bold text above the field value in the Slack message.
minLength: 1
value string required
value defines the content or data displayed for this field. This appears below the title and can contain plain text or Slack markdown.
minLength: 1
footer string
footer defines small text displayed at the bottom of the message attachment.
minLength: 1
httpConfig object
httpConfig defines the HTTP client configuration.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
iconEmoji string
iconEmoji defines the emoji to use as the bot's avatar (e.g., ":ghost:").
minLength: 1
iconURL string
iconURL defines the URL to an image to use as the bot's avatar.
imageURL string
imageURL defines the URL to an image file that will be displayed inside the message attachment.
linkNames boolean
linkNames enables automatic linking of channel names and usernames in the message. When true, @channel and @username will be converted to clickable links.
messageText string
messageText defines text content of the Slack message. If set, this is sent as the top-level 'text' field in the Slack payload. It requires Alertmanager >= v0.31.0.
minLength: 1
mrkdwnIn []string
mrkdwnIn defines which fields should be parsed as Slack markdown. Valid values include "pretext", "text", and "fields".
minItems: 1
pretext string
pretext defines optional text that appears above the message attachment block.
minLength: 1
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
shortFields boolean
shortFields determines whether fields are displayed in a compact format. When true, fields are shown side by side when possible.
text string
text defines the main text content of the Slack message attachment.
minLength: 1
thumbURL string
thumbURL defines the URL to an image file that will be displayed as a thumbnail on the right side of the message attachment.
timeout string
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.30.0.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
title string
title defines the title text displayed in the Slack message attachment.
minLength: 1
titleLink string
titleLink defines the URL that the title will link to when clicked.
username string
username defines the slack bot user name.
minLength: 1
snsConfigs []object
snsConfigs defines the list of SNS configurations
apiURL string
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 object
attributes defines SNS message attributes as key-value pairs. These provide additional metadata that can be used for message filtering and routing.
httpConfig object
httpConfig defines the HTTP client configuration for SNS API requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
message string
message defines the message content of the SNS notification. This is the actual notification text that will be sent to subscribers.
minLength: 1
phoneNumber string
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.
minLength: 1
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
sigv4 object
sigv4 configures AWS's Signature Verification 4 signing process to sign requests. This includes AWS credentials and region configuration for authentication.
accessKey object
accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
profile string
profile defines the named AWS profile used to authenticate.
region string
region defines the AWS region. If blank, the region from the default credentials chain used.
roleArn string
roleArn defines the named AWS profile used to authenticate.
secretKey object
secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
useFIPSSTSEndpoint boolean
useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0.
subject string
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.
minLength: 1
targetARN string
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.
minLength: 1
topicARN string
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.
minLength: 1
telegramConfigs []object
telegramConfigs defines the list of Telegram configurations.
apiURL string
apiURL defines the Telegram API URL, e.g. https://api.telegram.org. If not specified, the default Telegram API URL will be used.
pattern: ^https?://.+$
botToken object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
botTokenFile string
botTokenFile defines the file to read the Telegram bot token from. It is mutually exclusive with `botToken`. Either `botToken` or `botTokenFile` is required. It requires Alertmanager >= v0.26.0.
chatID integer required
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).
format: int64
disableNotifications boolean
disableNotifications controls whether Telegram notifications are sent silently. When true, users will receive the message without notification sounds.
httpConfig object
httpConfig defines the HTTP client configuration for Telegram API requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
message string
message defines the message template for the Telegram notification. This is the content that will be sent to the specified chat.
messageThreadID integer
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.
format: int64
parseMode string
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.
enum: MarkdownV2, Markdown, HTML
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
victoropsConfigs []object
victoropsConfigs defines the list of VictorOps configurations.
apiKey object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
apiUrl string
apiUrl defines the VictorOps API URL. When not specified, defaults to the standard VictorOps API endpoint.
pattern: ^https?://.+$
customFields []object
customFields defines additional custom fields for notification. These provide extra metadata that will be included with the VictorOps incident.
key string required
key defines the key of the tuple. This is the identifier or name part of the key-value pair.
minLength: 1
value string required
value defines the value of the tuple. This is the data or content associated with the key.
entityDisplayName string
entityDisplayName contains a summary of the alerted problem. This appears as the main title or identifier for the incident.
minLength: 1
httpConfig object
httpConfig defines the HTTP client's configuration for VictorOps API requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
messageType string
messageType describes the behavior of the alert. Valid values are "CRITICAL", "WARNING", and "INFO".
minLength: 1
monitoringTool string
monitoringTool defines the monitoring tool the state message is from. This helps identify the source system that generated the alert.
minLength: 1
routingKey string required
routingKey defines a key used to map the alert to a team. This determines which VictorOps team will receive the alert notification.
minLength: 1
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
stateMessage string
stateMessage contains a long explanation of the alerted problem. This provides detailed context about the incident.
minLength: 1
webexConfigs []object
webexConfigs defines the list of Webex configurations.
apiURL string
apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages
pattern: ^https?://.+$
httpConfig object
httpConfig defines the HTTP client's configuration.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
message string
message defines the message template
roomID string required
roomID defines the ID of the Webex Teams room where to send the messages.
minLength: 1
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
webhookConfigs []object
webhookConfigs defines the List of webhook configurations.
httpConfig object
httpConfig defines the HTTP client configuration for webhook requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
maxAlerts integer
maxAlerts defines the maximum number of alerts to be sent per webhook message. When 0, all alerts are included in the webhook payload.
format: int32
minimum: 0
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
timeout string
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.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
url string
url defines the URL to send HTTP POST requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined.
urlSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
wechatConfigs []object
wechatConfigs defines the list of WeChat configurations.
agentID string
agentID defines the application agent ID within WeChat Work. This identifies which WeChat Work application will send the notifications.
minLength: 1
apiSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
apiURL string
apiURL defines the WeChat API URL. When not specified, defaults to the standard WeChat Work API endpoint.
pattern: ^https?://.+$
corpID string
corpID defines the corp id for authentication. This is the unique identifier for your WeChat Work organization.
minLength: 1
httpConfig object
httpConfig defines the HTTP client configuration for WeChat API requests.
authorization object
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
credentials object
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
type string
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth object
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
password object
password defines a key of a Secret containing the password for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
username object
username defines a key of a Secret containing the username for authentication.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
bearerTokenSecret object
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.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
enableHttp2 boolean
enableHttp2 can be used to disable HTTP2.
followRedirects boolean
followRedirects specifies whether the client should follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxy string
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 object
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
clientId object required
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
clientSecret object required
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
endpointParams object
endpointParams configures the HTTP parameters to append to the token URL.
noProxy string
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 object
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.
proxyFromEnvironment boolean
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 string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
scopes []string
scopes defines the OAuth2 scopes used for the token request.
tlsConfig object
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
tokenUrl string required
tokenUrl defines the URL to fetch the token from.
minLength: 1
proxyConnectHeader object
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.
proxyFromEnvironment boolean
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 string
proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`.
proxyUrl string
proxyUrl defines the HTTP proxy server to use.
pattern: ^(http|https|socks5)://.+$
tlsConfig object
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
ca object
ca defines the Certificate authority used when verifying server certificates.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
cert object
cert defines the Client certificate to present when doing client-authentication.
configMap object
configMap defines the ConfigMap containing data to use for the targets.
key string required
The key to select.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the ConfigMap or its key must be defined
secret object
secret defines the Secret containing data to use for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
insecureSkipVerify boolean
insecureSkipVerify defines how to disable target certificate validation.
keySecret object
keySecret defines the Secret containing the client key file for the targets.
key string required
The key of the secret to select from. Must be a valid secret key.
name string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional boolean
Specify whether the Secret or its key must be defined
maxVersion string
maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
enum: TLS10, TLS11, TLS12, TLS13
minVersion string
minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
enum: TLS10, TLS11, TLS12, TLS13
serverName string
serverName is used to verify the hostname for the targets.
message string
message defines the API request data as defined by the WeChat API. This contains the actual notification content to be sent.
minLength: 1
messageType string
messageType defines the type of message to send. Valid values include "text", "markdown", and other WeChat Work supported message types.
minLength: 1
sendResolved boolean
sendResolved defines whether or not to notify about resolved alerts.
toParty string
toParty defines the target department(s) to receive the notification. Can be a single department ID or multiple department IDs separated by '|'.
minLength: 1
toTag string
toTag defines the target tag(s) to receive the notification. Can be a single tag ID or multiple tag IDs separated by '|'.
minLength: 1
toUser string
toUser defines the target user(s) to receive the notification. Can be a single user ID or multiple user IDs separated by '|'.
minLength: 1
route object
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.
activeTimeIntervals []string
activeTimeIntervals is a list of MuteTimeInterval names when this route should be active.
continue boolean
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 []string
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 string
groupInterval defines how long to wait before sending an updated notification. Must be greater than 0. Example: "5m"
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
minLength: 1
groupWait string
groupWait defines how long to wait before sending the initial notification. Example: "30s"
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
minLength: 1
matchers []object
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.
matchType string
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).
enum: !=, =, =~, !~
name string required
name defines the label to match. This specifies which alert label should be evaluated.
minLength: 1
regex boolean
regex defines whether to match on equality (false) or regular-expression (true). Deprecated: for AlertManager >= v0.22.0, `matchType` should be used instead.
value string
value defines the label value to match. This is the expected value for the specified label.
muteTimeIntervals []string
muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,
receiver string
receiver defines the name of the receiver for this route. If not empty, it should be listed in the `receivers` field.
repeatInterval string
repeatInterval defines how long to wait before repeating the last notification. Must be greater than 0. Example: "4h"
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
minLength: 1
routes []
routes defines the child routes.
status object
status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled. Most recent observed status of the ServiceMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
bindings []object
bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
conditions []object
conditions defines the current state of the configuration resource when bound to the referenced Workload object.
lastTransitionTime string required
lastTransitionTime defines the time of the last update to the current status property.
format: date-time
message string
message defines the human-readable message indicating details for the condition's last transition.
observedGeneration integer
observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the object.
format: int64
reason string
reason for the condition's last transition.
status string required
status of the condition.
minLength: 1
type string required
type of the condition being reported. Currently, only "Accepted" is supported.
enum: Accepted
minLength: 1
group string required
group defines the group of the referenced resource.
enum: monitoring.coreos.com
name string required
name defines the name of the referenced object.
minLength: 1
namespace string required
namespace defines the namespace of the referenced object.
minLength: 1
resource string required
resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).
enum: prometheuses, prometheusagents, thanosrulers, alertmanagers
Copied!