ClusterAlert
Scope: Cluster
Version: v1alpha1
Resource to display Prometheus alerts.
- objectmetadata
- stringmetadata.name
Alert identifier (fingerprint) as it calculated by Alertmanager.
Pattern:
^[a-z0-9]+$Maximum length:
64
- objectalert
Required value
Alert description.
- objectalert.annotations
Similar to the standard
metadata.annotationsfield.Example:
annotations: summary: Certificate has expired. - stringalert.description
Alert description.
Optional.
- objectalert.labels
Required value
Similar to the standard
metadata.labelsfield.Example:
labels: alertname: NginxIngressSslExpired class: ingress-nginx.deckhouse.io/nginx - stringalert.name
Required value
Alert name.
- integer or stringalert.severityLevel
Severity level.
Optional.
Example:
severityLevel: '4' - stringalert.summary
Alert summary.
Optional.
CustomAlertmanager
Scope: Cluster
Version: v1alpha1
The resource for connecting additional Alertmanagers to Prometheus.
- objectspec
Required value
- objectspec.external
Parameters for connecting an external Alertmanager.
- stringspec.external.address
URL of an external Alertmanager.
Pattern:
^https?://[^\s/$.?#].[^\s]*$Examples:
address: http://alerts.mycompany.comaddress: https://alerts.company.comaddress: http://192.168.1.1 - objectspec.external.auth
Authorization properties.
- objectspec.external.auth.basic
Basic authorization properties.
- stringspec.external.auth.basic.bearerToken
Bearer token authorization.
- stringspec.external.auth.basic.password
User password.
- stringspec.external.auth.basic.username
User name.
- objectspec.external.service
Kubernetes cluster service, which leads to deployed Alertmanager.
- stringspec.external.service.name
Required value
Name of an Alertmanager service.
- stringspec.external.service.namespace
Required value
Namespace of an Alertmanager service.
- stringspec.external.service.path
URL prefix in a service to send alerts for.
Default:
"/"
- objectspec.external.tls
TLS settings.
- stringspec.external.tls.ca
CA cert to use.
- stringspec.external.tls.cert
Client certificate.
- booleanspec.external.tls.insecureSkipVerify
Disable certificate validation.
Default:
false - stringspec.external.tls.key
Client key.
- objectspec.internal
Internal Alertmanager parameters.
- array of objectsspec.internal.inhibitRules
List of inhibition rules.
InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing (details…).
- array of stringsspec.internal.inhibitRules.equal
Labels that must have an equal value in the source and target alert for the inhibition to take effect.
- array of objectsspec.internal.inhibitRules.sourceMatch
Matchers for which one or more alerts have to exist for the inhibition to take effect.
Matcher defines how to match on alert’s labels.
- stringspec.internal.inhibitRules.sourceMatch.name
Required value
Label to match.
- booleanspec.internal.inhibitRules.sourceMatch.regex
Whether to match on equality (false) or regular-expression (true).
- stringspec.internal.inhibitRules.sourceMatch.value
Label value to match.
- array of objectsspec.internal.inhibitRules.targetMatch
Matchers that have to be fulfilled in the alerts to be muted.
Matcher defines how to match on alert’s labels.
- stringspec.internal.inhibitRules.targetMatch.name
Required value
Label to match.
- booleanspec.internal.inhibitRules.targetMatch.regex
Whether to match on equality (false) or regular-expression (true).
- stringspec.internal.inhibitRules.targetMatch.value
Label value to match.
- array of objectsspec.internal.receivers
List of receivers.
Receiver defines one or more notification integrations.
- array of objectsspec.internal.receivers.emailConfigs
List of Email configurations.
EmailConfig configures notifications via Email.
- stringspec.internal.receivers.emailConfigs.authIdentity
The identity to use for authentication.
- objectspec.internal.receivers.emailConfigs.authPassword
The secret’s key that contains the password to use for authentication.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.emailConfigs.authPassword.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.emailConfigs.authPassword.name
Name of the secret.
- booleanspec.internal.receivers.emailConfigs.authPassword.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.emailConfigs.authSecret
The secret’s key that contains the CRAM-MD5 secret.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.emailConfigs.authSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.emailConfigs.authSecret.name
Name of the secret.
- booleanspec.internal.receivers.emailConfigs.authSecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.emailConfigs.authUsername
The username to use for authentication.
- stringspec.internal.receivers.emailConfigs.from
The sender address.
- array of objectsspec.internal.receivers.emailConfigs.headers
Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.
KeyValue defines a (key, value) tuple.
- stringspec.internal.receivers.emailConfigs.headers.key
Required value
Key of the tuple.
- stringspec.internal.receivers.emailConfigs.headers.value
Required value
Value of the tuple.
- stringspec.internal.receivers.emailConfigs.hello
The hostname to identify to the SMTP server.
- stringspec.internal.receivers.emailConfigs.html
The HTML body of the email notification.
- booleanspec.internal.receivers.emailConfigs.requireTLS
The SMTP TLS requirement.
- booleanspec.internal.receivers.emailConfigs.sendResolved
Whether or not to notify about resolved alerts.
- stringspec.internal.receivers.emailConfigs.smarthost
The SMTP host through which emails are sent.
- stringspec.internal.receivers.emailConfigs.text
The text body of the email notification.
- objectspec.internal.receivers.emailConfigs.tlsConfig
TLS configuration.
- objectspec.internal.receivers.emailConfigs.tlsConfig.ca
Struct containing the CA cert to use for the targets.
- objectspec.internal.receivers.emailConfigs.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.emailConfigs.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.emailConfigs.tlsConfig.ca.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.emailConfigs.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.emailConfigs.tlsConfig.ca.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.emailConfigs.tlsConfig.ca.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.emailConfigs.tlsConfig.ca.secret.name
Name of the secret.
- booleanspec.internal.receivers.emailConfigs.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.emailConfigs.tlsConfig.cert
Struct containing the client cert file for the targets.
- objectspec.internal.receivers.emailConfigs.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.emailConfigs.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.emailConfigs.tlsConfig.cert.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.emailConfigs.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.emailConfigs.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.emailConfigs.tlsConfig.cert.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.emailConfigs.tlsConfig.cert.secret.name
Name of the secret.
- booleanspec.internal.receivers.emailConfigs.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.emailConfigs.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.internal.receivers.emailConfigs.tlsConfig.keySecret
Secret containing the client key file for the targets.
- stringspec.internal.receivers.emailConfigs.tlsConfig.keySecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.emailConfigs.tlsConfig.keySecret.name
Name of the secret.
- booleanspec.internal.receivers.emailConfigs.tlsConfig.keySecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.emailConfigs.tlsConfig.serverName
Used to verify the hostname for the targets.
- stringspec.internal.receivers.emailConfigs.to
The email address to send notifications to.
- stringspec.internal.receivers.name
Required value
Name of the receiver. Must be unique across all items from the list.
- array of objectsspec.internal.receivers.opsgenieConfigs
List of OpsGenie configurations.
OpsGenieConfig configures notifications via OpsGenie. Details…
- objectspec.internal.receivers.opsgenieConfigs.apiKey
The secret’s key that contains the OpsGenie API key.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.opsgenieConfigs.apiKey.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.opsgenieConfigs.apiKey.name
Name of the secret.
- booleanspec.internal.receivers.opsgenieConfigs.apiKey.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.opsgenieConfigs.apiURL
The URL to send OpsGenie API requests to.
- stringspec.internal.receivers.opsgenieConfigs.description
Description of the incident.
- array of objectsspec.internal.receivers.opsgenieConfigs.details
A set of arbitrary key/value pairs that provide further detail about the incident.
- stringspec.internal.receivers.opsgenieConfigs.details.key
Required value
Key of the tuple.
- stringspec.internal.receivers.opsgenieConfigs.details.value
Required value
Value of the tuple.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig
HTTP client configuration.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth
BasicAuth for the client.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.password
The secret in the
d8-monitoringnamespace that contains the password for authentication.- stringspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.password.name
Name of the secret.
- booleanspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.username
The secret in the
d8-monitoringnamespace that contains the username for authentication.- stringspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.username.name
Name of the secret.
- booleanspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret
The secret’s key that contains the bearer token to be used by the client for authentication.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.name
Name of the secret.
- booleanspec.internal.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.proxyURL
Optional proxy URL.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig
TLS configuration.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca
Struct containing the CA cert to use for the targets.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the secret.
- booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert
Struct containing the client cert file for the targets.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the secret.
- booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.name
Name of the secret.
- booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- stringspec.internal.receivers.opsgenieConfigs.message
Alert text limited to 130 characters.
- stringspec.internal.receivers.opsgenieConfigs.note
Additional alert note.
- stringspec.internal.receivers.opsgenieConfigs.priority
Priority level of alert. Possible values are P1, P2, P3, P4, and P5.
- array of objectsspec.internal.receivers.opsgenieConfigs.responders
List of responders responsible for notifications.
OpsGenieConfigResponder defines a responder to an incident. One of
id,nameorusernamehas to be defined.- stringspec.internal.receivers.opsgenieConfigs.responders.id
ID of the responder.
- stringspec.internal.receivers.opsgenieConfigs.responders.name
Name of the responder.
- stringspec.internal.receivers.opsgenieConfigs.responders.type
Required value
Type of responder.
- stringspec.internal.receivers.opsgenieConfigs.responders.username
Username of the responder.
- booleanspec.internal.receivers.opsgenieConfigs.sendResolved
Whether or not to notify about resolved alerts.
- stringspec.internal.receivers.opsgenieConfigs.source
Backlink to the sender of the notification.
- string
Comma separated list of tags attached to the notifications.
- array of objectsspec.internal.receivers.pagerdutyConfigs
List of PagerDuty configurations.
PagerDutyConfig configures notifications via PagerDuty. Details…
- stringspec.internal.receivers.pagerdutyConfigs.class
The class/type of the event.
- stringspec.internal.receivers.pagerdutyConfigs.client
Client identification.
- stringspec.internal.receivers.pagerdutyConfigs.clientURL
Backlink to the sender of notification.
- stringspec.internal.receivers.pagerdutyConfigs.component
The part or component of the affected system that is broken.
- stringspec.internal.receivers.pagerdutyConfigs.description
Description of the incident.
- array of objectsspec.internal.receivers.pagerdutyConfigs.details
Arbitrary key/value pairs that provide further detail about the incident.
- stringspec.internal.receivers.pagerdutyConfigs.details.key
Required value
Key of the tuple.
- stringspec.internal.receivers.pagerdutyConfigs.details.value
Required value
Value of the tuple.
- stringspec.internal.receivers.pagerdutyConfigs.group
A cluster or grouping of sources.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig
HTTP client configuration.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth
BasicAuth for the client.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.password
The secret in the
d8-monitoringnamespace that contains the password for authentication.- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.name
Name of the secret.
- booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.username
The secret in the
d8-monitoringnamespace that contains the username for authentication.- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.name
Name of the secret.
- booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret
The secret’s key that contains the bearer token to be used by the client for authentication.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.name
Name of the secret.
- booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.proxyURL
Optional proxy URL.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig
TLS configuration.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca
Struct containing the CA cert to use for the targets.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the secret.
- booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert
Struct containing the client cert file for the targets.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the secret.
- booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.name
Name of the secret.
- booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- objectspec.internal.receivers.pagerdutyConfigs.routingKey
The secret’s key that contains the PagerDuty integration key (when using Events API v2).
Either this field or
serviceKeyneeds to be defined.The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.pagerdutyConfigs.routingKey.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pagerdutyConfigs.routingKey.name
Name of the secret.
- booleanspec.internal.receivers.pagerdutyConfigs.routingKey.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.pagerdutyConfigs.sendResolved
Whether or not to notify about resolved alerts.
- objectspec.internal.receivers.pagerdutyConfigs.serviceKey
The secret’s key that contains the PagerDuty service key (when using integration type “Prometheus”).
Either this field or
routingKeyneeds to be defined.The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.pagerdutyConfigs.serviceKey.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pagerdutyConfigs.serviceKey.name
Name of the secret.
- booleanspec.internal.receivers.pagerdutyConfigs.serviceKey.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.pagerdutyConfigs.severity
Severity of the incident.
- stringspec.internal.receivers.pagerdutyConfigs.url
The URL to send requests to.
- array of objectsspec.internal.receivers.pushoverConfigs
List of Pushover configurations.
PushoverConfig configures notifications via Pushover. Details…
- stringspec.internal.receivers.pushoverConfigs.expire
How long your notification will continue to be retried for, unless the user acknowledges the notification.
- booleanspec.internal.receivers.pushoverConfigs.html
Whether notification message is HTML or plain text.
- objectspec.internal.receivers.pushoverConfigs.httpConfig
HTTP client configuration.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth
BasicAuth for the client.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.password
The secret in the
d8-monitoringnamespace that contains the password for authentication.- stringspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.password.name
Name of the secret.
- booleanspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.username
The secret in the
d8-monitoringnamespace that contains the username for authentication.- stringspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.username.name
Name of the secret.
- booleanspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.bearerTokenSecret
The secret’s key that contains the bearer token to be used by the client for authentication.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.name
Name of the secret.
- booleanspec.internal.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.proxyURL
Optional proxy URL.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig
TLS configuration.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca
Struct containing the CA cert to use for the targets.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the secret.
- booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert
Struct containing the client cert file for the targets.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the secret.
- booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.name
Name of the secret.
- booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- stringspec.internal.receivers.pushoverConfigs.message
Notification message.
- stringspec.internal.receivers.pushoverConfigs.retry
How often the Pushover servers will send the same notification to the user. Must be at least 30 seconds.
- booleanspec.internal.receivers.pushoverConfigs.sendResolved
Whether or not to notify about resolved alerts.
- stringspec.internal.receivers.pushoverConfigs.sound
The name of one of the sounds supported by device clients to override the user’s default sound choice.
- stringspec.internal.receivers.pushoverConfigs.title
Notification title.
- objectspec.internal.receivers.pushoverConfigs.token
The secret’s key that contains the registered application’s API token (details…).
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.pushoverConfigs.token.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pushoverConfigs.token.name
Name of the secret.
- booleanspec.internal.receivers.pushoverConfigs.token.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.pushoverConfigs.url
A supplementary URL shown alongside the message.
- stringspec.internal.receivers.pushoverConfigs.urlTitle
A title for supplementary URL, otherwise just the URL is shown.
- objectspec.internal.receivers.pushoverConfigs.userKey
The secret’s key that contains the recipient user’s user key.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.pushoverConfigs.userKey.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.pushoverConfigs.userKey.name
Name of the secret.
- booleanspec.internal.receivers.pushoverConfigs.userKey.optional
Specify whether the Secret or its key must exist.
- array of objectsspec.internal.receivers.slackConfigs
List of Slack configurations.
Configures notifications via Slack. Details…
- array of objectsspec.internal.receivers.slackConfigs.actions
- objectspec.internal.receivers.slackConfigs.actions.confirm
Protects users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. Details….
- stringspec.internal.receivers.slackConfigs.actions.confirm.dismissText
The text label for the button to cancel the action.
- stringspec.internal.receivers.slackConfigs.actions.confirm.okText
The text label for the button to continue with an action.
- stringspec.internal.receivers.slackConfigs.actions.confirm.text
Required value
Describe in detail the consequences of the action and contextualize your button text choices.
Use a maximum of 30 characters or so for best results across form factors.
- stringspec.internal.receivers.slackConfigs.actions.confirm.title
Brief title of the pop up window.
- stringspec.internal.receivers.slackConfigs.actions.name
- stringspec.internal.receivers.slackConfigs.actions.style
- stringspec.internal.receivers.slackConfigs.actions.text
Required value
- stringspec.internal.receivers.slackConfigs.actions.type
Required value
- stringspec.internal.receivers.slackConfigs.actions.url
- stringspec.internal.receivers.slackConfigs.actions.value
- objectspec.internal.receivers.slackConfigs.apiURL
The secret’s key that contains the Slack webhook URL.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.slackConfigs.apiURL.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.slackConfigs.apiURL.name
Name of the secret.
- booleanspec.internal.receivers.slackConfigs.apiURL.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.slackConfigs.callbackId
- stringspec.internal.receivers.slackConfigs.channel
The channel or user to send notifications to.
- stringspec.internal.receivers.slackConfigs.color
- stringspec.internal.receivers.slackConfigs.fallback
- array of objectsspec.internal.receivers.slackConfigs.fields
A list of Slack fields that are sent with each notification.
Configures a single Slack field that is sent with each notification.
Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. More information…
- booleanspec.internal.receivers.slackConfigs.fields.short
- stringspec.internal.receivers.slackConfigs.fields.title
Required value
- stringspec.internal.receivers.slackConfigs.fields.value
Required value
- string
- objectspec.internal.receivers.slackConfigs.httpConfig
HTTP client configuration.
- objectspec.internal.receivers.slackConfigs.httpConfig.basicAuth
BasicAuth for the client.
- objectspec.internal.receivers.slackConfigs.httpConfig.basicAuth.password
The secret in the
d8-monitoringnamespace that contains the password for authentication.- stringspec.internal.receivers.slackConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.slackConfigs.httpConfig.basicAuth.password.name
Name of the secret.
- booleanspec.internal.receivers.slackConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.slackConfigs.httpConfig.basicAuth.username
The secret in the
d8-monitoringnamespace that contains the username for authentication.- stringspec.internal.receivers.slackConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.slackConfigs.httpConfig.basicAuth.username.name
Name of the secret.
- booleanspec.internal.receivers.slackConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.slackConfigs.httpConfig.bearerTokenSecret
The secret’s key that contains the bearer token to be used by the client for authentication.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.slackConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.slackConfigs.httpConfig.bearerTokenSecret.name
Name of the secret.
- booleanspec.internal.receivers.slackConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.slackConfigs.httpConfig.proxyURL
Optional proxy URL.
- objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig
TLS configuration.
- objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca
Struct containing the CA cert to use for the targets.
- objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the secret.
- booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert
Struct containing the client cert file for the targets.
- objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the secret.
- booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.name
Name of the secret.
- booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- stringspec.internal.receivers.slackConfigs.iconEmoji
- stringspec.internal.receivers.slackConfigs.iconURL
- stringspec.internal.receivers.slackConfigs.imageURL
- booleanspec.internal.receivers.slackConfigs.linkNames
- array of stringsspec.internal.receivers.slackConfigs.mrkdwnIn
- stringspec.internal.receivers.slackConfigs.pretext
- booleanspec.internal.receivers.slackConfigs.sendResolved
Whether or not to notify about resolved alerts.
- booleanspec.internal.receivers.slackConfigs.shortFields
- stringspec.internal.receivers.slackConfigs.text
- stringspec.internal.receivers.slackConfigs.thumbURL
- stringspec.internal.receivers.slackConfigs.title
- stringspec.internal.receivers.slackConfigs.titleLink
- stringspec.internal.receivers.slackConfigs.username
- array of objectsspec.internal.receivers.telegramConfigs
List of Telegram configurations.
Configures notifications via Telegram.
Read more in the Prometheus documentation.
- stringspec.internal.receivers.telegramConfigs.apiURL
The Telegram API URL i.e.
https://api.telegram.org.If not specified, the default API URL will be used.
- objectspec.internal.receivers.telegramConfigs.botToken
The Secret in the
d8-monitoringnamespace that contains Telegram bot token.- stringspec.internal.receivers.telegramConfigs.botToken.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.telegramConfigs.botToken.name
Name of the secret.
- booleanspec.internal.receivers.telegramConfigs.botToken.optional
Specify whether the Secret or its key must exist.
- integerspec.internal.receivers.telegramConfigs.chatID
The Telegram chat ID.
- booleanspec.internal.receivers.telegramConfigs.disableNotifications
Disable telegram notifications
- objectspec.internal.receivers.telegramConfigs.httpConfig
HTTP client configuration.
- object
Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
- object
The Secret in the
d8-monitoringnamespace that contains the credentials of the request.- string
Required value
The key of the secret to select from.
- string
Name of the secret.
- boolean
Specify whether the Secret or its key must exist.
- string
Set the authentication type. Defaults to Bearer, Basic will cause an error
- objectspec.internal.receivers.telegramConfigs.httpConfig.basicAuth
BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
- objectspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.password
The Secret in the
d8-monitoringnamespace that contains the password for authentication.- stringspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.password.name
Name of the secret.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.username
The Secret in the
d8-monitoringnamespace that contains the username for authentication.- stringspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.username.name
Name of the secret.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.telegramConfigs.httpConfig.bearerTokenSecret
The Secret in the
d8-monitoringnamespace that contains the bearer token to be used by the client for authentication.- stringspec.internal.receivers.telegramConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.telegramConfigs.httpConfig.bearerTokenSecret.name
Name of the secret.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.followRedirects
FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
- objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2
OAuth2 client credentials used to fetch a token for the targets.
- objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId
Required value
The Secret or configMap containing the OAuth2 client id
- objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap
The ConfigMap in the
d8-monitoringnamespace that contains data to use for the targets.- stringspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret
The Secret in the
d8-monitoringnamespace that contains data to use for the targets.- stringspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.name
Name of the secret.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientSecret
Required value
The secret in the
d8-monitoringnamespace that contains OAuth2 client data.- stringspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.name
Name of the secret.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2.endpointParams
Parameters to append to the token URL
- array of stringsspec.internal.receivers.telegramConfigs.httpConfig.oauth2.scopes
OAuth2 scopes used for the token request
- stringspec.internal.receivers.telegramConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token from
- stringspec.internal.receivers.telegramConfigs.httpConfig.proxyURL
Optional proxy URL.
- objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig
TLS configuration for the client.
- objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca
Certificate authority used when verifying server certificates.
- objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap
The ConfigMap in the
d8-monitoringnamespace that contains data to use for the targets.- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret
The Secret in the
d8-monitoringnamespace that contains data to use for the targets.- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the secret.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert
Client certificate to present when doing client-authentication.
- objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap
The ConfigMap in the
d8-monitoringnamespace that contains data to use for the targets.- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret
The Secret in the
d8-monitoringnamespace that contains data to use for the targets.- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the secret.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret
The Secret in the
d8-monitoringnamespace that contains the client key file for the targets.- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.name
Name of the secret.
- booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- stringspec.internal.receivers.telegramConfigs.message
Message template
- stringspec.internal.receivers.telegramConfigs.parseMode
Parse mode for telegram message
Allowed values:
MarkdownV2,Markdown,HTML - booleanspec.internal.receivers.telegramConfigs.sendResolved
Whether to notify about resolved alerts.
- array of objectsspec.internal.receivers.victoropsConfigs
List of VictorOps configurations.
VictorOpsConfig configures notifications via VictorOps. Details…
- objectspec.internal.receivers.victoropsConfigs.apiKey
The secret’s key that contains the API key to use when talking to the VictorOps API.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.victoropsConfigs.apiKey.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.victoropsConfigs.apiKey.name
Name of the secret.
- booleanspec.internal.receivers.victoropsConfigs.apiKey.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.victoropsConfigs.apiUrl
The VictorOps API URL.
- array of objectsspec.internal.receivers.victoropsConfigs.customFields
Additional custom fields for notification.
KeyValue defines a (key, value) tuple.
- stringspec.internal.receivers.victoropsConfigs.customFields.key
Required value
Key of the tuple.
- stringspec.internal.receivers.victoropsConfigs.customFields.value
Required value
Value of the tuple.
- stringspec.internal.receivers.victoropsConfigs.entityDisplayName
Contains summary of the alerted problem.
- objectspec.internal.receivers.victoropsConfigs.httpConfig
The HTTP client’s configuration.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth
BasicAuth for the client.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.password
The secret in the
d8-monitoringnamespace that contains the password for authentication.- stringspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.password.name
Name of the secret.
- booleanspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.username
The secret in the
d8-monitoringnamespace that contains the username for authentication.- stringspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.username.name
Name of the secret.
- booleanspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.bearerTokenSecret
The secret’s key that contains the bearer token to be used by the client for authentication.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.name
Name of the secret.
- booleanspec.internal.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.proxyURL
Optional proxy URL.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig
TLS configuration.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca
Struct containing the CA cert to use for the targets.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the secret.
- booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert
Struct containing the client cert file for the targets.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the secret.
- booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.name
Name of the secret.
- booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- stringspec.internal.receivers.victoropsConfigs.messageType
Describes the behavior of the alert (CRITICAL, WARNING, INFO).
- stringspec.internal.receivers.victoropsConfigs.monitoringTool
The monitoring tool the state message is from.
- stringspec.internal.receivers.victoropsConfigs.routingKey
A key used to map the alert to a team.
- booleanspec.internal.receivers.victoropsConfigs.sendResolved
Whether or not to notify about resolved alerts.
- stringspec.internal.receivers.victoropsConfigs.stateMessage
Contains long explanation of the alerted problem.
- array of objectsspec.internal.receivers.webhookConfigs
List of webhook configurations.
WebhookConfig configures notifications via a generic receiver supporting the webhook payload. Details…
- objectspec.internal.receivers.webhookConfigs.httpConfig
HTTP client configuration.
- objectspec.internal.receivers.webhookConfigs.httpConfig.basicAuth
BasicAuth for the client.
- objectspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.password
The secret in the
d8-monitoringnamespace that contains the password for authentication.- stringspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.password.name
Name of the secret.
- booleanspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.username
The secret in the
d8-monitoringnamespace that contains the username for authentication.- stringspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.username.name
Name of the secret.
- booleanspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.webhookConfigs.httpConfig.bearerTokenSecret
The secret’s key that contains the bearer token to be used by the client for authentication.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.webhookConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.webhookConfigs.httpConfig.bearerTokenSecret.name
Name of the secret.
- booleanspec.internal.receivers.webhookConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.webhookConfigs.httpConfig.proxyURL
Optional proxy URL.
- objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig
TLS configuration.
- objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca
Struct containing the CA cert to use for the targets.
- objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the secret.
- booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert
Struct containing the client cert file for the targets.
- objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the secret.
- booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.name
Name of the secret.
- booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- integerspec.internal.receivers.webhookConfigs.maxAlerts
Maximum number of alerts to be sent per webhook message.
When 0, all alerts are included.
Allowed values:
0 <= X - booleanspec.internal.receivers.webhookConfigs.sendResolved
Whether or not to notify about resolved alerts.
- stringspec.internal.receivers.webhookConfigs.url
The URL to send HTTP POST requests to.
urlSecrettakes precedence overurl.One of
urlSecretandurlshould be defined. - objectspec.internal.receivers.webhookConfigs.urlSecret
The secret’s key that contains the webhook URL to send HTTP requests to.
urlSecrettakes precedence overurl. One ofurlSecretandurlshould be defined.The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.webhookConfigs.urlSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.webhookConfigs.urlSecret.name
Name of the secret.
- booleanspec.internal.receivers.webhookConfigs.urlSecret.optional
Specify whether the Secret or its key must exist.
- array of objectsspec.internal.receivers.wechatConfigs
List of WeChat configurations.
WeChatConfig configures notifications via WeChat. Details…
- stringspec.internal.receivers.wechatConfigs.agentID
- objectspec.internal.receivers.wechatConfigs.apiSecret
The secret’s key that contains the WeChat API key.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.wechatConfigs.apiSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.wechatConfigs.apiSecret.name
Name of the secret.
- booleanspec.internal.receivers.wechatConfigs.apiSecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.wechatConfigs.apiURL
The WeChat API URL.
- stringspec.internal.receivers.wechatConfigs.corpID
The corp id for authentication.
- objectspec.internal.receivers.wechatConfigs.httpConfig
HTTP client configuration.
- objectspec.internal.receivers.wechatConfigs.httpConfig.basicAuth
BasicAuth for the client.
- objectspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.password
The secret in the
d8-monitoringnamespace that contains the password for authentication.- stringspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.password.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.password.name
Name of the secret.
- booleanspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.password.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.username
The secret in the
d8-monitoringnamespace that contains the username for authentication.- stringspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.username.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.username.name
Name of the secret.
- booleanspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.username.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.wechatConfigs.httpConfig.bearerTokenSecret
The secret’s key that contains the bearer token to be used by the client for authentication.
The secret needs to be in the
d8-monitoringnamespace.- stringspec.internal.receivers.wechatConfigs.httpConfig.bearerTokenSecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.wechatConfigs.httpConfig.bearerTokenSecret.name
Name of the secret.
- booleanspec.internal.receivers.wechatConfigs.httpConfig.bearerTokenSecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.wechatConfigs.httpConfig.proxyURL
Optional proxy URL.
- objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig
TLS configuration.
- objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca
Struct containing the CA cert to use for the targets.
- objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.name
Name of the secret.
- booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.optional
Specify whether the Secret or its key must exist.
- objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert
Struct containing the client cert file for the targets.
- objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.key
Required value
The key to select.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.name
Name of the ConfigMap.
- booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.optional
Specify whether the ConfigMap or its key must exist.
- objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret
Secret containing data to use for the targets.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.name
Name of the secret.
- booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.optional
Specify whether the Secret or its key must exist.
- booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.insecureSkipVerify
Disable target certificate validation.
- objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret
Secret containing the client key file for the targets.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.key
Required value
The key of the secret to select from.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.name
Name of the secret.
- booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.optional
Specify whether the Secret or its key must exist.
- stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.serverName
Used to verify the hostname for the targets.
- stringspec.internal.receivers.wechatConfigs.message
API request data as defined by the WeChat API.
- stringspec.internal.receivers.wechatConfigs.messageType
- booleanspec.internal.receivers.wechatConfigs.sendResolved
Whether or not to notify about resolved alerts.
- stringspec.internal.receivers.wechatConfigs.toParty
- stringspec.internal.receivers.wechatConfigs.toTag
- stringspec.internal.receivers.wechatConfigs.toUser
- objectspec.internal.route
The Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route.
- booleanspec.internal.route.continue
Whether an alert should continue matching subsequent sibling nodes.
It will always be overridden to true for the first-level route by the Prometheus operator.
- array of stringsspec.internal.route.groupBy
List of labels to group by.
- stringspec.internal.route.groupInterval
How long to wait before sending an updated notification.
Must match the regular expression
[0-9]+(ms|s|m|h)(milliseconds, seconds, minutes, hours). - stringspec.internal.route.groupWait
How long to wait before sending the initial notification.
Must match the regular expression
[0-9]+(ms|s|m|h)(milliseconds, seconds, minutes, hours). - array of objectsspec.internal.route.matchers
List of matchers that the alert’s labels should match.
For the first level route, the operator removes any existing equality and regexp matcher on the
namespacelabel and adds anamespace: <object namespace>matcher.Matcher defines how to match on alert’s labels.
- stringspec.internal.route.matchers.name
Required value
Label to match.
- booleanspec.internal.route.matchers.regex
Whether to match on equality (false) or regular-expression (true).
- stringspec.internal.route.matchers.value
Label value to match.
- stringspec.internal.route.receiver
Name of the receiver for this route.
If not empty, it should be listed in the
receiversfield. - stringspec.internal.route.repeatInterval
How long to wait before repeating the last notification.
Must match the regular expression
[0-9]+(ms|s|m|h)(milliseconds, seconds, minutes, hours). - arrayspec.internal.route.routes
Child routes.
- stringspec.type
Type of the Alertmanager.
Allowed values:
External,Internal
CustomPrometheusRules
Scope: Cluster
Resource to store PrometheusRule. Details….
- objectspec
Required value
- array of objectsspec.groups
Required value
Alert group description.
The structure of the groups is similar to that of prometheus-operator.
RuleGroup is a list of sequentially evaluated recording and alerting rules.
- stringspec.groups.interval
- stringspec.groups.name
Required value
- array of objectsspec.groups.rules
Required value
- stringspec.groups.rules.alert
- objectspec.groups.rules.annotations
- integer or stringspec.groups.rules.expr
Required value
- stringspec.groups.rules.for
- objectspec.groups.rules.labels
- stringspec.groups.rules.record
Deprecated resource. Support for the resource might be removed in a later release.
Resource to store PrometheusRule. Details….
- objectspec
Required value
- array of objectsspec.groups
Required value
Alert group description.
The structure of the groups is similar to that of prometheus-operator.
RuleGroup is a list of sequentially evaluated recording and alerting rules.
- stringspec.groups.interval
- stringspec.groups.name
Required value
- array of objectsspec.groups.rules
Required value
- stringspec.groups.rules.alert
- objectspec.groups.rules.annotations
- integer or stringspec.groups.rules.expr
Required value
- stringspec.groups.rules.for
- objectspec.groups.rules.labels
- stringspec.groups.rules.record
GrafanaAdditionalDatasource
Scope: Cluster
The resource for connecting additional datasources to Grafana.
The resource parameters are described in details in the Grafana documentation.
- objectspec
Required value
- stringspec.access
Required value
Access mode.
Allowed values:
Proxy,Direct - booleanspec.basicAuth
Enable/disable basic auth.
- stringspec.basicAuthUser
Basic auth username.
- stringspec.database
Database name (if used).
- objectspec.jsonData
Fields to be converted to JSON and stored in jsonData.
- objectspec.secureJsonData
JSON-data object to be saved encrypted.
- stringspec.type
Required value
Datasource type.
- stringspec.url
Datasource URL.
Example:
url: http://localhost:8080 - stringspec.user
Database username.
Deprecated resource. Support for the resource might be removed in a later release.
The resource for connecting additional datasources to Grafana.
The resource parameters are described in details in the Grafana documentation.
- objectspec
Required value
- stringspec.access
Required value
Access mode.
Allowed values:
proxy,direct - booleanspec.basicAuth
Enable/disable basic auth.
- stringspec.basicAuthUser
Basic auth username.
- stringspec.database
Database name (if used).
- objectspec.jsonData
Fields to be converted to JSON and stored in jsonData.
- objectspec.secureJsonData
JSON-data object to be saved encrypted.
- stringspec.type
Required value
Datasource type.
- stringspec.url
Datasource URL.
Example:
url: http://localhost:8080 - stringspec.user
Database username.
GrafanaAlertsChannel
Scope: Cluster
Version: v1alpha1
The resource for adding alert notification channels to Grafana.
- objectspec
Required value
- objectspec.alertManager
Required value
Alert manager settings.
- stringspec.alertManager.address
Required value
URL of an external Alertmanager.
Pattern:
^https?://[^\s/$.?#].[^\s]*$Examples:
address: http://alerts.mycompany.comaddress: https://alerts.company.comaddress: http://192.168.1.1 - objectspec.alertManager.auth
Authorization properties.
- objectspec.alertManager.auth.basic
Required value
Basic authorization properties.
- stringspec.alertManager.auth.basic.password
Required value
Password.
- stringspec.alertManager.auth.basic.username
Required value
User name.
- stringspec.description
Small and optional description about this alerts channel.
Default:
"" - booleanspec.disableResolveMessage
When true, this option disables the resolve message [OK] that is sent when the alerting state returns to false.
Default:
false - booleanspec.isDefault
Use this notification channel for all alerts.
Default:
false - stringspec.type
Required value
Allowed values:
PrometheusAlertManager
GrafanaDashboardDefinition
Scope: Cluster
The resource for storing and managing Grafana dashboards.
- objectspec
Required value
- stringspec.definition
Required value
The dashboard’s JSON manifest.
Caution! Make sure that there is no “local”
id(at the.idaddress) in the manifest in addition to theuid.Pattern:
^[ \t\n]*\{(.|\n)*\}[ \t\n]*$ - stringspec.folder
Required value
What folder to use for a dashboard. If the folder does not exist, it will be created.
Example:
folder: My Folder
Deprecated resource. Support for the resource might be removed in a later release.
The resource for storing and managing Grafana dashboards.
- objectspec
Required value
- stringspec.definition
Required value
The dashboard’s JSON manifest.
Caution! Make sure that there is no “local”
id(at the.idaddress) in the manifest in addition to theuid.Pattern:
^[ \t\n]*\{(.|\n)*\}[ \t\n]*$ - stringspec.folder
Required value
What folder to use for a dashboard. If the folder does not exist, it will be created.
Example:
folder: My Folder
PrometheusRemoteWrite
Scope: Cluster
Resource for including ‘remote_write’ data from the local Prometheus into a separate longterm storage (E.g: VictoriaMetrics).
A cluster can have any number of such resources.
- objectspec
Required value
- objectspec.basicAuth
BasicAuth for the URL.
- stringspec.basicAuth.password
Required value
Password for the authentication.
- stringspec.basicAuth.username
Required value
Username for the authentication.
- stringspec.bearerToken
Bearer token.
- stringspec.customAuthToken
Custom token sent as a value of the X-Auth-Token header.
- objectspec.headers
HTTP headers to include in the request.
- stringspec.headers.X-Scope-OrgID
Required value
The
X-Scope-OrgIDheader specifying the tenant ID.
- objectspec.tlsConfig
TLS Config to use for remote write.
- stringspec.tlsConfig.ca
The CA certificate used when verifying the API server certificate.
Default:
"" - booleanspec.tlsConfig.insecureSkipVerify
Disable target certificate validation.
Default:
false
- stringspec.url
Required value
The URL of the endpoint to send samples to.
Example:
url: https://victoriametrics-test.domain.com/api/v1/write - array of objectsspec.writeRelabelConfigs
The list of remote write relabel configurations.
For example, if you need to remove unnecessary metrics or perform data relabeling.
- stringspec.writeRelabelConfigs.action
Action to perform based on regex matching.
Default:
"replace" - integerspec.writeRelabelConfigs.modulus
Modulus to take of the hash of the source label values.
- stringspec.writeRelabelConfigs.regex
Regular expression against which the extracted value is matched. Default is ‘(.*)’
Default:
"(.*)" - stringspec.writeRelabelConfigs.replacement
Replacement value against which a regex replace is performed if the regular expression matches.
Regex capture groups are available.
Default:
"$1" - stringspec.writeRelabelConfigs.separator
Separator placed between concatenated source label values.
Default:
";" - array of stringsspec.writeRelabelConfigs.sourceLabels
The source labels select values from existing labels.
Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
- stringspec.writeRelabelConfigs.targetLabel
Label to which the resulting value is written in a replace action. It is mandatory for replace actions.
Regex capture groups are available.
Deprecated resource. Support for the resource might be removed in a later release.
Resource for including ‘remote_write’ data from the local Prometheus into a separate longterm storage (E.g: VictoriaMetrics).
A cluster can have any number of such resources.
- objectspec
Required value
- objectspec.basicAuth
BasicAuth for the URL.
- stringspec.basicAuth.password
Required value
Password for the authentication.
- stringspec.basicAuth.username
Required value
Username for the authentication.
- stringspec.bearerToken
Bearer token.
- stringspec.customAuthToken
Custom token sent as a value of the X-Auth-Token header.
- objectspec.headers
HTTP headers to include in the request.
- stringspec.headers.X-Scope-OrgID
Required value
The
X-Scope-OrgIDheader specifying the tenant ID.
- objectspec.tlsConfig
TLS Config to use for remote write.
- stringspec.tlsConfig.ca
The CA certificate used when verifying the API server certificate.
Default:
"" - booleanspec.tlsConfig.insecureSkipVerify
Disable target certificate validation.
Default:
false
- stringspec.url
Required value
The URL of the endpoint to send samples to.
Example:
url: https://victoriametrics-test.domain.com/api/v1/write - array of objectsspec.writeRelabelConfigs
The list of remote write relabel configurations.
For example, if you need to remove unnecessary metrics or perform data relabeling.
- stringspec.writeRelabelConfigs.action
Action to perform based on regex matching.
Default:
"replace" - integerspec.writeRelabelConfigs.modulus
Modulus to take of the hash of the source label values.
- stringspec.writeRelabelConfigs.regex
Regular expression against which the extracted value is matched. Default is ‘(.*)’
Default:
"(.*)" - stringspec.writeRelabelConfigs.replacement
Replacement value against which a regex replace is performed if the regular expression matches.
Regex capture groups are available.
Default:
"$1" - stringspec.writeRelabelConfigs.separator
Separator placed between concatenated source label values.
Default:
";" - array of stringsspec.writeRelabelConfigs.sourceLabels
The source labels select values from existing labels.
Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
- stringspec.writeRelabelConfigs.targetLabel
Label to which the resulting value is written in a replace action. It is mandatory for replace actions.
Regex capture groups are available.