The module lifecycle stage: General Availability
The module has requirements for installation
The Deckhouse Kubernetes Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.
ClusterAlert
Scope: Cluster
Version: v1alpha1
-
objectalertAlert description.
-
objectalert.annotationsSimilar to the standard
metadata.annotationsfield.Example:
summary: Certificate has expired. -
stringalert.description
Alert description.
Optional.
-
objectalert.labels
Required value
Similar to the standardmetadata.labelsfield.Example:
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.
-
-
objectmetadata
-
stringmetadata.nameAlert identifier (fingerprint) as it calculated by Alertmanager.
Maximum length:
64Pattern:
^[a-z0-9]+$
-
-
objectstatus
-
stringstatus.alertStatusCurrent alert status.
-
stringstatus.lastUpdateTimeTimestamp of last status update for operation.
-
stringstatus.startsAtTimestamp of alert creation.
-
CustomAlertmanager
Scope: Cluster
Version: v1alpha1
-
objectspec
-
objectspec.externalParameters for connecting an external Alertmanager.
-
stringspec.external.addressURL 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.authAuthorization properties.
-
objectspec.external.auth.basicBasic authorization properties.
-
stringspec.external.auth.basic.bearerTokenBearer token authorization.
-
stringspec.external.auth.basic.passwordUser password.
-
stringspec.external.auth.basic.usernameUser name.
-
-
-
objectspec.external.serviceKubernetes 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.pathURL prefix in a service to send alerts for.
Default:
/
-
-
objectspec.external.tlsTLS settings.
-
stringspec.external.tls.caCA cert to use.
-
stringspec.external.tls.certClient certificate.
-
booleanspec.external.tls.insecureSkipVerifyDisable certificate validation.
Default:
false -
stringspec.external.tls.keyClient key.
-
-
-
objectspec.internalInternal Alertmanager parameters.
-
array of objectsspec.internal.inhibitRulesList of inhibition rules.
-
array of stringsspec.internal.inhibitRules.equalLabels that must have an equal value in the source and target alert for the inhibition to take effect.
-
array of objectsspec.internal.inhibitRules.sourceMatchMatchers for which one or more alerts have to exist for the inhibition to take effect.
-
stringspec.internal.inhibitRules.sourceMatch.nameLabel to match.
Minimal length:
1 -
booleanspec.internal.inhibitRules.sourceMatch.regexWhether to match on equality (false) or regular-expression (true).
-
stringspec.internal.inhibitRules.sourceMatch.valueLabel value to match.
-
-
array of objectsspec.internal.inhibitRules.targetMatchMatchers that have to be fulfilled in the alerts to be muted.
-
stringspec.internal.inhibitRules.targetMatch.nameLabel to match.
Minimal length:
1 -
booleanspec.internal.inhibitRules.targetMatch.regexWhether to match on equality (false) or regular-expression (true).
-
stringspec.internal.inhibitRules.targetMatch.valueLabel value to match.
-
-
-
array of objectsspec.internal.receiversList of receivers.
-
array of objectsspec.internal.receivers.emailConfigsList of Email configurations.
-
stringspec.internal.receivers.emailConfigs.authIdentityThe 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.nameName of the secret.
-
booleanspec.internal.receivers.emailConfigs.authPassword.optionalSpecify 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.nameName of the secret.
-
booleanspec.internal.receivers.emailConfigs.authSecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.emailConfigs.authUsernameThe username to use for authentication.
-
stringspec.internal.receivers.emailConfigs.fromThe sender address.
-
array of objectsspec.internal.receivers.emailConfigs.headersFurther headers email header key/value pairs. Overrides any headers previously set by the notification implementation.
-
stringspec.internal.receivers.emailConfigs.headers.keyKey of the tuple.
Minimal length:
1 -
stringspec.internal.receivers.emailConfigs.headers.valueValue of the tuple.
-
-
stringspec.internal.receivers.emailConfigs.helloThe hostname to identify to the SMTP server.
-
stringspec.internal.receivers.emailConfigs.htmlThe HTML body of the email notification.
-
booleanspec.internal.receivers.emailConfigs.requireTLSThe SMTP TLS requirement.
-
booleanspec.internal.receivers.emailConfigs.sendResolvedWhether or not to notify about resolved alerts.
-
stringspec.internal.receivers.emailConfigs.smarthostThe SMTP host through which emails are sent.
-
stringspec.internal.receivers.emailConfigs.textThe text body of the email notification.
-
objectspec.internal.receivers.emailConfigs.tlsConfigTLS configuration.
-
objectspec.internal.receivers.emailConfigs.tlsConfig.caStruct containing the CA cert to use for the targets.
-
objectspec.internal.receivers.emailConfigs.tlsConfig.ca.configMapConfigMap 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.emailConfigs.tlsConfig.ca.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.emailConfigs.tlsConfig.ca.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.emailConfigs.tlsConfig.ca.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.emailConfigs.tlsConfig.certStruct containing the client cert file for the targets.
-
objectspec.internal.receivers.emailConfigs.tlsConfig.cert.configMapConfigMap containing data to use for the targets.
-
objectspec.internal.receivers.emailConfigs.tlsConfig.cert.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.emailConfigs.tlsConfig.cert.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
booleanspec.internal.receivers.emailConfigs.tlsConfig.insecureSkipVerifyDisable target certificate validation.
-
objectspec.internal.receivers.emailConfigs.tlsConfig.keySecretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.emailConfigs.tlsConfig.keySecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.emailConfigs.tlsConfig.serverNameUsed to verify the hostname for the targets.
-
-
stringspec.internal.receivers.emailConfigs.toThe email address to send notifications to.
-
-
stringspec.internal.receivers.nameName of the receiver. Must be unique across all items from the list.
Minimal length:
1 -
array of objectsspec.internal.receivers.opsgenieConfigsList of OpsGenie configurations.
-
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.nameName of the secret.
-
booleanspec.internal.receivers.opsgenieConfigs.apiKey.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.opsgenieConfigs.apiURLThe URL to send OpsGenie API requests to.
-
stringspec.internal.receivers.opsgenieConfigs.descriptionDescription of the incident.
-
array of objectsspec.internal.receivers.opsgenieConfigs.detailsA set of arbitrary key/value pairs that provide further detail about the incident.
-
stringspec.internal.receivers.opsgenieConfigs.details.keyKey of the tuple.
Minimal length:
1 -
stringspec.internal.receivers.opsgenieConfigs.details.valueValue of the tuple.
-
-
objectspec.internal.receivers.opsgenieConfigs.httpConfigHTTP client configuration.
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuthBasicAuth for the client.
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.passwordThe 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.nameName of the secret.
-
booleanspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.password.optionalSpecify whether the Secret or its key must exist.
-
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.usernameThe 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.nameName of the secret.
-
booleanspec.internal.receivers.opsgenieConfigs.httpConfig.basicAuth.username.optionalSpecify 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.nameName of the secret.
-
booleanspec.internal.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.opsgenieConfigs.httpConfig.proxyURLOptional proxy URL.
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfigTLS configuration.
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.caStruct containing the CA cert to use for the targets.
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMapConfigMap 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.certStruct containing the client cert file for the targets.
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMapConfigMap containing data to use for the targets.
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.insecureSkipVerifyDisable target certificate validation.
-
objectspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.opsgenieConfigs.httpConfig.tlsConfig.serverNameUsed to verify the hostname for the targets.
-
-
-
stringspec.internal.receivers.opsgenieConfigs.messageAlert text limited to 130 characters.
-
stringspec.internal.receivers.opsgenieConfigs.noteAdditional alert note.
-
stringspec.internal.receivers.opsgenieConfigs.priorityPriority level of alert. Possible values are P1, P2, P3, P4, and P5.
-
array of objectsspec.internal.receivers.opsgenieConfigs.respondersList of responders responsible for notifications.
-
stringspec.internal.receivers.opsgenieConfigs.responders.idID of the responder.
-
stringspec.internal.receivers.opsgenieConfigs.responders.nameName of the responder.
-
stringspec.internal.receivers.opsgenieConfigs.responders.typeType of responder.
Minimal length:
1 -
stringspec.internal.receivers.opsgenieConfigs.responders.usernameUsername of the responder.
-
-
booleanspec.internal.receivers.opsgenieConfigs.sendResolvedWhether or not to notify about resolved alerts.
-
stringspec.internal.receivers.opsgenieConfigs.sourceBacklink to the sender of the notification.
-
stringspec.internal.receivers.opsgenieConfigs.tagsComma separated list of tags attached to the notifications.
-
-
array of objectsspec.internal.receivers.pagerdutyConfigsList of PagerDuty configurations.
-
stringspec.internal.receivers.pagerdutyConfigs.classThe class/type of the event.
-
stringspec.internal.receivers.pagerdutyConfigs.clientClient identification.
-
stringspec.internal.receivers.pagerdutyConfigs.clientURLBacklink to the sender of notification.
-
stringspec.internal.receivers.pagerdutyConfigs.componentThe part or component of the affected system that is broken.
-
stringspec.internal.receivers.pagerdutyConfigs.descriptionDescription of the incident.
-
array of objectsspec.internal.receivers.pagerdutyConfigs.detailsArbitrary key/value pairs that provide further detail about the incident.
-
stringspec.internal.receivers.pagerdutyConfigs.details.keyKey of the tuple.
Minimal length:
1 -
stringspec.internal.receivers.pagerdutyConfigs.details.valueValue of the tuple.
-
-
stringspec.internal.receivers.pagerdutyConfigs.groupA cluster or grouping of sources.
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfigHTTP client configuration.
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuthBasicAuth for the client.
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.passwordThe 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.nameName of the secret.
-
booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.optionalSpecify whether the Secret or its key must exist.
-
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.usernameThe 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.nameName of the secret.
-
booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.optionalSpecify 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.nameName of the secret.
-
booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.pagerdutyConfigs.httpConfig.proxyURLOptional proxy URL.
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfigTLS configuration.
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.caStruct containing the CA cert to use for the targets.
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMapConfigMap 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.certStruct containing the client cert file for the targets.
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMapConfigMap containing data to use for the targets.
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.insecureSkipVerifyDisable target certificate validation.
-
objectspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.pagerdutyConfigs.httpConfig.tlsConfig.serverNameUsed 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.nameName of the secret.
-
booleanspec.internal.receivers.pagerdutyConfigs.routingKey.optionalSpecify whether the Secret or its key must exist.
-
-
booleanspec.internal.receivers.pagerdutyConfigs.sendResolvedWhether 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.nameName of the secret.
-
booleanspec.internal.receivers.pagerdutyConfigs.serviceKey.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.pagerdutyConfigs.severitySeverity of the incident.
-
stringspec.internal.receivers.pagerdutyConfigs.urlThe URL to send requests to.
-
-
array of objectsspec.internal.receivers.pushoverConfigsList of Pushover configurations.
-
stringspec.internal.receivers.pushoverConfigs.expireHow long your notification will continue to be retried for, unless the user acknowledges the notification.
-
booleanspec.internal.receivers.pushoverConfigs.htmlWhether notification message is HTML or plain text.
-
objectspec.internal.receivers.pushoverConfigs.httpConfigHTTP client configuration.
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.basicAuthBasicAuth for the client.
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.passwordThe 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.nameName of the secret.
-
booleanspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.password.optionalSpecify whether the Secret or its key must exist.
-
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.usernameThe 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.nameName of the secret.
-
booleanspec.internal.receivers.pushoverConfigs.httpConfig.basicAuth.username.optionalSpecify 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.nameName of the secret.
-
booleanspec.internal.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.pushoverConfigs.httpConfig.proxyURLOptional proxy URL.
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfigTLS configuration.
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.caStruct containing the CA cert to use for the targets.
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMapConfigMap 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.certStruct containing the client cert file for the targets.
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMapConfigMap containing data to use for the targets.
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.insecureSkipVerifyDisable target certificate validation.
-
objectspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.pushoverConfigs.httpConfig.tlsConfig.serverNameUsed to verify the hostname for the targets.
-
-
-
stringspec.internal.receivers.pushoverConfigs.messageNotification message.
-
stringspec.internal.receivers.pushoverConfigs.retryHow often the Pushover servers will send the same notification to the user. Must be at least 30 seconds.
-
booleanspec.internal.receivers.pushoverConfigs.sendResolvedWhether or not to notify about resolved alerts.
-
stringspec.internal.receivers.pushoverConfigs.soundThe name of one of the sounds supported by device clients to override the user’s default sound choice.
-
stringspec.internal.receivers.pushoverConfigs.titleNotification 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.nameName of the secret.
-
booleanspec.internal.receivers.pushoverConfigs.token.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.pushoverConfigs.urlA supplementary URL shown alongside the message.
-
stringspec.internal.receivers.pushoverConfigs.urlTitleA 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.nameName of the secret.
-
booleanspec.internal.receivers.pushoverConfigs.userKey.optionalSpecify whether the Secret or its key must exist.
-
-
-
array of objectsspec.internal.receivers.slackConfigsList of Slack configurations.
-
array of objectsspec.internal.receivers.slackConfigs.actionsA list of Slack actions that are sent with each notification.
-
objectspec.internal.receivers.slackConfigs.actions.confirmProtects 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.dismissTextThe text label for the button to cancel the action.
-
stringspec.internal.receivers.slackConfigs.actions.confirm.okTextThe 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.
Minimal length:
1 -
stringspec.internal.receivers.slackConfigs.actions.confirm.titleBrief title of the pop up window.
-
-
stringspec.internal.receivers.slackConfigs.actions.name
-
stringspec.internal.receivers.slackConfigs.actions.style
-
stringspec.internal.receivers.slackConfigs.actions.text
Minimal length:
1 -
stringspec.internal.receivers.slackConfigs.actions.type
Minimal length:
1 -
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.nameName of the secret.
-
booleanspec.internal.receivers.slackConfigs.apiURL.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.slackConfigs.callbackId
-
stringspec.internal.receivers.slackConfigs.channelThe channel or user to send notifications to.
-
stringspec.internal.receivers.slackConfigs.color
-
stringspec.internal.receivers.slackConfigs.fallback
-
array of objectsspec.internal.receivers.slackConfigs.fieldsA list of Slack fields that are sent with each notification.
-
booleanspec.internal.receivers.slackConfigs.fields.short
-
stringspec.internal.receivers.slackConfigs.fields.title
Minimal length:
1 -
stringspec.internal.receivers.slackConfigs.fields.value
Minimal length:
1
-
-
string
-
objectspec.internal.receivers.slackConfigs.httpConfigHTTP client configuration.
-
objectspec.internal.receivers.slackConfigs.httpConfig.basicAuthBasicAuth for the client.
-
objectspec.internal.receivers.slackConfigs.httpConfig.basicAuth.passwordThe 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.nameName of the secret.
-
booleanspec.internal.receivers.slackConfigs.httpConfig.basicAuth.password.optionalSpecify whether the Secret or its key must exist.
-
-
objectspec.internal.receivers.slackConfigs.httpConfig.basicAuth.usernameThe 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.nameName of the secret.
-
booleanspec.internal.receivers.slackConfigs.httpConfig.basicAuth.username.optionalSpecify 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.nameName of the secret.
-
booleanspec.internal.receivers.slackConfigs.httpConfig.bearerTokenSecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.slackConfigs.httpConfig.proxyURLOptional proxy URL.
-
objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfigTLS configuration.
-
objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.caStruct containing the CA cert to use for the targets.
-
objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMapConfigMap 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.certStruct containing the client cert file for the targets.
-
objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMapConfigMap containing data to use for the targets.
-
objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.insecureSkipVerifyDisable target certificate validation.
-
objectspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.keySecretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.slackConfigs.httpConfig.tlsConfig.serverNameUsed 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.sendResolvedWhether 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.telegramConfigsList of Telegram configurations.
-
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.botTokenThe 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.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.botToken.optionalSpecify whether the Secret or its key must exist.
-
-
integerspec.internal.receivers.telegramConfigs.chatIDThe Telegram chat ID.
-
booleanspec.internal.receivers.telegramConfigs.disableNotificationsDisable telegram notifications
-
objectspec.internal.receivers.telegramConfigs.httpConfigHTTP client configuration.
-
objectspec.internal.receivers.telegramConfigs.httpConfig.authorizationAuthorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
-
objectspec.internal.receivers.telegramConfigs.httpConfig.authorization.credentialsThe Secret in the
d8-monitoringnamespace that contains the credentials of the request.-
stringspec.internal.receivers.telegramConfigs.httpConfig.authorization.credentials.key
Required value
The key of the secret to select from. -
stringspec.internal.receivers.telegramConfigs.httpConfig.authorization.credentials.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.authorization.credentials.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.telegramConfigs.httpConfig.authorization.typeSet the authentication type. Defaults to Bearer, Basic will cause an error
-
-
objectspec.internal.receivers.telegramConfigs.httpConfig.basicAuthBasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
-
objectspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.passwordThe 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.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.password.optionalSpecify whether the Secret or its key must exist.
-
-
objectspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.usernameThe 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.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.basicAuth.username.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.telegramConfigs.httpConfig.bearerTokenSecretThe 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.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.bearerTokenSecret.optionalSpecify whether the Secret or its key must exist.
-
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.followRedirectsFollowRedirects specifies whether the client should follow HTTP 3xx redirects.
-
objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2OAuth2 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.configMapThe 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.secretThe 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.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientSecret
Required value
The secret in thed8-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.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.optionalSpecify whether the Secret or its key must exist.
-
-
objectspec.internal.receivers.telegramConfigs.httpConfig.oauth2.endpointParamsParameters to append to the token URL
-
array of stringsspec.internal.receivers.telegramConfigs.httpConfig.oauth2.scopesOAuth2 scopes used for the token request
-
stringspec.internal.receivers.telegramConfigs.httpConfig.oauth2.tokenUrl
Required value
The URL to fetch the token fromMinimal length:
1
-
-
stringspec.internal.receivers.telegramConfigs.httpConfig.proxyURLOptional proxy URL.
-
objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfigTLS configuration for the client.
-
objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.caCertificate authority used when verifying server certificates.
-
objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMapThe 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secretThe 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.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.certClient certificate to present when doing client-authentication.
-
objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMapThe 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secretThe 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.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.insecureSkipVerifyDisable target certificate validation.
-
objectspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.keySecretThe 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.nameName of the secret.
-
booleanspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.telegramConfigs.httpConfig.tlsConfig.serverNameUsed to verify the hostname for the targets.
-
-
-
stringspec.internal.receivers.telegramConfigs.messageMessage template
-
stringspec.internal.receivers.telegramConfigs.parseModeParse mode for telegram message
Allowed values:
MarkdownV2,Markdown,HTML -
booleanspec.internal.receivers.telegramConfigs.sendResolvedWhether to notify about resolved alerts.
-
-
array of objectsspec.internal.receivers.victoropsConfigsList of VictorOps configurations.
-
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.nameName of the secret.
-
booleanspec.internal.receivers.victoropsConfigs.apiKey.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.victoropsConfigs.apiUrlThe VictorOps API URL.
-
array of objectsspec.internal.receivers.victoropsConfigs.customFieldsAdditional custom fields for notification.
-
stringspec.internal.receivers.victoropsConfigs.customFields.keyKey of the tuple.
Minimal length:
1 -
stringspec.internal.receivers.victoropsConfigs.customFields.valueValue of the tuple.
-
-
stringspec.internal.receivers.victoropsConfigs.entityDisplayNameContains summary of the alerted problem.
-
objectspec.internal.receivers.victoropsConfigs.httpConfigThe HTTP client’s configuration.
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.basicAuthBasicAuth for the client.
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.passwordThe 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.nameName of the secret.
-
booleanspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.password.optionalSpecify whether the Secret or its key must exist.
-
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.usernameThe 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.nameName of the secret.
-
booleanspec.internal.receivers.victoropsConfigs.httpConfig.basicAuth.username.optionalSpecify 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.nameName of the secret.
-
booleanspec.internal.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.victoropsConfigs.httpConfig.proxyURLOptional proxy URL.
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfigTLS configuration.
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.caStruct containing the CA cert to use for the targets.
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMapConfigMap 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.certStruct containing the client cert file for the targets.
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMapConfigMap containing data to use for the targets.
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.insecureSkipVerifyDisable target certificate validation.
-
objectspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.victoropsConfigs.httpConfig.tlsConfig.serverNameUsed to verify the hostname for the targets.
-
-
-
stringspec.internal.receivers.victoropsConfigs.messageTypeDescribes the behavior of the alert (CRITICAL, WARNING, INFO).
-
stringspec.internal.receivers.victoropsConfigs.monitoringToolThe monitoring tool the state message is from.
-
stringspec.internal.receivers.victoropsConfigs.routingKeyA key used to map the alert to a team.
-
booleanspec.internal.receivers.victoropsConfigs.sendResolvedWhether or not to notify about resolved alerts.
-
stringspec.internal.receivers.victoropsConfigs.stateMessageContains long explanation of the alerted problem.
-
-
array of objectsspec.internal.receivers.webhookConfigsList of webhook configurations.
-
objectspec.internal.receivers.webhookConfigs.httpConfigHTTP client configuration.
-
objectspec.internal.receivers.webhookConfigs.httpConfig.basicAuthBasicAuth for the client.
-
objectspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.passwordThe 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.nameName of the secret.
-
booleanspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.password.optionalSpecify whether the Secret or its key must exist.
-
-
objectspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.usernameThe 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.nameName of the secret.
-
booleanspec.internal.receivers.webhookConfigs.httpConfig.basicAuth.username.optionalSpecify 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.nameName of the secret.
-
booleanspec.internal.receivers.webhookConfigs.httpConfig.bearerTokenSecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.webhookConfigs.httpConfig.proxyURLOptional proxy URL.
-
objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfigTLS configuration.
-
objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.caStruct containing the CA cert to use for the targets.
-
objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMapConfigMap 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.certStruct containing the client cert file for the targets.
-
objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMapConfigMap containing data to use for the targets.
-
objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.insecureSkipVerifyDisable target certificate validation.
-
objectspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.keySecretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.webhookConfigs.httpConfig.tlsConfig.serverNameUsed 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.sendResolvedWhether 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.nameName of the secret.
-
booleanspec.internal.receivers.webhookConfigs.urlSecret.optionalSpecify whether the Secret or its key must exist.
-
-
-
array of objectsspec.internal.receivers.wechatConfigsList of WeChat configurations.
-
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.nameName of the secret.
-
booleanspec.internal.receivers.wechatConfigs.apiSecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.wechatConfigs.apiURLThe WeChat API URL.
-
stringspec.internal.receivers.wechatConfigs.corpIDThe corp id for authentication.
-
objectspec.internal.receivers.wechatConfigs.httpConfigHTTP client configuration.
-
objectspec.internal.receivers.wechatConfigs.httpConfig.basicAuthBasicAuth for the client.
-
objectspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.passwordThe 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.nameName of the secret.
-
booleanspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.password.optionalSpecify whether the Secret or its key must exist.
-
-
objectspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.usernameThe 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.nameName of the secret.
-
booleanspec.internal.receivers.wechatConfigs.httpConfig.basicAuth.username.optionalSpecify 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.nameName of the secret.
-
booleanspec.internal.receivers.wechatConfigs.httpConfig.bearerTokenSecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.wechatConfigs.httpConfig.proxyURLOptional proxy URL.
-
objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfigTLS configuration.
-
objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.caStruct containing the CA cert to use for the targets.
-
objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMapConfigMap 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.nameName of the ConfigMap.
-
booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.optionalSpecify whether the ConfigMap or its key must exist.
-
-
objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.certStruct containing the client cert file for the targets.
-
objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMapConfigMap containing data to use for the targets.
-
objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.optionalSpecify whether the Secret or its key must exist.
-
-
-
booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.insecureSkipVerifyDisable target certificate validation.
-
objectspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.keySecretSecret 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.nameName of the secret.
-
booleanspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.optionalSpecify whether the Secret or its key must exist.
-
-
stringspec.internal.receivers.wechatConfigs.httpConfig.tlsConfig.serverNameUsed to verify the hostname for the targets.
-
-
-
stringspec.internal.receivers.wechatConfigs.messageAPI request data as defined by the WeChat API.
-
stringspec.internal.receivers.wechatConfigs.messageType
-
booleanspec.internal.receivers.wechatConfigs.sendResolvedWhether 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
Required value
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.groupByList 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.-
stringspec.internal.route.matchers.nameLabel to match.
Minimal length:
1 -
booleanspec.internal.route.matchers.regexWhether to match on equality (false) or regular-expression (true).
-
stringspec.internal.route.matchers.valueLabel 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.routesChild routes.
-
-
-
stringspec.typeType of the Alertmanager.
Allowed values:
External,Internal
-
-
objectstatus
-
objectstatus.deckhouse
-
objectstatus.deckhouse.observedContains last timestamp when the resource change was noted by the operator and its checksum.
-
stringstatus.deckhouse.observed.checkSumThe checksum of last observed resource.
-
stringstatus.deckhouse.observed.lastTimestampLast timestamp when a change of the resource was noted by the operator.
-
-
objectstatus.deckhouse.processedContains last timestamp when the resource was applied in the cluster by the operator and its checksum.
-
stringstatus.deckhouse.processed.checkSumThe checksum of last processed resource.
-
stringstatus.deckhouse.processed.lastTimestampLast timestamp when a change of the resource was processed by the operator.
-
-
stringstatus.deckhouse.syncedTrue if last observed version of the resource was successfully applied in the cluster.
-
-
CustomPrometheusRules
Scope: Cluster
PrometheusRule. Details….
-
objectspec
-
array of objectsspec.groups
Required value
Alert group description.
The structure of the groups is similar to that of prometheus-operator.
-
stringspec.groups.interval
-
stringspec.groups.name
-
array of objectsspec.groups.rules
-
stringspec.groups.rules.alert
-
objectspec.groups.rules.annotations
-
integer or stringspec.groups.rules.expr
-
stringspec.groups.rules.for
-
objectspec.groups.rules.labels
-
stringspec.groups.rules.record
-
-
-
PrometheusRule. Details….
-
objectspec
-
array of objectsspec.groups
Required value
Alert group description.
The structure of the groups is similar to that of prometheus-operator.
-
stringspec.groups.interval
-
stringspec.groups.name
-
array of objectsspec.groups.rules
-
stringspec.groups.rules.alert
-
objectspec.groups.rules.annotations
-
integer or stringspec.groups.rules.expr
-
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
-
stringspec.access
Required value
Access mode.Allowed values:
Proxy,Direct -
booleanspec.basicAuthEnable/disable basic auth.
-
stringspec.basicAuthUserBasic auth username.
-
stringspec.databaseDatabase name (if used).
-
objectspec.jsonDataFields to be converted to JSON and stored in jsonData.
-
objectspec.secureJsonDataJSON-data object to be saved encrypted.
-
stringspec.type
Required value
Datasource type. -
stringspec.urlDatasource URL.
Example:
url: http://localhost:8080 -
stringspec.userDatabase username.
-
The resource for connecting additional datasources to Grafana.
The resource parameters are described in details in the Grafana documentation.
-
objectspec
-
stringspec.access
Required value
Access mode.Allowed values:
proxy,direct -
booleanspec.basicAuthEnable/disable basic auth.
-
stringspec.basicAuthUserBasic auth username.
-
stringspec.databaseDatabase name (if used).
-
objectspec.jsonDataFields to be converted to JSON and stored in jsonData.
-
objectspec.secureJsonDataJSON-data object to be saved encrypted.
-
stringspec.type
Required value
Datasource type. -
stringspec.urlDatasource URL.
Example:
url: http://localhost:8080 -
stringspec.userDatabase username.
-
GrafanaAlertsChannel
Scope: Cluster
Version: v1alpha1
-
objectspec
-
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.authAuthorization 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.descriptionSmall and optional description about this alerts channel.
Default:
‘’ -
booleanspec.disableResolveMessageWhen true, this option disables the resolve message [OK] that is sent when the alerting state returns to false.
Default:
false -
booleanspec.isDefaultUse this notification channel for all alerts.
Default:
false -
stringspec.type
Required value
Allowed values:
PrometheusAlertManager
-
GrafanaDashboardDefinition
Scope: Cluster
-
objectspec
-
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
-
-
objectspec
-
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
-
objectspec.basicAuthBasicAuth for the URL.
-
stringspec.basicAuth.password
Required value
Password for the authentication. -
stringspec.basicAuth.username
Required value
Username for the authentication.
-
-
stringspec.bearerTokenBearer token.
-
stringspec.customAuthTokenCustom token sent as a value of the X-Auth-Token header.
-
objectspec.headersHTTP headers to include in the request.
-
stringspec.headers.X-Scope-OrgID
Required value
TheX-Scope-OrgIDheader specifying the tenant ID.
-
-
objectspec.tlsConfigTLS Config to use for remote write.
-
stringspec.tlsConfig.caThe CA certificate used when verifying the API server certificate.
Default:
‘’ -
booleanspec.tlsConfig.insecureSkipVerifyDisable 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.actionAction to perform based on regex matching.
Default:
replace -
integerspec.writeRelabelConfigs.modulusModulus to take of the hash of the source label values.
-
stringspec.writeRelabelConfigs.regexRegular 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.separatorSeparator 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.
-
-
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
-
objectspec.basicAuthBasicAuth for the URL.
-
stringspec.basicAuth.password
Required value
Password for the authentication. -
stringspec.basicAuth.username
Required value
Username for the authentication.
-
-
stringspec.bearerTokenBearer token.
-
stringspec.customAuthTokenCustom token sent as a value of the X-Auth-Token header.
-
objectspec.headersHTTP headers to include in the request.
-
stringspec.headers.X-Scope-OrgID
Required value
TheX-Scope-OrgIDheader specifying the tenant ID.
-
-
objectspec.tlsConfigTLS Config to use for remote write.
-
stringspec.tlsConfig.caThe CA certificate used when verifying the API server certificate.
Default:
‘’ -
booleanspec.tlsConfig.insecureSkipVerifyDisable 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.actionAction to perform based on regex matching.
Default:
replace -
integerspec.writeRelabelConfigs.modulusModulus to take of the hash of the source label values.
-
stringspec.writeRelabelConfigs.regexRegular 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.separatorSeparator 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.
-
-