AlertmanagerConfig [monitoring.coreos.com/v1beta1]
- Description
- The
AlertmanagerConfigcustom resource definition (CRD) defines howAlertmanagerobjects process Prometheus alerts. It allows to specify alert grouping and routing, notification receivers and inhibition rules.Alertmanagerobjects selectAlertmanagerConfigobjects using label and namespace selectors. - Type
-
`object`
- Required
-
spec
Specification
| Property | Type | Description |
|---|---|---|
apiVersion | string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kind | string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadata | ObjectMeta | Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
spec | object | spec defines the specification of AlertmanagerConfigSpec |
status | object | status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled. Most recent observed status of the ServiceMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
.spec
- Description
- spec defines the specification of AlertmanagerConfigSpec
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
inhibitRules | array | inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource’s namespace. |
inhibitRules[] | object | InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule |
receivers | array | receivers defines the list of receivers. |
receivers[] | object | Receiver defines one or more notification integrations. |
route | object | route defines the Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route. |
timeIntervals | array | timeIntervals defines the list of timeIntervals specifying when the routes should be muted. |
timeIntervals[] | object | TimeInterval specifies the periods in time when notifications will be muted or active. |
.spec.inhibitRules
- Description
- inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.
- Type
-
`array`
.spec.inhibitRules[]
- Description
- 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
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
equal | array (string) | equal defines labels that must have an equal value in the source and target alert for the inhibition to take effect. This ensures related alerts are properly grouped. |
sourceMatch | array | sourceMatch defines matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace. These are the "trigger" alerts that cause other alerts to be inhibited. |
sourceMatch[] | object | Matcher defines how to match on alert’s labels. |
targetMatch | array | targetMatch defines matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace. When these conditions are met, matching alerts will be inhibited (silenced). |
targetMatch[] | object | Matcher defines how to match on alert’s labels. |
.spec.inhibitRules[].sourceMatch
- Description
- sourceMatch defines matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace. These are the "trigger" alerts that cause other alerts to be inhibited.
- Type
-
`array`
.spec.inhibitRules[].sourceMatch[]
- Description
- Matcher defines how to match on alert’s labels.
- Type
-
`object`
- Required
-
name
| Property | Type | Description |
|---|---|---|
matchType | string | matchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "= |
name | string | name defines the label to match. This specifies which alert label should be evaluated. |
value | string | value defines the label value to match. This is the expected value for the specified label. |
.spec.inhibitRules[].targetMatch
- Description
- targetMatch defines matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace. When these conditions are met, matching alerts will be inhibited (silenced).
- Type
-
`array`
.spec.inhibitRules[].targetMatch[]
- Description
- Matcher defines how to match on alert’s labels.
- Type
-
`object`
- Required
-
name
| Property | Type | Description |
|---|---|---|
matchType | string | matchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "= |
name | string | name defines the label to match. This specifies which alert label should be evaluated. |
value | string | value defines the label value to match. This is the expected value for the specified label. |
.spec.receivers
- Description
- receivers defines the list of receivers.
- Type
-
`array`
.spec.receivers[]
- Description
- Receiver defines one or more notification integrations.
- Type
-
`object`
- Required
-
name
| Property | Type | Description |
|---|---|---|
discordConfigs | array | discordConfigs defines the list of Discord configurations. |
discordConfigs[] | object | DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config |
emailConfigs | array | emailConfigs defines the list of Email configurations. |
emailConfigs[] | object | EmailConfig configures notifications via Email. |
msteamsConfigs | array | msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0. |
msteamsConfigs[] | object | MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0. |
msteamsv2Configs | array | msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0. |
msteamsv2Configs[] | object | MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0. |
name | string | name defines the name of the receiver. Must be unique across all items from the list. |
opsgenieConfigs | array | opsgenieConfigs defines the list of OpsGenie configurations. |
opsgenieConfigs[] | object | OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config |
pagerdutyConfigs | array | pagerdutyConfigs defines the List of PagerDuty configurations. |
pagerdutyConfigs[] | object | PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config |
pushoverConfigs | array | pushoverConfigs defines the list of Pushover configurations. |
pushoverConfigs[] | object | PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config |
rocketchatConfigs | array | rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0. |
rocketchatConfigs[] | object | RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0. |
slackConfigs | array | slackConfigs defines the list of Slack configurations. |
slackConfigs[] | object | SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config |
snsConfigs | array | snsConfigs defines the list of SNS configurations |
snsConfigs[] | object | SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs |
telegramConfigs | array | telegramConfigs defines the list of Telegram configurations. |
telegramConfigs[] | object | TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config |
victoropsConfigs | array | victoropsConfigs defines the list of VictorOps configurations. |
victoropsConfigs[] | object | VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config |
webexConfigs | array | webexConfigs defines the list of Webex configurations. |
webexConfigs[] | object | WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config |
webhookConfigs | array | webhookConfigs defines the List of webhook configurations. |
webhookConfigs[] | object | WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config |
wechatConfigs | array | wechatConfigs defines the list of WeChat configurations. |
wechatConfigs[] | object | WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config |
.spec.receivers[].discordConfigs
- Description
- discordConfigs defines the list of Discord configurations.
- Type
-
`array`
.spec.receivers[].discordConfigs[]
- Description
- DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config
- Type
-
`object`
- Required
-
apiURL
| Property | Type | Description |
|---|---|---|
apiURL | object | apiURL defines the secret’s key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
avatarURL | string | avatarURL defines the avatar url of the message sender. |
content | string | content defines the template of the content’s body. |
httpConfig | object | httpConfig defines HTTP client configuration. |
message | string | message defines the template of the message’s body. |
sendResolved | boolean | sendResolved defines whether or not to notify about resolved alerts. |
title | string | title defines the template of the message’s title. |
username | string | username defines the username of the message sender. |
.spec.receivers[].discordConfigs[].apiURL
- Description
- apiURL defines the secret’s key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig
- Description
- httpConfig defines HTTP client configuration.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
authorization | object | authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
basicAuth | object | basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
bearerTokenSecret | object | bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
enableHttp2 | boolean | enableHttp2 can be used to disable HTTP2. |
followRedirects | boolean | followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
noProxy | string | noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
oauth2 | object | oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
proxyConnectHeader | object | proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader{} | array | |
proxyConnectHeader{}[] | object | SecretKeySelector selects a key of a Secret. |
proxyFromEnvironment | boolean | proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyURL | string | proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl. |
proxyUrl | string | proxyUrl defines the HTTP proxy server to use. |
tlsConfig | object | tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
.spec.receivers[].discordConfigs[].httpConfig.authorization
- Description
- authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
credentials | object | credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
type | string | type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
.spec.receivers[].discordConfigs[].httpConfig.authorization.credentials
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.basicAuth
- Description
- basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
password | object | password defines a key of a Secret containing the password for authentication. |
username | object | username defines a key of a Secret containing the username for authentication. |
.spec.receivers[].discordConfigs[].httpConfig.basicAuth.password
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.basicAuth.username
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.bearerTokenSecret
- Description
- bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- Type
-
`object`
- Required
-
keyname
| Property | Type | Description |
|---|---|---|
key | string | key defines the key of the secret to select from. Must be a valid secret key. |
name | string | name defines the name of the secret in the object’s namespace to select from. |
.spec.receivers[].discordConfigs[].httpConfig.oauth2
- Description
- oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
- Type
-
`object`
- Required
-
clientIdclientSecrettokenUrl
| Property | Type | Description |
|---|---|---|
clientId | object | clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
clientSecret | object | clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
endpointParams | object (string) | endpointParams configures the HTTP parameters to append to the token URL. |
noProxy | string | noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader | object | proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader{} | array | |
proxyConnectHeader{}[] | object | SecretKeySelector selects a key of a Secret. |
proxyFromEnvironment | boolean | proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyUrl | string | proxyUrl defines the HTTP proxy server to use. |
scopes | array (string) | scopes defines the OAuth2 scopes used for the token request. |
tlsConfig | object | tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
tokenUrl | string | tokenUrl defines the URL to fetch the token from. |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.clientId
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.clientId.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.clientId.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.clientSecret
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.proxyConnectHeader
- Description
- proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
`object`
.spec.receivers[].discordConfigs[].httpConfig.oauth2.proxyConnectHeader{}
Description
- Type
-
`array`
.spec.receivers[].discordConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
ca | object | ca defines the Certificate authority used when verifying server certificates. |
cert | object | cert defines the Client certificate to present when doing client-authentication. |
insecureSkipVerify | boolean | insecureSkipVerify defines how to disable target certificate validation. |
keySecret | object | keySecret defines the Secret containing the client key file for the targets. |
maxVersion | string | maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
minVersion | string | minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
serverName | string | serverName is used to verify the hostname for the targets. |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.ca
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.ca.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.cert
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.cert.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.keySecret
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.proxyConnectHeader
- Description
- proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
`object`
.spec.receivers[].discordConfigs[].httpConfig.proxyConnectHeader{}
Description
- Type
-
`array`
.spec.receivers[].discordConfigs[].httpConfig.proxyConnectHeader{}[]
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.tlsConfig
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
ca | object | ca defines the Certificate authority used when verifying server certificates. |
cert | object | cert defines the Client certificate to present when doing client-authentication. |
insecureSkipVerify | boolean | insecureSkipVerify defines how to disable target certificate validation. |
keySecret | object | keySecret defines the Secret containing the client key file for the targets. |
maxVersion | string | maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
minVersion | string | minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
serverName | string | serverName is used to verify the hostname for the targets. |
.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.ca
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.ca.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.ca.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.cert
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.cert.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.cert.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.keySecret
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].emailConfigs
- Description
- emailConfigs defines the list of Email configurations.
- Type
-
`array`
.spec.receivers[].emailConfigs[]
- Description
- EmailConfig configures notifications via Email.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
authIdentity | string | authIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism. |
authPassword | object | authPassword defines the secret’s key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
authSecret | object | authSecret defines the secret’s key that contains the CRAM-MD5 secret. This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
authUsername | string | authUsername defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication. |
forceImplicitTLS | boolean | forceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security. true: force use of implicit TLS (direct TLS connection on any port) false: force disable implicit TLS (use explicit TLS/STARTTLS if required) nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility It requires Alertmanager >= v0.31.0. |
from | string | from defines the sender address for email notifications. This appears as the "From" field in the email header. |
headers | array | headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation. |
headers[] | object | KeyValue defines a (key, value) tuple. |
hello | string | hello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake. |
html | string | html defines the HTML body of the email notification. This allows for rich formatting in the email content. |
requireTLS | boolean | requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints. |
sendResolved | boolean | sendResolved defines whether or not to notify about resolved alerts. |
smarthost | string | smarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587". |
text | string | text defines the plain text body of the email notification. This provides a fallback for email clients that don’t support HTML. |
tlsConfig | object | tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options. |
to | string | to defines the email address to send notifications to. This is the recipient address for alert notifications. |
.spec.receivers[].emailConfigs[].authPassword
- Description
- authPassword defines the secret’s key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- Type
-
`object`
- Required
-
keyname
| Property | Type | Description |
|---|---|---|
key | string | key defines the key of the secret to select from. Must be a valid secret key. |
name | string | name defines the name of the secret in the object’s namespace to select from. |
.spec.receivers[].emailConfigs[].authSecret
- Description
- authSecret defines the secret’s key that contains the CRAM-MD5 secret. This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- Type
-
`object`
- Required
-
keyname
| Property | Type | Description |
|---|---|---|
key | string | key defines the key of the secret to select from. Must be a valid secret key. |
name | string | name defines the name of the secret in the object’s namespace to select from. |
.spec.receivers[].emailConfigs[].headers
- Description
- headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
- Type
-
`array`
.spec.receivers[].emailConfigs[].headers[]
- Description
- KeyValue defines a (key, value) tuple.
- Type
-
`object`
- Required
-
keyvalue
| Property | Type | Description |
|---|---|---|
key | string | key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
value | string | value defines the value of the tuple. This is the data or content associated with the key. |
.spec.receivers[].emailConfigs[].tlsConfig
- Description
- tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
ca | object | ca defines the Certificate authority used when verifying server certificates. |
cert | object | cert defines the Client certificate to present when doing client-authentication. |
insecureSkipVerify | boolean | insecureSkipVerify defines how to disable target certificate validation. |
keySecret | object | keySecret defines the Secret containing the client key file for the targets. |
maxVersion | string | maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
minVersion | string | minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
serverName | string | serverName is used to verify the hostname for the targets. |
.spec.receivers[].emailConfigs[].tlsConfig.ca
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].emailConfigs[].tlsConfig.ca.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].emailConfigs[].tlsConfig.ca.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].emailConfigs[].tlsConfig.cert
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].emailConfigs[].tlsConfig.cert.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].emailConfigs[].tlsConfig.cert.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].emailConfigs[].tlsConfig.keySecret
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs
- Description
- msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0.
- Type
-
`array`
.spec.receivers[].msteamsConfigs[]
- Description
- MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0.
- Type
-
`object`
- Required
-
webhookUrl
| Property | Type | Description |
|---|---|---|
httpConfig | object | httpConfig defines the HTTP client configuration for Teams webhook requests. |
sendResolved | boolean | sendResolved defines whether or not to notify about resolved alerts. |
summary | string | summary defines the message summary template for Teams notifications. This provides a brief overview that appears in Teams notification previews. It requires Alertmanager >= 0.27.0. |
text | string | text defines the message body template for Teams notifications. This contains the detailed content of the Teams message. |
title | string | title defines the message title template for Teams notifications. This appears as the main heading of the Teams message card. |
webhookUrl | object | webhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel. |
.spec.receivers[].msteamsConfigs[].httpConfig
- Description
- httpConfig defines the HTTP client configuration for Teams webhook requests.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
authorization | object | authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
basicAuth | object | basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
bearerTokenSecret | object | bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
enableHttp2 | boolean | enableHttp2 can be used to disable HTTP2. |
followRedirects | boolean | followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
noProxy | string | noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
oauth2 | object | oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
proxyConnectHeader | object | proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader{} | array | |
proxyConnectHeader{}[] | object | SecretKeySelector selects a key of a Secret. |
proxyFromEnvironment | boolean | proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyURL | string | proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl. |
proxyUrl | string | proxyUrl defines the HTTP proxy server to use. |
tlsConfig | object | tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
.spec.receivers[].msteamsConfigs[].httpConfig.authorization
- Description
- authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
credentials | object | credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
type | string | type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
.spec.receivers[].msteamsConfigs[].httpConfig.authorization.credentials
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.basicAuth
- Description
- basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
password | object | password defines a key of a Secret containing the password for authentication. |
username | object | username defines a key of a Secret containing the username for authentication. |
.spec.receivers[].msteamsConfigs[].httpConfig.basicAuth.password
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.basicAuth.username
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.bearerTokenSecret
- Description
- bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- Type
-
`object`
- Required
-
keyname
| Property | Type | Description |
|---|---|---|
key | string | key defines the key of the secret to select from. Must be a valid secret key. |
name | string | name defines the name of the secret in the object’s namespace to select from. |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2
- Description
- oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
- Type
-
`object`
- Required
-
clientIdclientSecrettokenUrl
| Property | Type | Description |
|---|---|---|
clientId | object | clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
clientSecret | object | clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
endpointParams | object (string) | endpointParams configures the HTTP parameters to append to the token URL. |
noProxy | string | noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader | object | proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader{} | array | |
proxyConnectHeader{}[] | object | SecretKeySelector selects a key of a Secret. |
proxyFromEnvironment | boolean | proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyUrl | string | proxyUrl defines the HTTP proxy server to use. |
scopes | array (string) | scopes defines the OAuth2 scopes used for the token request. |
tlsConfig | object | tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
tokenUrl | string | tokenUrl defines the URL to fetch the token from. |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientId
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientId.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientId.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientSecret
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.proxyConnectHeader
- Description
- proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
`object`
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.proxyConnectHeader{}
Description
- Type
-
`array`
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
ca | object | ca defines the Certificate authority used when verifying server certificates. |
cert | object | cert defines the Client certificate to present when doing client-authentication. |
insecureSkipVerify | boolean | insecureSkipVerify defines how to disable target certificate validation. |
keySecret | object | keySecret defines the Secret containing the client key file for the targets. |
maxVersion | string | maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
minVersion | string | minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
serverName | string | serverName is used to verify the hostname for the targets. |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.ca
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.ca.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.cert
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.cert.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.keySecret
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.proxyConnectHeader
- Description
- proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
`object`
.spec.receivers[].msteamsConfigs[].httpConfig.proxyConnectHeader{}
Description
- Type
-
`array`
.spec.receivers[].msteamsConfigs[].httpConfig.proxyConnectHeader{}[]
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
ca | object | ca defines the Certificate authority used when verifying server certificates. |
cert | object | cert defines the Client certificate to present when doing client-authentication. |
insecureSkipVerify | boolean | insecureSkipVerify defines how to disable target certificate validation. |
keySecret | object | keySecret defines the Secret containing the client key file for the targets. |
maxVersion | string | maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
minVersion | string | minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
serverName | string | serverName is used to verify the hostname for the targets. |
.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.ca
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.ca.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.ca.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.cert
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.cert.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.cert.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.keySecret
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsConfigs[].webhookUrl
- Description
- webhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs
- Description
- msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0.
- Type
-
`array`
.spec.receivers[].msteamsv2Configs[]
- Description
- MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
httpConfig | object | httpConfig defines the HTTP client configuration for Teams webhook requests. |
sendResolved | boolean | sendResolved defines whether or not to notify about resolved alerts. |
text | string | text defines the message body template for adaptive card notifications. This contains the detailed content displayed in the Teams adaptive card format. |
title | string | title defines the message title template for adaptive card notifications. This appears as the main heading in the Teams adaptive card. |
webhookURL | object | webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows. |
.spec.receivers[].msteamsv2Configs[].httpConfig
- Description
- httpConfig defines the HTTP client configuration for Teams webhook requests.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
authorization | object | authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
basicAuth | object | basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
bearerTokenSecret | object | bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
enableHttp2 | boolean | enableHttp2 can be used to disable HTTP2. |
followRedirects | boolean | followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
noProxy | string | noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
oauth2 | object | oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
proxyConnectHeader | object | proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader{} | array | |
proxyConnectHeader{}[] | object | SecretKeySelector selects a key of a Secret. |
proxyFromEnvironment | boolean | proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyURL | string | proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl. |
proxyUrl | string | proxyUrl defines the HTTP proxy server to use. |
tlsConfig | object | tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
.spec.receivers[].msteamsv2Configs[].httpConfig.authorization
- Description
- authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
credentials | object | credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
type | string | type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
.spec.receivers[].msteamsv2Configs[].httpConfig.authorization.credentials
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.basicAuth
- Description
- basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
password | object | password defines a key of a Secret containing the password for authentication. |
username | object | username defines a key of a Secret containing the username for authentication. |
.spec.receivers[].msteamsv2Configs[].httpConfig.basicAuth.password
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.basicAuth.username
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.bearerTokenSecret
- Description
- bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- Type
-
`object`
- Required
-
keyname
| Property | Type | Description |
|---|---|---|
key | string | key defines the key of the secret to select from. Must be a valid secret key. |
name | string | name defines the name of the secret in the object’s namespace to select from. |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2
- Description
- oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
- Type
-
`object`
- Required
-
clientIdclientSecrettokenUrl
| Property | Type | Description |
|---|---|---|
clientId | object | clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
clientSecret | object | clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
endpointParams | object (string) | endpointParams configures the HTTP parameters to append to the token URL. |
noProxy | string | noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader | object | proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader{} | array | |
proxyConnectHeader{}[] | object | SecretKeySelector selects a key of a Secret. |
proxyFromEnvironment | boolean | proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyUrl | string | proxyUrl defines the HTTP proxy server to use. |
scopes | array (string) | scopes defines the OAuth2 scopes used for the token request. |
tlsConfig | object | tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
tokenUrl | string | tokenUrl defines the URL to fetch the token from. |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientId
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientId.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientId.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientSecret
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.proxyConnectHeader
- Description
- proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
`object`
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.proxyConnectHeader{}
Description
- Type
-
`array`
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.proxyConnectHeader{}[]
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
ca | object | ca defines the Certificate authority used when verifying server certificates. |
cert | object | cert defines the Client certificate to present when doing client-authentication. |
insecureSkipVerify | boolean | insecureSkipVerify defines how to disable target certificate validation. |
keySecret | object | keySecret defines the Secret containing the client key file for the targets. |
maxVersion | string | maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
minVersion | string | minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
serverName | string | serverName is used to verify the hostname for the targets. |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.ca
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.ca.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.ca.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.cert
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.cert.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.cert.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.keySecret
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.proxyConnectHeader
- Description
- proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
`object`
.spec.receivers[].msteamsv2Configs[].httpConfig.proxyConnectHeader{}
Description
- Type
-
`array`
.spec.receivers[].msteamsv2Configs[].httpConfig.proxyConnectHeader{}[]
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig
- Description
- tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
ca | object | ca defines the Certificate authority used when verifying server certificates. |
cert | object | cert defines the Client certificate to present when doing client-authentication. |
insecureSkipVerify | boolean | insecureSkipVerify defines how to disable target certificate validation. |
keySecret | object | keySecret defines the Secret containing the client key file for the targets. |
maxVersion | string | maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
minVersion | string | minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
serverName | string | serverName is used to verify the hostname for the targets. |
.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.ca
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.ca.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.ca.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.cert
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.cert.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.cert.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.keySecret
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].msteamsv2Configs[].webhookURL
- Description
- webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs
- Description
- opsgenieConfigs defines the list of OpsGenie configurations.
- Type
-
`array`
.spec.receivers[].opsgenieConfigs[]
- Description
- OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
actions | string | actions defines a comma separated list of actions that will be available for the alert. These appear as action buttons in the OpsGenie interface. |
apiKey | object | apiKey defines the secret’s key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
apiURL | string | apiURL defines the URL to send OpsGenie API requests to. When not specified, defaults to the standard OpsGenie API endpoint. |
description | string | description defines the detailed description of the incident. This provides additional context beyond the message field. |
details | array | details defines a set of arbitrary key/value pairs that provide further detail about the incident. These appear as additional fields in the OpsGenie alert. |
details[] | object | KeyValue defines a (key, value) tuple. |
entity | string | entity defines an optional field that can be used to specify which domain alert is related to. This helps group related alerts together in OpsGenie. |
httpConfig | object | httpConfig defines the HTTP client configuration for OpsGenie API requests. |
message | string | message defines the alert text limited to 130 characters. This appears as the main alert title in OpsGenie. |
note | string | note defines an additional alert note. This provides supplementary information about the alert. |
priority | string | priority defines the priority level of alert. Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority. |
responders | array | responders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created. |
responders[] | object | OpsGenieConfigResponder defines a responder to an incident. One of id, name or username has to be defined. |
sendResolved | boolean | sendResolved defines whether or not to notify about resolved alerts. |
source | string | source defines the backlink to the sender of the notification. This helps identify where the alert originated from. |
tags | string | tags defines a comma separated list of tags attached to the notifications. These help categorize and filter alerts within OpsGenie. |
.spec.receivers[].opsgenieConfigs[].apiKey
- Description
- apiKey defines the secret’s key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- Type
-
`object`
- Required
-
keyname
| Property | Type | Description |
|---|---|---|
key | string | key defines the key of the secret to select from. Must be a valid secret key. |
name | string | name defines the name of the secret in the object’s namespace to select from. |
.spec.receivers[].opsgenieConfigs[].details
- Description
- details defines a set of arbitrary key/value pairs that provide further detail about the incident. These appear as additional fields in the OpsGenie alert.
- Type
-
`array`
.spec.receivers[].opsgenieConfigs[].details[]
- Description
- KeyValue defines a (key, value) tuple.
- Type
-
`object`
- Required
-
keyvalue
| Property | Type | Description |
|---|---|---|
key | string | key defines the key of the tuple. This is the identifier or name part of the key-value pair. |
value | string | value defines the value of the tuple. This is the data or content associated with the key. |
.spec.receivers[].opsgenieConfigs[].httpConfig
- Description
- httpConfig defines the HTTP client configuration for OpsGenie API requests.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
authorization | object | authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
basicAuth | object | basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
bearerTokenSecret | object | bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
enableHttp2 | boolean | enableHttp2 can be used to disable HTTP2. |
followRedirects | boolean | followRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses. |
noProxy | string | noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
oauth2 | object | oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests. |
proxyConnectHeader | object | proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader{} | array | |
proxyConnectHeader{}[] | object | SecretKeySelector selects a key of a Secret. |
proxyFromEnvironment | boolean | proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyURL | string | proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl. |
proxyUrl | string | proxyUrl defines the HTTP proxy server to use. |
tlsConfig | object | tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options. |
.spec.receivers[].opsgenieConfigs[].httpConfig.authorization
- Description
- authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
credentials | object | credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
type | string | type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
.spec.receivers[].opsgenieConfigs[].httpConfig.authorization.credentials
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth
- Description
- basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
password | object | password defines a key of a Secret containing the password for authentication. |
username | object | username defines a key of a Secret containing the username for authentication. |
.spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.password
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.username
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.bearerTokenSecret
- Description
- bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
- Type
-
`object`
- Required
-
keyname
| Property | Type | Description |
|---|---|---|
key | string | key defines the key of the secret to select from. Must be a valid secret key. |
name | string | name defines the name of the secret in the object’s namespace to select from. |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2
- Description
- oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
- Type
-
`object`
- Required
-
clientIdclientSecrettokenUrl
| Property | Type | Description |
|---|---|---|
clientId | object | clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
clientSecret | object | clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
endpointParams | object (string) | endpointParams configures the HTTP parameters to append to the token URL. |
noProxy | string | noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader | object | proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyConnectHeader{} | array | |
proxyConnectHeader{}[] | object | SecretKeySelector selects a key of a Secret. |
proxyFromEnvironment | boolean | proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
proxyUrl | string | proxyUrl defines the HTTP proxy server to use. |
scopes | array (string) | scopes defines the OAuth2 scopes used for the token request. |
tlsConfig | object | tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
tokenUrl | string | tokenUrl defines the URL to fetch the token from. |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientSecret
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.proxyConnectHeader
- Description
- proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
`object`
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.proxyConnectHeader{}
Description
- Type
-
`array`
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
ca | object | ca defines the Certificate authority used when verifying server certificates. |
cert | object | cert defines the Client certificate to present when doing client-authentication. |
insecureSkipVerify | boolean | insecureSkipVerify defines how to disable target certificate validation. |
keySecret | object | keySecret defines the Secret containing the client key file for the targets. |
maxVersion | string | maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
minVersion | string | minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
serverName | string | serverName is used to verify the hostname for the targets. |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.ca
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.ca.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.cert
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
`object`
| Property | Type | Description |
|---|---|---|
configMap | object | configMap defines the ConfigMap containing data to use for the targets. |
secret | object | secret defines the Secret containing data to use for the targets. |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key to select. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the ConfigMap or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.cert.secret
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.keySecret
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
`object`
- Required
-
key
| Property | Type | Description |
|---|---|---|
key | string | The key of the secret to select from. Must be a valid secret key. |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optional | boolean | Specify whether the Secret or its key must be defined |
.spec.receivers[].opsgenieConfigs[].httpConfig.proxyConnectHeader
- Description
- proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
`object`
.spec.receivers[].opsgenieConfigs[].httpConfig.proxyConnectHeader{}
Description
- Type
-
`array`