VMAlertmanagerConfig v1beta1 — operator.victoriametrics.com

discord_configs []object

avatar_url string

AvatarURL defines message avatar URL Available from operator v0.55.0 and alertmanager v0.28.0

content string

Content defines message content template Available from operator v0.55.0 and alertmanager v0.28.0

maxLength: 2000

http_config object

HTTP client configuration.

authorization object

Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.

credentials object

Reference to the secret with value for authorization

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

credentialsFile string

File with value for authorization

type string

Type of authorization, default to bearer

basic_auth object

BasicAuth for the client.

password object

Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

password_file string

PasswordFile defines path to password file at disk must be pre-mounted

username object

Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

bearer_token_file string

BearerTokenFile defines filename for bearer token, it must be mounted to pod.

bearer_token_secret object

The secret's key that contains the bearer token It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

follow_redirects boolean

FollowRedirects controls redirects for scraping.

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.

oauth2 object

OAuth2 client credentials used to fetch a token for the targets.

client_id object required

The secret or configmap containing the OAuth2 client id

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret object

The secret containing the OAuth2 client secret

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret_file string

ClientSecretFile defines path for client secret file.

endpoint_params object

Parameters to append to the token URL

proxy_url string

The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

scopes []string

OAuth2 scopes used for the token request

tls_config object

TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

token_url string required

The URL to fetch the token from

minLength: 1

proxyConnectHeader object

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.

proxyFromEnvironment boolean

ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

proxyURL string

ProxyUrl defines the HTTP proxy server to use.

pattern: ^(http|https|socks5)://.+$

tls_config object

TLS configuration for the client.

ca object

Struct containing the CA cert to use for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

caFile string

Path to the CA cert in the container to use for the targets.

cert object

Struct containing the client cert file for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

certFile string

Path to the client cert file in the container for the targets.

insecureSkipVerify boolean

Disable target certificate validation.

keyFile string

Path to the client key file in the container for the targets.

keySecret object

Secret containing the client key file for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

serverName string

Used to verify the hostname for the targets.

message string

The message body template

send_resolved boolean

SendResolved controls notify about resolved alerts.

title string

The message title template

username string

Username defines message username Available from operator v0.55.0 and alertmanager v0.28.0

webhook_url string

The discord webhook URL one of `urlSecret` and `url` must be defined.

webhook_url_secret object

URLSecret defines secret name and key at the CRD namespace. It must contain the webhook URL. one of `urlSecret` and `url` must be defined.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

email_configs []object

EmailConfigs defines email notification configurations.

auth_identity string

The identity to use for authentication.

auth_password object

AuthPassword defines secret name and key at CRD namespace.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

auth_secret object

AuthSecret defines secret name and key at CRD namespace. It must contain the CRAM-MD5 secret.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

auth_username string

The username to use for authentication.

from string

The sender address. fallback to global setting if empty

headers object

Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.

hello string

The hostname to identify to the SMTP server.

html string

The HTML body of the email notification.

require_tls boolean

The SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.

send_resolved boolean

SendResolved controls notify about resolved alerts.

smarthost string

The SMTP host through which emails are sent. fallback to global setting if empty

text string

The text body of the email notification.

tls_config object

TLS configuration

ca object

Struct containing the CA cert to use for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

caFile string

Path to the CA cert in the container to use for the targets.

cert object

Struct containing the client cert file for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

certFile string

Path to the client cert file in the container for the targets.

insecureSkipVerify boolean

Disable target certificate validation.

keyFile string

Path to the client key file in the container for the targets.

keySecret object

Secret containing the client key file for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

serverName string

Used to verify the hostname for the targets.

to string

The email address to send notifications to.

incidentio_configs []object

alert_source_token object

AlertSourceToken is used to authenticate with incident.io

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

http_config object

max_alerts integer

MaxAlerts defines maximum number of alerts to be sent per incident.io message.

send_resolved boolean

SendResolved controls notify about resolved alerts.

timeout string

Timeout is the maximum time allowed to invoke incident.io

url string

The URL to send the incident.io alert. This would typically be provided by the incident.io team when setting up an alert source.

jira_configs []object

