AlertmanagerConfig defines a namespaced AlertmanagerConfig to be aggregated across multiple namespaces configuring one Alertmanager cluster.
AlertmanagerConfig defines a namespaced AlertmanagerConfig to be aggregated across multiple namespaces configuring one Alertmanager cluster.
object
spec
Property | Type | Description |
---|---|---|
|
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the |
AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the namespace
label is equal to the namespace of the AlertmanagerConfig resource.
object
Property | Type | Description |
---|---|---|
|
|
List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace. |
|
|
InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule |
|
|
List of receivers. |
|
|
Receiver defines one or more notification integrations. |
|
|
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. |
|
|
List of TimeInterval specifying when the routes should be muted or active. |
|
|
TimeInterval specifies the periods in time when notifications will be muted or active. |
List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.
array
InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule
object
Property | Type | Description |
---|---|---|
|
|
Labels that must have an equal value in the source and target alert for the inhibition to take effect. |
|
|
Matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace. |
|
|
Matcher defines how to match on alert’s labels. |
|
|
Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace. |
|
|
Matcher defines how to match on alert’s labels. |
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.
array
Matcher defines how to match on alert’s labels.
object
name
Property | Type | Description |
---|---|---|
|
|
Match operator, one of |
|
|
Label to match. |
|
|
Label value to match. |
Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace.
array
Matcher defines how to match on alert’s labels.
object
name
Property | Type | Description |
---|---|---|
|
|
Match operator, one of |
|
|
Label to match. |
|
|
Label value to match. |
Receiver defines one or more notification integrations.
object
name
Property | Type | Description |
---|---|---|
|
|
List of Email configurations. |
|
|
EmailConfig configures notifications via Email. |
|
|
Name of the receiver. Must be unique across all items from the list. |
|
|
List of OpsGenie configurations. |
|
|
OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config |
|
|
List of PagerDuty configurations. |
|
|
PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config |
|
|
List of Pushover configurations. |
|
|
PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config |
|
|
List of Slack configurations. |
|
|
SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config |
|
|
List of SNS configurations |
|
|
SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs |
|
|
List of Telegram configurations. |
|
|
TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config |
|
|
List of VictorOps configurations. |
|
|
VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config |
|
|
List of webhook configurations. |
|
|
WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config |
|
|
List of WeChat configurations. |
|
|
WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config |
EmailConfig configures notifications via Email.
object
Property | Type | Description |
---|---|---|
|
|
The identity to use for authentication. |
|
|
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. |
|
|
The secret’s key that contains the CRAM-MD5 secret. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
|
|
The username to use for authentication. |
|
|
The sender address. |
|
|
Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation. |
|
|
KeyValue defines a (key, value) tuple. |
|
|
The hostname to identify to the SMTP server. |
|
|
The HTML body of the email notification. |
|
|
The SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints. |
|
|
Whether or not to notify about resolved alerts. |
|
|
The SMTP host and port through which emails are sent. E.g. example.com:25 |
|
|
The text body of the email notification. |
|
|
TLS configuration |
|
|
The email address to send notifications to. |
The secret’s key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
name
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
The name of the secret in the object’s namespace to select from. |
The secret’s key that contains the CRAM-MD5 secret. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
name
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
The name of the secret in the object’s namespace to select from. |
Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.
array
KeyValue defines a (key, value) tuple.
object
key
value
Property | Type | Description |
---|---|---|
|
|
Key of the tuple. |
|
|
Value of the tuple. |
TLS configuration
object
Property | Type | Description |
---|---|---|
|
|
Struct containing the CA cert to use for the targets. |
|
|
Struct containing the client cert file for the targets. |
|
|
Disable target certificate validation. |
|
|
Secret containing the client key file for the targets. |
|
|
Used to verify the hostname for the targets. |
Struct containing the CA cert to use for the targets.
object
Property | Type | Description |
---|---|---|
|
|
ConfigMap containing data to use for the targets. |
|
|
Secret containing data to use for the targets. |
ConfigMap containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key to select. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the ConfigMap or its key must be defined |
Secret containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
Struct containing the client cert file for the targets.
object
Property | Type | Description |
---|---|---|
|
|
ConfigMap containing data to use for the targets. |
|
|
Secret containing data to use for the targets. |
ConfigMap containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key to select. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the ConfigMap or its key must be defined |
Secret containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
Secret containing the client key file for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
object
Property | Type | Description |
---|---|---|
|
|
Comma separated list of actions that will be available for the alert. |
|
|
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. |
|
|
The URL to send OpsGenie API requests to. |
|
|
Description of the incident. |
|
|
A set of arbitrary key/value pairs that provide further detail about the incident. |
|
|
KeyValue defines a (key, value) tuple. |
|
|
Optional field that can be used to specify which domain alert is related to. |
|
|
HTTP client configuration. |
|
|
Alert text limited to 130 characters. |
|
|
Additional alert note. |
|
|
Priority level of alert. Possible values are P1, P2, P3, P4, and P5. |
|
|
List of responders responsible for notifications. |
|
|
OpsGenieConfigResponder defines a responder to an incident. One of |
|
|
Whether or not to notify about resolved alerts. |
|
|
Backlink to the sender of the notification. |
|
|
Comma separated list of tags attached to the notifications. |
The secret’s key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
name
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
The name of the secret in the object’s namespace to select from. |
A set of arbitrary key/value pairs that provide further detail about the incident.
array
KeyValue defines a (key, value) tuple.
object
key
value
Property | Type | Description |
---|---|---|
|
|
Key of the tuple. |
|
|
Value of the tuple. |
HTTP client configuration.
object
Property | Type | Description |
---|---|---|
|
|
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
|
|
FollowRedirects specifies whether the client should follow HTTP 3xx redirects. |
|
|
OAuth2 client credentials used to fetch a token for the targets. |
|
|
Optional proxy URL. |
|
|
TLS configuration for the client. |
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
Property | Type | Description |
---|---|---|
|
|
The secret’s key that contains the credentials of the request |
|
|
Set the authentication type. Defaults to Bearer, Basic will cause an error |
The secret’s key that contains the credentials of the request
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
object
Property | Type | Description |
---|---|---|
|
|
The secret in the service monitor namespace that contains the password for authentication. |
|
|
The secret in the service monitor namespace that contains the username for authentication. |
The secret in the service monitor namespace that contains the password for authentication.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
The secret in the service monitor namespace that contains the username for authentication.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
object
key
name
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
The name of the secret in the object’s namespace to select from. |
OAuth2 client credentials used to fetch a token for the targets.
object
clientId
clientSecret
tokenUrl
Property | Type | Description |
---|---|---|
|
|
The secret or configmap containing the OAuth2 client id |
|
|
The secret containing the OAuth2 client secret |
|
|
Parameters to append to the token URL |
|
|
OAuth2 scopes used for the token request |
|
|
The URL to fetch the token from |
The secret or configmap containing the OAuth2 client id
object
Property | Type | Description |
---|---|---|
|
|
ConfigMap containing data to use for the targets. |
|
|
Secret containing data to use for the targets. |
ConfigMap containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key to select. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the ConfigMap or its key must be defined |
Secret containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
The secret containing the OAuth2 client secret
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
TLS configuration for the client.
object
Property | Type | Description |
---|---|---|
|
|
Struct containing the CA cert to use for the targets. |
|
|
Struct containing the client cert file for the targets. |
|
|
Disable target certificate validation. |
|
|
Secret containing the client key file for the targets. |
|
|
Used to verify the hostname for the targets. |
Struct containing the CA cert to use for the targets.
object
Property | Type | Description |
---|---|---|
|
|
ConfigMap containing data to use for the targets. |
|
|
Secret containing data to use for the targets. |
ConfigMap containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key to select. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the ConfigMap or its key must be defined |
Secret containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
Struct containing the client cert file for the targets.
object
Property | Type | Description |
---|---|---|
|
|
ConfigMap containing data to use for the targets. |
|
|
Secret containing data to use for the targets. |
ConfigMap containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key to select. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the ConfigMap or its key must be defined |
Secret containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
Secret containing the client key file for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
List of responders responsible for notifications.
array
OpsGenieConfigResponder defines a responder to an incident. One of id
, name
or username
has to be defined.
object
type
Property | Type | Description |
---|---|---|
|
|
ID of the responder. |
|
|
Name of the responder. |
|
|
Type of responder. |
|
|
Username of the responder. |
PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
object
Property | Type | Description |
---|---|---|
|
|
The class/type of the event. |
|
|
Client identification. |
|
|
Backlink to the sender of notification. |
|
|
The part or component of the affected system that is broken. |
|
|
Description of the incident. |
|
|
Arbitrary key/value pairs that provide further detail about the incident. |
|
|
KeyValue defines a (key, value) tuple. |
|
|
A cluster or grouping of sources. |
|
|
HTTP client configuration. |
|
|
A list of image details to attach that provide further detail about an incident. |
|
|
PagerDutyImageConfig attaches images to an incident |
|
|
A list of link details to attach that provide further detail about an incident. |
|
|
PagerDutyLinkConfig attaches text links to an incident |
|
|
The secret’s key that contains the PagerDuty integration key (when using Events API v2). Either this field or |
|
|
Whether or not to notify about resolved alerts. |
|
|
The secret’s key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or |
|
|
Severity of the incident. |
|
|
The URL to send requests to. |
Arbitrary key/value pairs that provide further detail about the incident.
array
KeyValue defines a (key, value) tuple.
object
key
value
Property | Type | Description |
---|---|---|
|
|
Key of the tuple. |
|
|
Value of the tuple. |
HTTP client configuration.
object
Property | Type | Description |
---|---|---|
|
|
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. |
|
|
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. |
|
|
The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |
|
|
FollowRedirects specifies whether the client should follow HTTP 3xx redirects. |
|
|
OAuth2 client credentials used to fetch a token for the targets. |
|
|
Optional proxy URL. |
|
|
TLS configuration for the client. |
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
object
Property | Type | Description |
---|---|---|
|
|
The secret’s key that contains the credentials of the request |
|