AlertmanagerConfig
Scope: Namespaced
Version: v1alpha1
AlertmanagerConfig defines a namespaced AlertmanagerConfig to be aggregated across multiple namespaces configuring one Alertmanager cluster.
- apiVersion
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
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
- spec
Required value
AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the
namespace
label is equal to the namespace of the AlertmanagerConfig resource.- spec.inhibitRules
List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.
InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule
- spec.inhibitRules.equal
Labels that must have an equal value in the source and target alert for the inhibition to take effect.
- spec.inhibitRules.sourceMatch
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.
Matcher defines how to match on alert’s labels.
- spec.inhibitRules.sourceMatch.matchType
Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty.
Allowed values:
!=
,=
,=~
,!~
- spec.inhibitRules.sourceMatch.name
Required value
Label to match.
- spec.inhibitRules.sourceMatch.regex
Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead.
- spec.inhibitRules.sourceMatch.value
Label value to match.
- spec.inhibitRules.targetMatch
Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace.
Matcher defines how to match on alert’s labels.
- spec.inhibitRules.targetMatch.matchType
Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty.
Allowed values:
!=
,=
,=~
,!~
- spec.inhibitRules.targetMatch.name
Required value
Label to match.
- spec.inhibitRules.targetMatch.regex
Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead.
- spec.inhibitRules.targetMatch.value
Label value to match.
- spec.muteTimeIntervals
List of MuteTimeInterval specifying when the routes should be muted.
MuteTimeInterval specifies the periods in time when notifications will be muted
- spec.muteTimeIntervals.name
Name of the time interval
- spec.muteTimeIntervals.timeIntervals
TimeIntervals is a list of TimeInterval
TimeInterval describes intervals of time
- spec.muteTimeIntervals.timeIntervals.daysOfMonth
DaysOfMonth is a list of DayOfMonthRange
DayOfMonthRange is an inclusive range of days of the month beginning at 1
- spec.muteTimeIntervals.timeIntervals.daysOfMonth.end
End of the inclusive range
Allowed values:
-31 <= X <= 31
- spec.muteTimeIntervals.timeIntervals.daysOfMonth.start
Start of the inclusive range
Allowed values:
-31 <= X <= 31
- spec.muteTimeIntervals.timeIntervals.months
Months is a list of MonthRange
- Element of the array
MonthRange is an inclusive range of months of the year beginning in January Months can be specified by name (e.g ‘January’) by numerical month (e.g ‘1’) or as an inclusive range (e.g ‘January:March’, ‘1:3’, ‘1:March’)
Pattern:
^((?i)january|february|march|april|may|june|july|august|september|october|november|december|[1-12])(?:((:((?i)january|february|march|april|may|june|july|august|september|october|november|december|[1-12]))$)|$)
- spec.muteTimeIntervals.timeIntervals.times
Times is a list of TimeRange
TimeRange defines a start and end time in 24hr format
- spec.muteTimeIntervals.timeIntervals.times.endTime
EndTime is the end time in 24hr format.
Pattern:
^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)
- spec.muteTimeIntervals.timeIntervals.times.startTime
StartTime is the start time in 24hr format.
Pattern:
^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)
- spec.muteTimeIntervals.timeIntervals.weekdays
Weekdays is a list of WeekdayRange
- Element of the array
WeekdayRange is an inclusive range of days of the week beginning on Sunday Days can be specified by name (e.g ‘Sunday’) or as an inclusive range (e.g ‘Monday:Friday’)
Pattern:
^((?i)sun|mon|tues|wednes|thurs|fri|satur)day(?:((:(sun|mon|tues|wednes|thurs|fri|satur)day)$)|$)
- spec.muteTimeIntervals.timeIntervals.years
Years is a list of YearRange
- Element of the array
YearRange is an inclusive range of years
Pattern:
^2\d{3}(?::2\d{3}|$)
- spec.receivers
List of receivers.
Receiver defines one or more notification integrations.
- spec.receivers.discordConfigs
List of Discord configurations.
DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config
- spec.receivers.discordConfigs.apiURL
Required value
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.
- spec.receivers.discordConfigs.apiURL.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.discordConfigs.apiURL.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.apiURL.optional
Specify whether the Secret or its key must be defined
- spec.receivers.discordConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.discordConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.discordConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.discordConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.discordConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.discordConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.discordConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.discordConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.discordConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.discordConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.discordConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.discordConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.discordConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.discordConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.discordConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.discordConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.discordConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.discordConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.discordConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.discordConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.discordConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.discordConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.discordConfigs.message
The template of the message’s body.
- spec.receivers.discordConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.discordConfigs.title
The template of the message’s title.
- spec.receivers.emailConfigs
List of Email configurations.
EmailConfig configures notifications via Email.
- spec.receivers.emailConfigs.authIdentity
The identity to use for authentication.
- spec.receivers.emailConfigs.authPassword
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.
- spec.receivers.emailConfigs.authPassword.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.emailConfigs.authPassword.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.emailConfigs.authPassword.optional
Specify whether the Secret or its key must be defined
- spec.receivers.emailConfigs.authSecret
The secret’s key that contains the CRAM-MD5 secret. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- spec.receivers.emailConfigs.authSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.emailConfigs.authSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.emailConfigs.authSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.emailConfigs.authUsername
The username to use for authentication.
- spec.receivers.emailConfigs.from
The sender address.
- spec.receivers.emailConfigs.headers
Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.
KeyValue defines a (key, value) tuple.
- spec.receivers.emailConfigs.headers.key
Required value
Key of the tuple.
- spec.receivers.emailConfigs.headers.value
Required value
Value of the tuple.
- spec.receivers.emailConfigs.hello
The hostname to identify to the SMTP server.
- spec.receivers.emailConfigs.html
The HTML body of the email notification.
- spec.receivers.emailConfigs.requireTLS
The SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
- spec.receivers.emailConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.emailConfigs.smarthost
The SMTP host and port through which emails are sent. E.g. example.com:25
- spec.receivers.emailConfigs.text
The text body of the email notification.
- spec.receivers.emailConfigs.tlsConfig
TLS configuration
- spec.receivers.emailConfigs.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.emailConfigs.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.emailConfigs.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.emailConfigs.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.emailConfigs.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.emailConfigs.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.emailConfigs.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.emailConfigs.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.emailConfigs.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.emailConfigs.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.emailConfigs.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.emailConfigs.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.emailConfigs.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.emailConfigs.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.emailConfigs.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.emailConfigs.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.emailConfigs.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.emailConfigs.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.emailConfigs.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.emailConfigs.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.emailConfigs.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.emailConfigs.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.emailConfigs.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.emailConfigs.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.emailConfigs.to
The email address to send notifications to.
- spec.receivers.name
Required value
Name of the receiver. Must be unique across all items from the list.
- spec.receivers.opsgenieConfigs
List of OpsGenie configurations.
OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
- spec.receivers.opsgenieConfigs.actions
Comma separated list of actions that will be available for the alert.
- spec.receivers.opsgenieConfigs.apiKey
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.
- spec.receivers.opsgenieConfigs.apiKey.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.opsgenieConfigs.apiKey.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.apiKey.optional
Specify whether the Secret or its key must be defined
- spec.receivers.opsgenieConfigs.apiURL
The URL to send OpsGenie API requests to.
- spec.receivers.opsgenieConfigs.description
Description of the incident.
- spec.receivers.opsgenieConfigs.details
A set of arbitrary key/value pairs that provide further detail about the incident.
KeyValue defines a (key, value) tuple.
- spec.receivers.opsgenieConfigs.details.key
Required value
Key of the tuple.
- spec.receivers.opsgenieConfigs.details.value
Required value
Value of the tuple.
- spec.receivers.opsgenieConfigs.entity
Optional field that can be used to specify which domain alert is related to.
- spec.receivers.opsgenieConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.opsgenieConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.opsgenieConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.opsgenieConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.opsgenieConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.opsgenieConfigs.message
Alert text limited to 130 characters.
- spec.receivers.opsgenieConfigs.note
Additional alert note.
- spec.receivers.opsgenieConfigs.priority
Priority level of alert. Possible values are P1, P2, P3, P4, and P5.
- spec.receivers.opsgenieConfigs.responders
List of responders responsible for notifications.
OpsGenieConfigResponder defines a responder to an incident. One of
id
,name
orusername
has to be defined.- spec.receivers.opsgenieConfigs.responders.id
ID of the responder.
- spec.receivers.opsgenieConfigs.responders.name
Name of the responder.
- spec.receivers.opsgenieConfigs.responders.type
Required value
Type of responder.
Allowed values:
team
,teams
,user
,escalation
,schedule
- spec.receivers.opsgenieConfigs.responders.username
Username of the responder.
- spec.receivers.opsgenieConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.opsgenieConfigs.source
Backlink to the sender of the notification.
- string
Comma separated list of tags attached to the notifications.
- spec.receivers.opsgenieConfigs.updateAlerts
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.
- spec.receivers.pagerdutyConfigs
List of PagerDuty configurations.
PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
- spec.receivers.pagerdutyConfigs.class
The class/type of the event.
- spec.receivers.pagerdutyConfigs.client
Client identification.
- spec.receivers.pagerdutyConfigs.clientURL
Backlink to the sender of notification.
- spec.receivers.pagerdutyConfigs.component
The part or component of the affected system that is broken.
- spec.receivers.pagerdutyConfigs.description
Description of the incident.
- spec.receivers.pagerdutyConfigs.details
Arbitrary key/value pairs that provide further detail about the incident.
KeyValue defines a (key, value) tuple.
- spec.receivers.pagerdutyConfigs.details.key
Required value
Key of the tuple.
- spec.receivers.pagerdutyConfigs.details.value
Required value
Value of the tuple.
- spec.receivers.pagerdutyConfigs.group
A cluster or grouping of sources.
- spec.receivers.pagerdutyConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.pagerdutyConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.pagerdutyConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs
A list of image details to attach that provide further detail about an incident.
PagerDutyImageConfig attaches images to an incident
- spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs.alt
Alt is the optional alternative text for the image.
- spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs.href
Optional URL; makes the image a clickable link.
- spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs.src
Src of the image being attached to the incident
- spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs
A list of link details to attach that provide further detail about an incident.
PagerDutyLinkConfig attaches text links to an incident
- spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs.alt
Text that describes the purpose of the link, and can be used as the link’s text.
- spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs.href
Href is the URL of the link to be attached
- spec.receivers.pagerdutyConfigs.routingKey
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.- spec.receivers.pagerdutyConfigs.routingKey.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.routingKey.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.routingKey.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.pagerdutyConfigs.serviceKey
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.- spec.receivers.pagerdutyConfigs.serviceKey.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pagerdutyConfigs.serviceKey.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pagerdutyConfigs.serviceKey.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pagerdutyConfigs.severity
Severity of the incident.
- spec.receivers.pagerdutyConfigs.url
The URL to send requests to.
- spec.receivers.pushoverConfigs
List of Pushover configurations.
PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
- spec.receivers.pushoverConfigs.expire
How long your notification will continue to be retried for, unless the user acknowledges the notification.
Pattern:
^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
- spec.receivers.pushoverConfigs.html
Whether notification message is HTML or plain text.
- spec.receivers.pushoverConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.pushoverConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.pushoverConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.pushoverConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.pushoverConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.pushoverConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.pushoverConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.pushoverConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.pushoverConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pushoverConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.pushoverConfigs.message
Notification message.
- spec.receivers.pushoverConfigs.priority
Priority, see https://pushover.net/api#priority
- spec.receivers.pushoverConfigs.retry
How often the Pushover servers will send the same notification to the user. Must be at least 30 seconds.
Pattern:
^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
- spec.receivers.pushoverConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.pushoverConfigs.sound
The name of one of the sounds supported by device clients to override the user’s default sound choice
- spec.receivers.pushoverConfigs.title
Notification title.
- spec.receivers.pushoverConfigs.token
The secret’s key that contains the registered application’s API token, see https://pushover.net/apps. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- spec.receivers.pushoverConfigs.token.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.token.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.token.optional
Specify whether the Secret or its key must be defined
- spec.receivers.pushoverConfigs.url
A supplementary URL shown alongside the message.
- spec.receivers.pushoverConfigs.urlTitle
A title for supplementary URL, otherwise just the URL is shown
- spec.receivers.pushoverConfigs.userKey
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.
- spec.receivers.pushoverConfigs.userKey.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.pushoverConfigs.userKey.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.pushoverConfigs.userKey.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs
List of Slack configurations.
SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
- spec.receivers.slackConfigs.actions
A list of Slack actions that are sent with each notification.
SlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information.
- spec.receivers.slackConfigs.actions.confirm
SlackConfirmationField protect users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields for more information.
- spec.receivers.slackConfigs.actions.confirm.dismissText
- spec.receivers.slackConfigs.actions.confirm.okText
- spec.receivers.slackConfigs.actions.confirm.text
Required value
- spec.receivers.slackConfigs.actions.confirm.title
- spec.receivers.slackConfigs.actions.name
- spec.receivers.slackConfigs.actions.style
- spec.receivers.slackConfigs.actions.text
Required value
- spec.receivers.slackConfigs.actions.type
Required value
- spec.receivers.slackConfigs.actions.url
- spec.receivers.slackConfigs.actions.value
- spec.receivers.slackConfigs.apiURL
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.
- spec.receivers.slackConfigs.apiURL.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.slackConfigs.apiURL.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.apiURL.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs.callbackId
- spec.receivers.slackConfigs.channel
The channel or user to send notifications to.
- spec.receivers.slackConfigs.color
- spec.receivers.slackConfigs.fallback
- spec.receivers.slackConfigs.fields
A list of Slack fields that are sent with each notification.
SlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information.
- spec.receivers.slackConfigs.fields.short
- spec.receivers.slackConfigs.fields.title
Required value
- spec.receivers.slackConfigs.fields.value
Required value
- string
- spec.receivers.slackConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.slackConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.slackConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.slackConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.slackConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.slackConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.slackConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.slackConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.slackConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.slackConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.slackConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.slackConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.slackConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.slackConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.slackConfigs.iconEmoji
- spec.receivers.slackConfigs.iconURL
- spec.receivers.slackConfigs.imageURL
- spec.receivers.slackConfigs.linkNames
- spec.receivers.slackConfigs.mrkdwnIn
- spec.receivers.slackConfigs.pretext
- spec.receivers.slackConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.slackConfigs.shortFields
- spec.receivers.slackConfigs.text
- spec.receivers.slackConfigs.thumbURL
- spec.receivers.slackConfigs.title
- spec.receivers.slackConfigs.titleLink
- spec.receivers.slackConfigs.username
- spec.receivers.snsConfigs
List of SNS configurations
SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
- spec.receivers.snsConfigs.apiURL
The SNS API URL i.e. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used.
- spec.receivers.snsConfigs.attributes
SNS message attributes.
- spec.receivers.snsConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.snsConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.snsConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.snsConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.snsConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.snsConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.snsConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.snsConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.snsConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.snsConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.snsConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.snsConfigs.message
The message content of the SNS notification.
- spec.receivers.snsConfigs.phoneNumber
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.
- spec.receivers.snsConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.snsConfigs.sigv4
Configures AWS’s Signature Verification 4 signing process to sign requests.
- spec.receivers.snsConfigs.sigv4.accessKey
AccessKey is the AWS API key. If not specified, the environment variable
AWS_ACCESS_KEY_ID
is used.- spec.receivers.snsConfigs.sigv4.accessKey.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.sigv4.accessKey.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.sigv4.accessKey.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.sigv4.profile
Profile is the named AWS profile used to authenticate.
- spec.receivers.snsConfigs.sigv4.region
Region is the AWS region. If blank, the region from the default credentials chain used.
- spec.receivers.snsConfigs.sigv4.roleArn
RoleArn is the named AWS profile used to authenticate.
- spec.receivers.snsConfigs.sigv4.secretKey
SecretKey is the AWS API secret. If not specified, the environment variable
AWS_SECRET_ACCESS_KEY
is used.- spec.receivers.snsConfigs.sigv4.secretKey.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.snsConfigs.sigv4.secretKey.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.snsConfigs.sigv4.secretKey.optional
Specify whether the Secret or its key must be defined
- spec.receivers.snsConfigs.subject
Subject line when the message is delivered to email endpoints.
- spec.receivers.snsConfigs.targetARN
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 topic_arn or PhoneNumber.
- spec.receivers.snsConfigs.topicARN
SNS topic ARN, i.e. 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.
- spec.receivers.telegramConfigs
List of Telegram configurations.
TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config
- spec.receivers.telegramConfigs.apiURL
The Telegram API URL i.e. https://api.telegram.org. If not specified, default API URL will be used.
- spec.receivers.telegramConfigs.botToken
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. EitherbotToken
orbotTokenFile
is required.- spec.receivers.telegramConfigs.botToken.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.telegramConfigs.botToken.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.botToken.optional
Specify whether the Secret or its key must be defined
- spec.receivers.telegramConfigs.botTokenFile
File to read the Telegram bot token from. It is mutually exclusive with
botToken
. EitherbotToken
orbotTokenFile
is required. It requires Alertmanager >= v0.26.0. - spec.receivers.telegramConfigs.chatID
The Telegram chat ID.
- spec.receivers.telegramConfigs.disableNotifications
Disable telegram notifications
- spec.receivers.telegramConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.telegramConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.telegramConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.telegramConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.telegramConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.telegramConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.telegramConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.telegramConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.telegramConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.telegramConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.telegramConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.telegramConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.telegramConfigs.message
Message template
- spec.receivers.telegramConfigs.parseMode
Parse mode for telegram message
Allowed values:
MarkdownV2
,Markdown
,HTML
- spec.receivers.telegramConfigs.sendResolved
Whether to notify about resolved alerts.
- spec.receivers.victoropsConfigs
List of VictorOps configurations.
VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config
- spec.receivers.victoropsConfigs.apiKey
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.
- spec.receivers.victoropsConfigs.apiKey.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.victoropsConfigs.apiKey.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.apiKey.optional
Specify whether the Secret or its key must be defined
- spec.receivers.victoropsConfigs.apiUrl
The VictorOps API URL.
- spec.receivers.victoropsConfigs.customFields
Additional custom fields for notification.
KeyValue defines a (key, value) tuple.
- spec.receivers.victoropsConfigs.customFields.key
Required value
Key of the tuple.
- spec.receivers.victoropsConfigs.customFields.value
Required value
Value of the tuple.
- spec.receivers.victoropsConfigs.entityDisplayName
Contains summary of the alerted problem.
- spec.receivers.victoropsConfigs.httpConfig
The HTTP client’s configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.victoropsConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.victoropsConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.victoropsConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.victoropsConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.victoropsConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.victoropsConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.victoropsConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.victoropsConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.victoropsConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.victoropsConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.victoropsConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.victoropsConfigs.messageType
Describes the behavior of the alert (CRITICAL, WARNING, INFO).
- spec.receivers.victoropsConfigs.monitoringTool
The monitoring tool the state message is from.
- spec.receivers.victoropsConfigs.routingKey
A key used to map the alert to a team.
- spec.receivers.victoropsConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.victoropsConfigs.stateMessage
Contains long explanation of the alerted problem.
- spec.receivers.webexConfigs
List of Webex configurations.
WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config
- spec.receivers.webexConfigs.apiURL
The Webex Teams API URL i.e. https://webexapis.com/v1/messages Provide if different from the default API URL.
Pattern:
^https?://.+$
- spec.receivers.webexConfigs.httpConfig
The HTTP client’s configuration. You must supply the bot token via the
httpConfig.authorization
field.- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.webexConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.webexConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.webexConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webexConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webexConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.webexConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webexConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webexConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.webexConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webexConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webexConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.webexConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.webexConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webexConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.webexConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.webexConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.webexConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.webexConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webexConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webexConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webexConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.webexConfigs.message
Message template
- spec.receivers.webexConfigs.roomID
Required value
ID of the Webex Teams room where to send the messages.
- spec.receivers.webexConfigs.sendResolved
Whether to notify about resolved alerts.
- spec.receivers.webhookConfigs
List of webhook configurations.
WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
- spec.receivers.webhookConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.webhookConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.webhookConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.webhookConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webhookConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.webhookConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webhookConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.webhookConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.webhookConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.webhookConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.webhookConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.webhookConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.webhookConfigs.maxAlerts
Maximum number of alerts to be sent per webhook message. When 0, all alerts are included.
Allowed values:
0 <= X
- spec.receivers.webhookConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.webhookConfigs.url
The URL to send HTTP POST requests to.
urlSecret
takes precedence overurl
. One ofurlSecret
andurl
should be defined. - spec.receivers.webhookConfigs.urlSecret
The secret’s key that contains the webhook URL to send HTTP requests to.
urlSecret
takes precedence overurl
. One ofurlSecret
andurl
should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.- spec.receivers.webhookConfigs.urlSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.webhookConfigs.urlSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.webhookConfigs.urlSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs
List of WeChat configurations.
WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config
- spec.receivers.wechatConfigs.agentID
- spec.receivers.wechatConfigs.apiSecret
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.
- spec.receivers.wechatConfigs.apiSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.wechatConfigs.apiSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.apiSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs.apiURL
The WeChat API URL.
- spec.receivers.wechatConfigs.corpID
The corp id for authentication.
- spec.receivers.wechatConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
Selects a key of a Secret in the namespace that contains the credentials for authentication.
- string
Required value
The key of the secret to select from. Must be a valid secret key.
- string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- boolean
Specify whether the Secret or its key must be defined
- string
Defines the authentication type. The value is case-insensitive. “Basic” is not a supported value. Default: “Bearer”
- spec.receivers.wechatConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- spec.receivers.wechatConfigs.httpConfig.basicAuth.password
The secret in the service monitor namespace that contains the password for authentication.
- spec.receivers.wechatConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.wechatConfigs.httpConfig.basicAuth.password.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.basicAuth.username
The secret in the service monitor namespace that contains the username for authentication.
- spec.receivers.wechatConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.wechatConfigs.httpConfig.basicAuth.username.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret
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.
- spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- spec.receivers.wechatConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientId
Required value
The secret or configmap containing the OAuth2 client id
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret
Secret containing data to use for the targets.
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret
Required value
The secret containing the OAuth2 client secret
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- spec.receivers.wechatConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- spec.receivers.wechatConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- spec.receivers.wechatConfigs.httpConfig.proxyURL
Optional proxy URL.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from. Must be a valid secret key.
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must be defined
- spec.receivers.wechatConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- spec.receivers.wechatConfigs.message
API request data as defined by the WeChat API.
- spec.receivers.wechatConfigs.messageType
- spec.receivers.wechatConfigs.sendResolved
Whether or not to notify about resolved alerts.
- spec.receivers.wechatConfigs.toParty
- spec.receivers.wechatConfigs.toTag
- spec.receivers.wechatConfigs.toUser
- spec.route
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.
- spec.route.activeTimeIntervals
ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active.
- spec.route.continue
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.
- spec.route.groupBy
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.
- spec.route.groupInterval
How long to wait before sending an updated notification. Must match the regular expression
^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
Example: “5m” - spec.route.groupWait
How long to wait before sending the initial notification. Must match the regular expression
^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
Example: “30s” - spec.route.matchers
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 anamespace: <object namespace>
matcher.Matcher defines how to match on alert’s labels.
- spec.route.matchers.matchType
Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty.
Allowed values:
!=
,=
,=~
,!~
- spec.route.matchers.name
Required value
Label to match.
- spec.route.matchers.regex
Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead.
- spec.route.matchers.value
Label value to match.
- spec.route.muteTimeIntervals
Note: this comment applies to the field definition above but appears below otherwise it gets included in the generated manifest. CRD schema doesn’t support self-referential types for now (see https://github.com/kubernetes/kubernetes/issues/62872). We have to use an alternative type to circumvent the limitation. The downside is that the Kube API can’t validate the data beyond the fact that it is a valid JSON representation. MuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,
- spec.route.receiver
Name of the receiver for this route. If not empty, it should be listed in the
receivers
field. - spec.route.repeatInterval
How long to wait before repeating the last notification. Must match the regular expression
^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
Example: “4h” - spec.route.routes
Child routes.