api_url string

The URL to send API requests to. The full API path must be included. Example: https://company.atlassian.net/rest/api/2/

custom_fields object

Other issue and custom fields. Jira issue field can have multiple types. Depends on the field type, the values must be provided differently. See https://developer.atlassian.com/server/jira/platform/jira-rest-api-examples/#setting-custom-field-data-for-other-field-types for further examples.

description string

Issue description template.

http_config object

The HTTP client's configuration. You must use this configuration to supply the personal access token (PAT) as part of the HTTP `Authorization` header. For Jira Cloud, use basic_auth with the email address as the username and the PAT as the password. For Jira Data Center, use the 'authorization' field with 'credentials: <PAT value>'.

issue_type string required

Type of the issue (e.g. Bug)

labels []string

Labels to be added to the issue

priority string

Priority of the issue

project string required

The project key where issues are created

reopen_duration string

If reopen_transition is defined, reopen the issue when it is not older than this value (rounded down to the nearest minute). The resolutiondate field is used to determine the age of the issue.

pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

reopen_transition string

Name of the workflow transition to resolve an issue. The target status must have the category "done".

resolve_transition string

Name of the workflow transition to reopen an issue. The target status should not have the category "done".

send_resolved boolean

SendResolved controls notify about resolved alerts.

summary string

Issue summary template

wont_fix_resolution string

If reopen_transition is defined, ignore issues with that resolution.

mattermost_configs []object

MattermostConfigs defines Mattermost notification configurations.

attachments []object

Attachments defines richer formatting options

author_icon string

author_link string

author_name string

color string

fallback string

fields []object

short boolean

title string

value string

footer string

footer_icon string

image_url string

pretext string

text string

thumb_url string

title string

title_link string

channel string

Channel overrides the channel the message posts in.

http_config object

icon_emoji string

IconEmoji overrides the profile picture and icon_url parameter.

icon_url string

IconURL overrides the profile picture the message posts with.

priority object

persistent_notifications boolean

priority string

requested_ack boolean

props object

card string

send_resolved boolean

SendResolved controls notify about resolved alerts.

text string required

Text defines markdown-formatted message to display in the post.

url string

URL to send requests to, one of `urlSecret` and `url` must be defined.

url_secret object

URLSecret defines secret name and key at the CRD namespace. It must contain the Mattermost URL. one of `urlSecret` and `url` must be defined.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

username string

Username overrides the username the message posts as

msteams_configs []object

http_config object

HTTP client configuration.

authorization object

Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.

credentials object

Reference to the secret with value for authorization

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

credentialsFile string

File with value for authorization

type string

Type of authorization, default to bearer

basic_auth object

BasicAuth for the client.

password object

Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

password_file string

PasswordFile defines path to password file at disk must be pre-mounted

username object

Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

bearer_token_file string

BearerTokenFile defines filename for bearer token, it must be mounted to pod.

bearer_token_secret object

The secret's key that contains the bearer token It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

follow_redirects boolean

FollowRedirects controls redirects for scraping.

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.

oauth2 object

OAuth2 client credentials used to fetch a token for the targets.

client_id object required

The secret or configmap containing the OAuth2 client id

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret object

The secret containing the OAuth2 client secret

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret_file string

ClientSecretFile defines path for client secret file.

endpoint_params object

Parameters to append to the token URL

proxy_url string

The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

scopes []string

OAuth2 scopes used for the token request

tls_config object

TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

token_url string required

The URL to fetch the token from

minLength: 1

proxyConnectHeader object

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.

proxyFromEnvironment boolean

ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

proxyURL string

ProxyUrl defines the HTTP proxy server to use.

pattern: ^(http|https|socks5)://.+$

tls_config object

TLS configuration for the client.

ca object

Struct containing the CA cert to use for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

caFile string

Path to the CA cert in the container to use for the targets.

cert object

Struct containing the client cert file for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

certFile string

Path to the client cert file in the container for the targets.

insecureSkipVerify boolean

Disable target certificate validation.

keyFile string

Path to the client key file in the container for the targets.

keySecret object

Secret containing the client key file for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

serverName string

Used to verify the hostname for the targets.

send_resolved boolean

SendResolved controls notify about resolved alerts.

text string

The text body of the teams notification.

title string

The title of the teams notification.

webhook_url string

The incoming webhook URL one of `urlSecret` and `url` must be defined.

webhook_url_secret object

URLSecret defines secret name and key at the CRD namespace. It must contain the webhook URL. one of `urlSecret` and `url` must be defined.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

msteamsv2_configs []object

http_config object

send_resolved boolean

SendResolved controls notify about resolved alerts.

text string

Message body template.

title string

Message title template.

webhook_url string

The incoming webhook URL one of `urlSecret` and `url` must be defined.

webhook_url_secret object

URLSecret defines secret name and key at the CRD namespace. It must contain the webhook URL. one of `webhook_url` or `webhook_url_secret` must be defined.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

opsgenie_configs []object

OpsGenieConfigs defines ops genie notification configurations.

actions string

Comma separated list of actions that will be available for the alert.

apiURL string

The URL to send OpsGenie API requests to.

api_key object

The secret's key that contains the OpsGenie API key. It must be at them same namespace as CRD fallback to global setting if empty

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

description string

Description of the incident.

details object

A set of arbitrary key/value pairs that provide further detail about the incident.

entity string

Optional field that can be used to specify which domain alert is related to.

http_config object

HTTP client configuration.

message string

Alert text limited to 130 characters.

note string

Additional alert note.

priority string

Priority level of alert. Possible values are P1, P2, P3, P4, and P5.

responders []object

List of responders responsible for notifications.

id string

ID of the responder.

name string

Name of the responder.

type string required

Type of responder.

minLength: 1

username string

Username of the responder.

send_resolved boolean

SendResolved controls notify about resolved alerts.

source string

Backlink to the sender of the notification.

tags string

Comma separated list of tags attached to the notifications.

update_alerts boolean

Whether to update message and description of the alert in OpsGenie if it already exists By default, the alert is never updated in OpsGenie, the new message only appears in activity log.

pagerduty_configs []object

PagerDutyConfigs defines pager duty notification configurations.

class string

The class/type of the event.

client string

Client identification.

client_url string

Backlink to the sender of notification.

component string

The part or component of the affected system that is broken.

description string

Description of the incident.

details object

Arbitrary key/value pairs that provide further detail about the incident.

group string

A cluster or grouping of sources.

http_config object

HTTP client configuration.

images []object

Images to attach to the incident.

alt string

href string

source string required

links []object

Links to attach to the incident.

href string required

text string

routing_key object

The secret's key that contains the PagerDuty integration key (when using Events API v2). Either this field or `serviceKey` needs to be defined. It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

send_resolved boolean

SendResolved controls notify about resolved alerts.

service_key object

The secret's key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or `routingKey` needs to be defined. It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

severity string

Severity of the incident.

url string

The URL to send requests to.

pushover_configs []object

PushoverConfigs defines push over notification configurations.

expire string

How long your notification will continue to be retried for, unless the user acknowledges the notification.

html boolean

Whether notification message is HTML or plain text.

http_config object

HTTP client configuration.

message string

Notification message.

priority string

Priority, see https://pushover.net/api#priority

retry string

How often the Pushover servers will send the same notification to the user. Must be at least 30 seconds.

send_resolved boolean

SendResolved controls notify about resolved alerts.

sound string

The name of one of the sounds supported by device clients to override the user's default sound choice

title string

Notification title.

token object

The secret's key that contains the registered application’s API token, see https://pushover.net/apps. It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

url string

A supplementary URL shown alongside the message.

url_title string

A title for supplementary URL, otherwise just the URL is shown

user_key object

The secret's key that contains the recipient user’s user key. It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

rocketchat_configs []object

actions []object

msg string

text string

type string

url string

api_url string

channel string

RocketChat channel override, (like #other-channel or @username).

color string

emoji string

fields []object

short boolean

title string

value string

http_config object

icon_url string

image_url string

link_names boolean

send_resolved boolean

SendResolved controls notify about resolved alerts.

short_fields boolean

text string

thumb_url string

title string

title_link string

token object

SecretKeySelector selects a key of a Secret.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

token_id object

The sender token and token_id See https://docs.rocket.chat/use-rocket.chat/user-guides/user-panel/my-account#personal-access-tokens

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

slack_configs []object

SlackConfigs defines slack notification configurations.

actions []object

A list of Slack actions that are sent with each notification.

confirm object

SlackConfirmationField protect users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields for more information.

dismiss_text string

ok_text string

text string required

minLength: 1

title string

name string

style string

text string required

minLength: 1

type string required

minLength: 1

url string

value string

api_url object

The secret's key that contains the Slack webhook URL. It must be at them same namespace as CRD fallback to global setting if empty

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

callback_id string

channel string

The channel or user to send notifications to.

color string

fallback string

fields []object

A list of Slack fields that are sent with each notification.

short boolean

title string required

minLength: 1

value string required

minLength: 1

footer string

http_config object

HTTP client configuration.

icon_emoji string

icon_url string

image_url string

link_names boolean

mrkdwn_in []string

pretext string

send_resolved boolean

SendResolved controls notify about resolved alerts.

short_fields boolean

text string

thumb_url string

title string

title_link string

update_message boolean

Whether to update the original message in-place instead of sending a new one. Requires Slack Bot API and chat:write scope. Available since alertmanager v0.32.0.

username string

sns_configs []object

api_url string

The api URL

attributes object

SNS message attributes

http_config object

HTTP client configuration.

authorization object

Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.

credentials object

Reference to the secret with value for authorization

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

credentialsFile string

File with value for authorization

type string

Type of authorization, default to bearer

basic_auth object

BasicAuth for the client.

password object

Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

password_file string

PasswordFile defines path to password file at disk must be pre-mounted

username object

Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

bearer_token_file string

BearerTokenFile defines filename for bearer token, it must be mounted to pod.

bearer_token_secret object

The secret's key that contains the bearer token It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

follow_redirects boolean

FollowRedirects controls redirects for scraping.

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.

oauth2 object

OAuth2 client credentials used to fetch a token for the targets.

client_id object required

The secret or configmap containing the OAuth2 client id

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret object

The secret containing the OAuth2 client secret

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret_file string

ClientSecretFile defines path for client secret file.

endpoint_params object

Parameters to append to the token URL

proxy_url string

The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

scopes []string

OAuth2 scopes used for the token request

tls_config object

TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

token_url string required

The URL to fetch the token from

minLength: 1

proxyConnectHeader object

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.

proxyFromEnvironment boolean

ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

proxyURL string

ProxyUrl defines the HTTP proxy server to use.

pattern: ^(http|https|socks5)://.+$

tls_config object

TLS configuration for the client.

ca object

Struct containing the CA cert to use for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

caFile string

Path to the CA cert in the container to use for the targets.

cert object

Struct containing the client cert file for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

certFile string

Path to the client cert file in the container for the targets.

insecureSkipVerify boolean

Disable target certificate validation.

keyFile string

Path to the client key file in the container for the targets.

keySecret object

Secret containing the client key file for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

serverName string

Used to verify the hostname for the targets.

message string

The message content of the SNS notification.

phone_number string

Phone number if message is delivered via SMS Specify this, topic_arn or target_arn

send_resolved boolean

SendResolved controls notify about resolved alerts.

sigv4 object

Configure the AWS Signature Verification 4 signing process

access_key string

The AWS API keys. Both access_key and secret_key must be supplied or both must be blank. If blank the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are used.

access_key_selector object

secret key selector to get the keys from a Kubernetes Secret

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

profile string

Named AWS profile used to authenticate

region string

AWS region, if blank the region from the default credentials chain is used

role_arn string

AWS Role ARN, an alternative to using AWS API keys

secret_key_selector object

secret key selector to get the keys from a Kubernetes Secret

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

subject string

The subject line if message is delivered to an email endpoint.

target_arn string

Mobile platform endpoint ARN if message is delivered via mobile notifications Specify this, topic_arn or phone_number

topic_arn string

SNS topic ARN, either specify this, phone_number or target_arn

telegram_configs []object

api_url string

APIUrl the Telegram API URL i.e. https://api.telegram.org.

bot_token object required

BotToken token for the bot https://core.telegram.org/bots/api

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

chat_id integer required

ChatID is ID of the chat where to send the messages.

disable_notifications boolean

DisableNotifications

http_config object

HTTP client configuration.

message string

Message is templated message

message_thread_id integer

MessageThreadID defines ID of the message thread where to send the messages.

parse_mode string

ParseMode for telegram message, supported values are MarkdownV2, Markdown, Markdown and empty string for plain text.

send_resolved boolean

SendResolved controls notify about resolved alerts.

victorops_configs []object

VictorOpsConfigs defines victor ops notification configurations.

api_key object

The secret's key that contains the API key to use when talking to the VictorOps API. It must be at them same namespace as CRD fallback to global setting if empty

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

api_url string

The VictorOps API URL.

custom_fields object

Adds optional custom fields https://github.com/prometheus/alertmanager/blob/v0.24.0/config/notifiers.go#L537

entity_display_name string

Contains summary of the alerted problem.

http_config object

The HTTP client's configuration.

authorization object

Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.

credentials object

Reference to the secret with value for authorization

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

credentialsFile string

File with value for authorization

type string

Type of authorization, default to bearer

basic_auth object

BasicAuth for the client.

password object

Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

password_file string

PasswordFile defines path to password file at disk must be pre-mounted

username object

Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

bearer_token_file string

BearerTokenFile defines filename for bearer token, it must be mounted to pod.

bearer_token_secret object

The secret's key that contains the bearer token It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

follow_redirects boolean

FollowRedirects controls redirects for scraping.

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.

oauth2 object

OAuth2 client credentials used to fetch a token for the targets.

client_id object required

The secret or configmap containing the OAuth2 client id

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret object

The secret containing the OAuth2 client secret

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret_file string

ClientSecretFile defines path for client secret file.

endpoint_params object

Parameters to append to the token URL

proxy_url string

The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

scopes []string

OAuth2 scopes used for the token request

tls_config object

TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

token_url string required

The URL to fetch the token from

minLength: 1

proxyConnectHeader object

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.

proxyFromEnvironment boolean

ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

proxyURL string

ProxyUrl defines the HTTP proxy server to use.

pattern: ^(http|https|socks5)://.+$

tls_config object

TLS configuration for the client.

ca object

Struct containing the CA cert to use for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

caFile string

Path to the CA cert in the container to use for the targets.

cert object

Struct containing the client cert file for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

certFile string

Path to the client cert file in the container for the targets.

insecureSkipVerify boolean

Disable target certificate validation.

keyFile string

Path to the client key file in the container for the targets.

keySecret object

Secret containing the client key file for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

serverName string

Used to verify the hostname for the targets.

message_type string

Describes the behavior of the alert (CRITICAL, WARNING, INFO).

monitoring_tool string

The monitoring tool the state message is from.

routing_key string required

A key used to map the alert to a team.

send_resolved boolean

SendResolved controls notify about resolved alerts.

state_message string

Contains long explanation of the alerted problem.

webex_configs []object

api_url string

The Webex Teams API URL, i.e. https://webexapis.com/v1/messages

http_config object

HTTP client configuration. You must use this configuration to supply the bot token as part of the HTTP `Authorization` header.

authorization object

Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.

credentials object

Reference to the secret with value for authorization

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

credentialsFile string

File with value for authorization

type string

Type of authorization, default to bearer

basic_auth object

BasicAuth for the client.

password object

Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

password_file string

PasswordFile defines path to password file at disk must be pre-mounted

username object

Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

bearer_token_file string

BearerTokenFile defines filename for bearer token, it must be mounted to pod.

bearer_token_secret object

The secret's key that contains the bearer token It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

follow_redirects boolean

FollowRedirects controls redirects for scraping.

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.

oauth2 object

OAuth2 client credentials used to fetch a token for the targets.

client_id object required

The secret or configmap containing the OAuth2 client id

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret object

The secret containing the OAuth2 client secret

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret_file string

ClientSecretFile defines path for client secret file.

endpoint_params object

Parameters to append to the token URL

proxy_url string

The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

scopes []string

OAuth2 scopes used for the token request

tls_config object

TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

token_url string required

The URL to fetch the token from

minLength: 1

proxyConnectHeader object

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.

proxyFromEnvironment boolean

ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

proxyURL string

ProxyUrl defines the HTTP proxy server to use.

pattern: ^(http|https|socks5)://.+$

tls_config object

TLS configuration for the client.

ca object

Struct containing the CA cert to use for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

caFile string

Path to the CA cert in the container to use for the targets.

cert object

Struct containing the client cert file for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

certFile string

Path to the client cert file in the container for the targets.

insecureSkipVerify boolean

Disable target certificate validation.

keyFile string

Path to the client key file in the container for the targets.

keySecret object

Secret containing the client key file for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

serverName string

Used to verify the hostname for the targets.

message string

The message body template

room_id string required

The ID of the Webex Teams room where to send the messages

send_resolved boolean

SendResolved controls notify about resolved alerts.

webhook_configs []object

WebhookConfigs defines webhook notification configurations.

http_config object

HTTP client configuration.

max_alerts integer

Maximum number of alerts to be sent per webhook message. When 0, all alerts are included.

format: int32

minimum: 0

send_resolved boolean

SendResolved controls notify about resolved alerts.

timeout string

Timeout is the maximum time allowed to invoke the webhook available since v0.28.0 alertmanager version

pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

url string

URL to send requests to, one of `urlSecret` and `url` must be defined.

url_secret object

URLSecret defines secret name and key at the CRD namespace. It must contain the webhook URL. one of `urlSecret` and `url` must be defined.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

wechat_configs []object

WechatConfigs defines wechat notification configurations.

agent_id string

api_secret object

The secret's key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig fallback to global alertmanager setting if empty

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

api_url string

The WeChat API URL. fallback to global alertmanager setting if empty

corp_id string

The corp id for authentication. fallback to global alertmanager setting if empty

http_config object

HTTP client configuration.

authorization object

Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.

credentials object

Reference to the secret with value for authorization

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

credentialsFile string

File with value for authorization

type string

Type of authorization, default to bearer

basic_auth object

BasicAuth for the client.

password object

Password defines reference for secret with password value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

password_file string

PasswordFile defines path to password file at disk must be pre-mounted

username object

Username defines reference for secret with username value The secret needs to be in the same namespace as scrape object

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

bearer_token_file string

BearerTokenFile defines filename for bearer token, it must be mounted to pod.

bearer_token_secret object

The secret's key that contains the bearer token It must be at them same namespace as CRD

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

follow_redirects boolean

FollowRedirects controls redirects for scraping.

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.

oauth2 object

OAuth2 client credentials used to fetch a token for the targets.

client_id object required

The secret or configmap containing the OAuth2 client id

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret object

The secret containing the OAuth2 client secret

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

client_secret_file string

ClientSecretFile defines path for client secret file.

endpoint_params object

Parameters to append to the token URL

proxy_url string

The proxy URL for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

scopes []string

OAuth2 scopes used for the token request

tls_config object

TLSConfig for token_url connection ( available from v0.55.0). Is only supported by Scrape objects family

token_url string required

The URL to fetch the token from

minLength: 1

proxyConnectHeader object

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.

proxyFromEnvironment boolean

ProxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

proxyURL string

ProxyUrl defines the HTTP proxy server to use.

pattern: ^(http|https|socks5)://.+$

tls_config object

TLS configuration for the client.

ca object

Struct containing the CA cert to use for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

caFile string

Path to the CA cert in the container to use for the targets.

cert object

Struct containing the client cert file for the targets.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

certFile string

Path to the client cert file in the container for the targets.

insecureSkipVerify boolean

Disable target certificate validation.

keyFile string

Path to the client key file in the container for the targets.

keySecret object

Secret containing the client key file for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional boolean

Specify whether the Secret or its key must be defined

serverName string

Used to verify the hostname for the targets.

message string

API request data as defined by the WeChat API.

message_type string

send_resolved boolean

SendResolved controls notify about resolved alerts.

to_party string

to_tag string

to_user string