The module lifecycle stage: Generally available version
The module has requirements for installation
Deckhouse Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.
ClusterLog
Scope: Cluster
Version: v1alpha1
ClusterObservabilityAlertAdditionalLabels
Short names: coalabels
Scope: Cluster
Version: v1alpha1
Additional labels the module adds to alerts shipped with Deckhouse Platform.
If an alert already contains a label with the same key, its value is preserved.
Warning. Additional labels are applied only to alerts created using the resources labeled with
heritage: deckhouse.
-
objectspec
-
objectspec.additionalLabels
Required value
Additional labels to add to each matching alert.
If an alert already contains a label with the same key, its value is preserved.
-
objectspec.alertSelector
Required value
Alerts that will receive the additional labels.
Matching is performed against alert labels set in the rule and the
alertnamelabel with the alert name.-
array of objectsspec.alertSelector.matchExpressions
Required value
List of label selector requirements.
All requirements must be satisfied.
-
stringspec.alertSelector.matchExpressions.keyLabel name.
-
stringspec.alertSelector.matchExpressions.operator
Comparison operator:
In: Label exists, and its value is invalues.NotIn: Label does not exist, or its value is not invalues.Exists: Label exists.DoesNotExist: Label does not exist.
Allowed values:
In,NotIn,Exists,DoesNotExist -
array of stringsspec.alertSelector.matchExpressions.valuesLabel values for the
InandNotInoperators.
-
-
objectspec.alertSelector.matchLabelsExact key-value pairs that must be present on the alert to add labels.
-
-
ClusterObservabilityDashboard
Scope: Cluster
Version: v1alpha1
Cluster-level dashboard displayed in the Deckhouse web UI. To configure how the dashboard is displayed, use the following annotations:
metadata.deckhouse.io/category: Folder (category) of the dashboard in the interface. -metadata.deckhouse.io/title: Title of the dashboard in the interface. If the annotation is omitted, the module uses the title from the JSON manifest.
-
objectspec
-
stringspec.definition
Required value
Dashboard JSON manifest as a string compatible with the Grafana format.
-
ClusterObservabilityLogsRulesGroup
Short names: colrg
Scope: Cluster
Version: v1alpha1
Group of log-based recording rules of the cluster scope.
Rules are evaluated by the logs-ruler service, which makes LogQL queries to the log storage backend. The resulting series are exposed as regular Prometheus metrics.
To set up an alert based on the created recording rules, use the ClusterObservabilityMetricsRulesGroup resource.
Used for monitoring logs from kube-*, d8-*, and cluster-level components.
-
objectspecDesired state of a group of the log-based recording rules of the cluster scope.
-
stringspec.interval
Rule evaluation interval.
If not specified, the default value is used.
Default:
1mPattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of log-based recording rules of the cluster scope.-
stringspec.rules.expr
LogQL expression to evaluate the recording rule.
The expression must explicitly select the intended log streams (for example, by
namespace,app, or other labels available in the query backend).The
namespacevalue is not injected automatically.Minimum length:
1 -
objectspec.rules.labels
Additional labels attached to the recorded metric series.
The following labels are reserved and can’t be set by the user:
scope_typecreated_byrule_group_name
-
stringspec.rules.record
Name of the recording rule.
Must comply with the Prometheus metric naming rules and be unique within the rule group.
Minimum length:
1Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
ClusterObservabilityMetricsRulesGroup
Short names: comrg
Scope: Cluster
Version: v1alpha1
Group of cluster-wide alerting or recording rules for system namespaces.
This resource lets platform administrators manage monitoring rules and alerts
that apply to infrastructure and system namespaces (kube-*, d8-*, and an empty namespace).
-
objectspecDefines the desired state of the cluster rules group.
-
stringspec.interval
Group rule evaluation interval.
For example,
30s.If not specified, the default interval is used.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of cluster-wide alerting or recording rules.-
stringspec.rules.alert
Name of the alerting rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
objectspec.rules.annotations
Annotations to attach to the alert.
Applies only to alerting rules.
-
integer or stringspec.rules.expr
PromQL expression to evaluate the rule.
Automatically scoped to infrastructure and system namespaces (
kube-*,d8-*, and an empty namespace). -
stringspec.rules.for
Delay before the alert is triggered.
Defines how long the condition must continuously be true before the alert transitions to the firing state.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
stringspec.rules.keep_firing_for
Delay before the alert is resolved.
Defines how long the alert remains in the firing state after the condition becomes false.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
objectspec.rules.labelsAdditional labels to attach to the alert or recording rule.
-
stringspec.rules.record
Name of the recording rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
-
objectstatusState of the cluster rules group.
-
array of objectsstatus.conditionsThe latest available observed state of the cluster rules group.
-
stringstatus.conditions.lastTransitionTimeLast time the condition transitioned from one status to another.
-
stringstatus.conditions.messageHuman-readable message indicating details about last transition.
-
stringstatus.conditions.reason
Reason for the condition’s last transition.
Specified in one word in CamelCase format.
-
stringstatus.conditions.status
Current status of the condition:
True: Condition is satisfied.False: Condition is not satisfied.Unknown: Condition could not be determined.
Allowed values:
True,False,Unknown -
stringstatus.conditions.type
Type of the rules group condition:
Created: Resource is created.Failed: Syncing failed.Ready: Rules group is applied and active.
Allowed values:
Created,Failed,Ready
-
-
stringstatus.lastSyncTimeLast time a sync of the cluster rules group changed its PrometheusRule or its status. Not refreshed when a sync changes nothing.
-
stringstatus.prometheusRuleNameName of the PrometheusRule resource created for this cluster rules group.
-
ClusterObservabilityNotificationChannel
Scope: Cluster
Version: v1alpha1
Notification channel for cluster-level alerts.
The module sends a notification when an alert fires and when it is resolved. Notification rules are set by a ClusterObservabilityNotificationPolicy object.
-
objectspec
Channel parameters.
Set
typeand the section with the parameters of this type, for example,type: Emailandemail.-
objectspec.emailParameters of the
Emailchannel.-
stringspec.email.from
Required value
Sender email address. -
objectspec.email.smtp
Required value
Parameters of the SMTP server that sends the emails.-
stringspec.email.smtp.address
Required value
Address of the SMTP server in thehost:portformat, for example,smtp.example.com:587. -
objectspec.email.smtp.authCredentials for authentication on the SMTP server.
-
stringspec.email.smtp.auth.password
Required value
Password. -
stringspec.email.smtp.auth.username
Required value
Username.
-
-
booleanspec.email.smtp.requireTLSWhether TLS verification is required.
-
-
stringspec.email.templateEmail template.
-
-
objectspec.expressMessengerParameters of the
ExpressMessengerchannel.-
stringspec.expressMessenger.apiUrl
Required value
URL of the eXpress CTS server, for example,https://cts.company.ru. -
stringspec.expressMessenger.botId
Required value
ID (UUID) of the eXpress bot that sends the notifications.Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ -
stringspec.expressMessenger.secretKey
Required value
Secret key of the bot for authentication (JWT v2). -
stringspec.expressMessenger.templateMessage template.
-
-
objectspec.slackParameters of the
Slackchannel.-
stringspec.slack.apiUrl
Required value
Slack API URL. -
stringspec.slack.colorColor of the message attachment.
-
stringspec.slack.fallbackFallback text of the message.
-
stringFooter of the message.
-
stringspec.slack.iconEmojiEmoji for the message.
-
stringspec.slack.iconUrlURL of the icon image in the message.
-
stringspec.slack.pretextText above the main block of the message.
-
stringspec.slack.templateMessage template.
-
stringspec.slack.textMain text of the message.
-
stringspec.slack.titleTitle of the message.
-
stringspec.slack.titleLinkURL that the title links to.
-
stringspec.slack.usernameName of the message sender.
-
-
objectspec.telegramParameters of the
Telegramchannel.-
stringspec.telegram.apiToken
Required value
API token of the Telegram bot that sends the notifications. -
stringspec.telegram.apiUrlTelegram Bot API URL.
Default:
https://api.telegram.org -
objectspec.telegram.httpConfig
HTTP client parameters for requests to the Telegram API.
Use
proxyUrlorproxyFromEnvironmentif the Telegram API is reachable only through a proxy.Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.telegram.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.telegram.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.telegram.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.telegram.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.telegram.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.telegram.httpConfig.basicAuth.passwordPassword.
-
stringspec.telegram.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.telegram.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.telegram.httpConfig.enableHttp2Enable HTTP/2 support.
-
booleanspec.telegram.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow redirects because a redirect makes Alertmanager send a request to an address chosen by the notification recipient.
-
objectspec.telegram.httpConfig.httpHeaders
Custom HTTP headers of requests to the Telegram API.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.telegram.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.telegram.httpConfig.noProxyComma-separated list of hosts for which the proxy is not used.
-
objectspec.telegram.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.telegram.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.telegram.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.telegram.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.telegram.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.telegram.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.telegram.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.telegram.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.telegram.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.telegram.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.telegram.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.telegram.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.telegram.httpConfig.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.proxyUrlURL of the HTTP proxy for requests to the Telegram API.
-
objectspec.telegram.httpConfig.tlsConfigTLS settings for the HTTP client of the Telegram receiver.
-
stringspec.telegram.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.telegram.templateMessage template.
-
-
stringspec.type
Required value
Notification channel type.Allowed values:
Email,Slack,Telegram,Webhook,ExpressMessenger,Zabbix -
objectspec.webhookParameters of the
Webhookchannel.-
objectspec.webhook.httpConfig
HTTP client parameters for requests to the webhook URL.
Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.webhook.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.webhook.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.webhook.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.webhook.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.webhook.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.webhook.httpConfig.basicAuth.passwordPassword.
-
stringspec.webhook.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.webhook.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.webhook.httpConfig.enableHttp2Enable HTTP/2 support for webhook requests.
-
booleanspec.webhook.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow HTTP redirects.
-
objectspec.webhook.httpConfig.httpHeaders
Custom HTTP headers of requests to the webhook URL.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.webhook.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.webhook.httpConfig.noProxyComma-separated list of hosts that are accessed without the proxy.
-
objectspec.webhook.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.webhook.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.webhook.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.webhook.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.webhook.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.webhook.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.webhook.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.webhook.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.webhook.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.webhook.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.webhook.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.webhook.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.webhook.httpConfig.proxyFromEnvironmentUse the proxy parameters from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.proxyUrlURL of the HTTP proxy for webhook requests.
-
objectspec.webhook.httpConfig.tlsConfigTLS settings for requests to the webhook URL.
-
stringspec.webhook.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.webhook.url
Required value
Webhook URL.
The module sends notifications to this URL as JSON in the Alertmanager webhook format.
Minimum length:
1
-
-
objectspec.zabbixParameters of the
Zabbixchannel.-
objectspec.zabbix.api
Connection to the Zabbix API for automatic import of the template.
If the section is set, the module imports the template and creates the cluster host and host group through the Zabbix JSON-RPC API. Otherwise, import the template from the ConfigMap manually.
-
objectspec.zabbix.api.tlsConfig
TLS settings of the HTTPS connection to the Zabbix API.
Certificates and keys are given inline as PEM.
-
stringspec.zabbix.api.tlsConfig.caPEM-encoded CA certificate(s) used to verify the Zabbix API server certificate. If unset, the system trust store is used.
-
stringspec.zabbix.api.tlsConfig.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.api.tlsConfig.certPEM-encoded client certificate, for an API behind mutual TLS. Must be set together with
key. -
stringspec.zabbix.api.tlsConfig.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.api.tlsConfig.insecureSkipVerifyDisable verification of the Zabbix API server TLS certificate.
-
stringspec.zabbix.api.tlsConfig.keyPEM-encoded unencrypted private key for
cert. Must be set together withcert. -
stringspec.zabbix.api.tlsConfig.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.api.tlsConfig.serverNameServer name used for TLS certificate verification (SNI). Defaults to the host of url.
-
-
stringspec.zabbix.api.token
Required value
Zabbix API token used to authenticateconfiguration.importcalls.Minimum length:
1 -
stringspec.zabbix.api.url
Required value
URL of the Zabbix JSON-RPC API, for example,
https://zabbix.example.com/api_jsonrpc.php.If the scheme is omitted,
https://is used.Minimum length:
1
-
-
stringspec.zabbix.clusterName
Required value
Name of the cluster in Zabbix.
The name becomes the technical name of the Zabbix host that receives the data. It must be unique among all clusters and channels that send data to the same Zabbix instance.
Minimum length:
1 -
booleanspec.zabbix.disableTLS
Connect to the trapper port without TLS.
If the parameter is disabled, the connection uses TLS with the settings from
tls. Iftlsis omitted, the certificate is verified.Default:
false -
stringspec.zabbix.hostGroupZabbix host group that the cluster host is added to.
Default:
Deckhouse -
integerspec.zabbix.portTrapper port of the Zabbix Server or Zabbix Proxy.
Default:
10051 -
stringspec.zabbix.server
Required value
Address of the Zabbix Server or Zabbix Proxy that receives trapper data.Minimum length:
1 -
objectspec.zabbix.tls
TLS settings of the connection to the Zabbix Server over the sender protocol.
Certificates and keys are given inline as PEM. Zabbix certificate mode (
TLSAccept=cert) is mutual TLS:certandkeyare mandatory for it. Zabbix PSK mode is not supported.-
stringspec.zabbix.tls.caPEM-encoded CA certificate(s) used to verify the Zabbix Server/Proxy certificate. If unset, the system trust store is used.
-
stringspec.zabbix.tls.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.tls.certPEM-encoded client certificate presented to the Zabbix Server/Proxy. Must be set together with key.
-
stringspec.zabbix.tls.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.tls.insecureSkipVerifyDisable verification of the Zabbix server TLS certificate entirely. Does not lift the client certificate requirement of Zabbix certificate mode.
-
stringspec.zabbix.tls.keyPEM-encoded unencrypted private key for cert. Must be set together with cert.
-
stringspec.zabbix.tls.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.tls.serverNameServer name used for TLS certificate verification (SNI). Defaults to
spec.zabbix.server. -
booleanspec.zabbix.tls.skipServerNameVerification
Verify the server certificate chain against
cabut do not match the certificate againstserverName.Needed when the Zabbix certificate has no Subject Alternative Name (Zabbix validates only the Subject, so this is common), which is otherwise rejected. Requires
ca: against the system trust store alone, a chain check without a name would accept any publicly trusted certificate. Ignored wheninsecureSkipVerifyis true.
-
-
-
-
objectstatusStatus of the notification channel, including which policies are using it.
-
array of objectsstatus.policiesList of notification policies that are using this channel across all namespaces.
-
stringstatus.policies.nameName of the notification policy.
-
stringstatus.policies.namespace
Namespace of the notification policy.
Empty string for ClusterObservabilityNotificationPolicy.
-
-
ClusterObservabilityNotificationPolicy
Scope: Cluster
Version: v1alpha1
Rules for sending notifications about cluster-level alerts.
Using the policy, the module selects cluster-level alerts by their labels and sends notifications about them to a ClusterObservabilityNotificationChannel.
-
objectspecPolicy parameters.
-
objectspec.alert
Required value
Alerts that the policy applies to.-
array of stringsspec.alert.groupByLabels
Labels by which alerts are grouped into one notification.
Alerts with the same values of these labels are sent in one message. If the parameter is omitted, a separate notification is sent for each alert.
-
stringspec.alert.groupByLabels.Element of the arrayAlert label name.
-
-
objectspec.alert.selector
Required value
Selector of the alerts that the policy applies to.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.alert.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
The policy applies to an alert if the alert meets all of the conditions.
-
stringspec.alert.selector.matchExpressions.keyAlert label name.
-
stringspec.alert.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.alert.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.alert.selector.matchLabelsLabels and their values that an alert must have for the policy to apply to it.
-
-
-
objectspec.notification
Required value
Notification parameters.-
objectspec.notification.channel
Required value
“Channel that receives the notifications.”-
stringspec.notification.channel.kind
Required value
Kind of the notification channel object.Default:
ClusterObservabilityNotificationChannelAllowed values:
ClusterObservabilityNotificationChannel -
stringspec.notification.channel.name
Required value
Name of the channel object. -
objectspec.notification.channel.parameters
Required value
Notification channel parameters.
-
-
stringspec.notification.repeatInterval
Required value
Interval for resending the notification about an alert.Default:
1m
-
-
-
objectstatusNotification policy state.
-
stringstatus.descriptionReason why the module does not apply the policy.
-
stringstatus.state
Policy state:
Applicable: The module sends notifications according to the policy.NotApplicable: The module does not apply the policy, for example, because the channel does not exist orparametersdo not match the channel type. The reason is in thedescriptionfield.
-
ClusterObservabilityNotificationSilence
Scope: Cluster
Version: v1alpha1
Temporary silence of notifications about cluster-level alerts.
During the silence, the module does not send notifications about cluster-level alerts if they match spec.selector.
-
objectspecSilence parameters.
-
stringspec.endsAt
Required value
Time when the silence ends. -
objectspec.selector
Required value
Selector of the alerts whose notifications are silenced.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
Notifications about an alert are silenced if the alert meets all of the conditions.
-
stringspec.selector.matchExpressions.keyAlert label name.
-
stringspec.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.selector.matchLabelsLabels and their values that an alert must have for its notifications to be silenced.
-
-
stringspec.startsAt
Required value
Time when the silence starts.
-
ClusterObservabilityPropagatedDashboard
Scope: Cluster
Version: v1alpha1
Dashboard displayed in the Deckhouse web UI at the cluster level and in all namespaces (projects).
To configure how the dashboard is displayed, use the following annotations:
metadata.deckhouse.io/category: Folder (category) of the dashboard in the interface.metadata.deckhouse.io/title: Title of the dashboard in the interface. If the annotation is omitted, the module uses the title from the JSON manifest.
-
objectspec
-
stringspec.definition
Required value
Dashboard JSON manifest as a string compatible with the Grafana format.
-
ClusterObservabilityPropagatedMetricsRulesGroup
Short names: copmrg
Scope: Cluster
Version: v1alpha1
Cluster-wide group of alerting and recording rules propagated to all namespaces.
Resources with the heritage: deckhouse label are shipped with Deckhouse Platform and can be managed only by the deckhouse ServiceAccount.
-
objectspecPropagated rule group parameters.
-
stringspec.interval
Group rule evaluation interval.
For example,
30s.If not specified, the default interval is used.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of alerting and recording rules of the group.-
stringspec.rules.alert
Name of the alerting rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
objectspec.rules.annotations
Annotations to attach to the alert.
Applies only to alerting rules.
-
integer or stringspec.rules.expr
PromQL expression to evaluate the rule.
Propagated rules aren’t restricted by namespaces.
-
stringspec.rules.for
Delay before the alert is triggered.
Defines how long the condition must continuously be true before the alert transitions to the firing state.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
stringspec.rules.keep_firing_for
Delay before the alert is resolved.
Defines how long the alert remains in the firing state after the condition becomes false.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
objectspec.rules.labelsAdditional labels to attach to the alert or recording rule.
-
stringspec.rules.record
Name of the recording rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
-
objectstatusState of the cluster rules group.
-
array of objectsstatus.conditionsThe latest available observed state of the propagated rules group.
-
stringstatus.conditions.lastTransitionTimeLast time the condition transitioned from one status to another.
-
stringstatus.conditions.messageHuman-readable message indicating details about last transition.
-
stringstatus.conditions.reason
Reason for the condition’s last transition.
Specified in one word in CamelCase format.
-
stringstatus.conditions.status
Current status of the condition:
True: Condition is satisfied.False: Condition is not satisfied.Unknown: Condition could not be determined.
Allowed values:
True,False,Unknown -
stringstatus.conditions.type
Type of the rules group condition:
Created: Resource is created.Failed: Syncing failed.Ready: Rules group is applied and active.
Allowed values:
Created,Failed,Ready
-
-
stringstatus.lastSyncTime
Last time the propagated rules group was successfully synced, which changed its PrometheusRule or its status.
Not refreshed when a sync changes nothing.
-
stringstatus.prometheusRuleNameName of the PrometheusRule resource created for this propagated rules group.
-
ClusterObservabilityPropagatedNotificationChannel
Scope: Cluster
Version: v1alpha1
Notification channel available in all namespaces.
The module sends a notification when an alert fires and when it is resolved. Notification rules are set by ObservabilityNotificationPolicy objects in any namespace or by a ClusterObservabilityPropagatedNotificationPolicy object.
-
objectspec
Channel parameters.
Set
typeand the section with the parameters of this type, for example,type: Emailandemail.-
objectspec.emailParameters of the
Emailchannel.-
stringspec.email.from
Required value
Sender email address. -
objectspec.email.smtp
Required value
Parameters of the SMTP server that sends the emails.-
stringspec.email.smtp.address
Required value
Address of the SMTP server in thehost:portformat, for example,smtp.example.com:587. -
objectspec.email.smtp.authCredentials for authentication on the SMTP server.
-
stringspec.email.smtp.auth.password
Required value
Password. -
stringspec.email.smtp.auth.username
Required value
Username.
-
-
booleanspec.email.smtp.requireTLSWhether TLS verification is required.
-
-
stringspec.email.templateEmail template.
-
-
objectspec.expressMessengerParameters of the
ExpressMessengerchannel.-
stringspec.expressMessenger.apiUrl
Required value
URL of the eXpress CTS server, for example,https://cts.company.ru. -
stringspec.expressMessenger.botId
Required value
ID (UUID) of the eXpress bot that sends the notifications.Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ -
stringspec.expressMessenger.secretKey
Required value
Secret key of the bot for authentication (JWT v2). -
stringspec.expressMessenger.templateMessage template.
-
-
objectspec.slackParameters of the
Slackchannel.-
stringspec.slack.apiUrl
Required value
Slack API URL. -
stringspec.slack.colorColor of the message attachment.
-
stringspec.slack.fallbackFallback text of the message.
-
stringFooter of the message.
-
stringspec.slack.iconEmojiEmoji for the message.
-
stringspec.slack.iconUrlURL of the icon image in the message.
-
stringspec.slack.pretextText above the main block of the message.
-
stringspec.slack.templateMessage template.
-
stringspec.slack.textMain text of the message.
-
stringspec.slack.titleTitle of the message.
-
stringspec.slack.titleLinkURL that the title links to.
-
stringspec.slack.usernameName of the message sender.
-
-
objectspec.telegramParameters of the
Telegramchannel.-
stringspec.telegram.apiToken
Required value
API token of the Telegram bot that sends the notifications. -
stringspec.telegram.apiUrlTelegram Bot API URL.
Default:
https://api.telegram.org -
objectspec.telegram.httpConfig
HTTP client parameters for requests to the Telegram API.
Use
proxyUrlorproxyFromEnvironmentif the Telegram API is reachable only through a proxy.Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.telegram.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.telegram.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.telegram.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.telegram.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.telegram.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.telegram.httpConfig.basicAuth.passwordPassword.
-
stringspec.telegram.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.telegram.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.telegram.httpConfig.enableHttp2Enable HTTP/2 support.
-
booleanspec.telegram.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow redirects because a redirect makes Alertmanager send a request to an address chosen by the notification recipient.
-
objectspec.telegram.httpConfig.httpHeaders
Custom HTTP headers of requests to the Telegram API.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.telegram.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.telegram.httpConfig.noProxyComma-separated list of hosts for which the proxy is not used.
-
objectspec.telegram.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.telegram.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.telegram.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.telegram.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.telegram.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.telegram.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.telegram.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.telegram.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.telegram.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.telegram.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.telegram.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.telegram.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.telegram.httpConfig.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.proxyUrlURL of the HTTP proxy for requests to the Telegram API.
-
objectspec.telegram.httpConfig.tlsConfigTLS settings for the HTTP client of the Telegram receiver.
-
stringspec.telegram.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.telegram.templateMessage template.
-
-
stringspec.type
Required value
Notification channel type.Allowed values:
Email,Slack,Telegram,Webhook,ExpressMessenger,Zabbix -
objectspec.webhookParameters of the
Webhookchannel.-
objectspec.webhook.httpConfig
HTTP client parameters for requests to the webhook URL.
Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.webhook.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.webhook.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.webhook.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.webhook.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.webhook.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.webhook.httpConfig.basicAuth.passwordPassword.
-
stringspec.webhook.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.webhook.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.webhook.httpConfig.enableHttp2Enable HTTP/2 support for webhook requests.
-
booleanspec.webhook.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow HTTP redirects.
-
objectspec.webhook.httpConfig.httpHeaders
Custom HTTP headers of requests to the webhook URL.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.webhook.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.webhook.httpConfig.noProxyComma-separated list of hosts that are accessed without the proxy.
-
objectspec.webhook.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.webhook.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.webhook.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.webhook.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.webhook.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.webhook.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.webhook.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.webhook.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.webhook.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.webhook.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.webhook.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.webhook.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.webhook.httpConfig.proxyFromEnvironmentUse the proxy parameters from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.proxyUrlURL of the HTTP proxy for webhook requests.
-
objectspec.webhook.httpConfig.tlsConfigTLS settings for requests to the webhook URL.
-
stringspec.webhook.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.webhook.url
Required value
Webhook URL.
The module sends notifications to this URL as JSON in the Alertmanager webhook format.
Minimum length:
1
-
-
objectspec.zabbixParameters of the
Zabbixchannel.-
objectspec.zabbix.api
Connection to the Zabbix API for automatic import of the template.
If the section is set, the module imports the template and creates the cluster host and host group through the Zabbix JSON-RPC API. Otherwise, import the template from the ConfigMap manually.
-
objectspec.zabbix.api.tlsConfigTLS settings of the HTTPS connection to the Zabbix API. Certificates and keys are given inline as PEM.
-
stringspec.zabbix.api.tlsConfig.caPEM-encoded CA certificate(s) used to verify the Zabbix API server certificate. If unset, the system trust store is used.
-
stringspec.zabbix.api.tlsConfig.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.api.tlsConfig.certPEM-encoded client certificate, for an API behind mutual TLS. Must be set together with
key. -
stringspec.zabbix.api.tlsConfig.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.api.tlsConfig.insecureSkipVerifyDisable verification of the Zabbix API server TLS certificate.
-
stringspec.zabbix.api.tlsConfig.keyPEM-encoded unencrypted private key for
cert. Must be set together withcert. -
stringspec.zabbix.api.tlsConfig.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.api.tlsConfig.serverNameServer name used for TLS certificate verification (SNI). Defaults to the host of url.
-
-
stringspec.zabbix.api.token
Required value
Zabbix API token used to authenticateconfiguration.importcalls.Minimum length:
1 -
stringspec.zabbix.api.url
Required value
URL of the Zabbix JSON-RPC API, for example,
https://zabbix.example.com/api_jsonrpc.php.If the scheme is omitted,
https://is used.Minimum length:
1
-
-
stringspec.zabbix.clusterName
Required value
Name of the cluster in Zabbix.
The name becomes the technical name of the Zabbix host that receives the data. It must be unique among all clusters and channels that send data to the same Zabbix instance.
Minimum length:
1 -
booleanspec.zabbix.disableTLS
Connect to the trapper port without TLS.
If the parameter is disabled, the connection uses TLS with the settings from
tls. Iftlsis omitted, the certificate is verified.Default:
false -
stringspec.zabbix.hostGroupZabbix host group that the cluster host is added to.
Default:
Deckhouse -
integerspec.zabbix.portTrapper port of the Zabbix Server or Zabbix Proxy.
Default:
10051 -
stringspec.zabbix.server
Required value
Address of the Zabbix Server or Zabbix Proxy that receives trapper data.Minimum length:
1 -
objectspec.zabbix.tls
TLS settings of the connection to the Zabbix Server over the sender protocol.
Certificates and keys are given inline as PEM. Zabbix certificate mode (
TLSAccept=cert) is mutual TLS:certandkeyare mandatory for it. Zabbix PSK mode is not supported.-
stringspec.zabbix.tls.caPEM-encoded CA certificate(s) used to verify the Zabbix Server/Proxy certificate. If unset, the system trust store is used.
-
stringspec.zabbix.tls.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.tls.certPEM-encoded client certificate presented to the Zabbix Server/Proxy. Must be set together with
key. -
stringspec.zabbix.tls.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.tls.insecureSkipVerifyDisable verification of the Zabbix server TLS certificate entirely. Does not lift the client certificate requirement of Zabbix certificate mode.
-
stringspec.zabbix.tls.keyPEM-encoded unencrypted private key for cert. Must be set together with
cert. -
stringspec.zabbix.tls.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.tls.serverNameServer name used for TLS certificate verification (SNI). Defaults to
spec.zabbix.server. -
booleanspec.zabbix.tls.skipServerNameVerification
Verify the server certificate chain against ca but do not match the certificate against serverName.
Needed when the Zabbix certificate has no Subject Alternative Name (Zabbix validates only the Subject, so this is common), which is otherwise rejected. Requires
ca: against the system trust store alone, a chain check without a name would accept any publicly trusted certificate. Ignored wheninsecureSkipVerifyis true.
-
-
-
-
objectstatusStatus of the notification channel, including which policies are using it.
-
array of objectsstatus.policiesList of notification policies that are using this channel across all namespaces.
-
stringstatus.policies.nameName of the notification policy.
-
stringstatus.policies.namespace
Namespace of the notification policy.
Empty string for ClusterObservabilityPropagatedNotificationPolicy.
-
-
ClusterObservabilityPropagatedNotificationPolicy
Scope: Cluster
Version: v1alpha1
Rules for sending notifications about alerts that apply in every namespace.
Using the policy, the module selects alerts of each namespace by their labels and sends notifications about them to a ClusterObservabilityPropagatedNotificationChannel. In each namespace, the policy works the same way as an ObservabilityNotificationPolicy created in it.
-
objectspecPolicy parameters.
-
objectspec.alert
Required value
Alerts that the policy applies to.-
array of stringsspec.alert.groupByLabels
Labels by which alerts are grouped into one notification.
Alerts with the same values of these labels are sent in one message. If the parameter is omitted, a separate notification is sent for each alert.
-
stringspec.alert.groupByLabels.Element of the arrayAlert label name.
-
-
objectspec.alert.selector
Required value
Selector of the alerts that the policy applies to.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.alert.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
The policy applies to an alert if the alert meets all of the conditions.
-
stringspec.alert.selector.matchExpressions.keyAlert label name.
-
stringspec.alert.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.alert.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.alert.selector.matchLabelsLabels and their values that an alert must have for the policy to apply to it.
-
-
-
objectspec.notification
Required value
Notification parameters.-
objectspec.notification.channel
Required value
“Channel that receives the notifications.”-
stringspec.notification.channel.kind
Required value
Kind of the notification channel object.Default:
ClusterObservabilityPropagatedNotificationChannelAllowed values:
ClusterObservabilityPropagatedNotificationChannel -
stringspec.notification.channel.name
Required value
Name of the channel object. -
objectspec.notification.channel.parameters
Required value
Notification channel parameters.
-
-
stringspec.notification.repeatInterval
Required value
Interval for resending the notification about an alert.Default:
1m
-
-
-
objectstatusNotification policy state.
-
stringstatus.descriptionReason why the module does not apply the policy.
-
stringstatus.state
Policy state:
Applicable: The module sends notifications according to the policy.NotApplicable: The module does not apply the policy, for example, because the channel does not exist orparametersdo not match the channel type. The reason is in thedescriptionfield.
-
ObservabilityDashboard
Scope: Namespaced
Version: v1alpha1
Dashboard of a single namespace in the Deckhouse web UI. The dashboard is displayed in the project of the namespace where the object is created. To configure how the dashboard is displayed, use the following annotations:
metadata.deckhouse.io/category: Folder (category) of the dashboard in the interface. -metadata.deckhouse.io/title: Title of the dashboard in the interface. If the annotation is omitted, the module uses the title from the JSON manifest.
-
objectspec
-
stringspec.definition
Required value
Dashboard JSON manifest as a string compatible with the Grafana format.
-
ObservabilityLogsRulesGroup
Short names: olrg
Scope: Namespaced
Version: v1alpha1
Group of log-based recording rules of the namespace scope.
Rules are evaluated by the logs-ruler service, which makes LogQL queries to the log storage backend. The resulting series are exposed as regular Prometheus metrics.
To set up an alert based on the created recording rules, use the ObservabilityMetricsRulesGroup resource.
LogQL expressions are evaluated for logs of a namespace where the resource is created.
-
objectspecParameters of a group of the log-based recording rules.
-
stringspec.interval
Rule evaluation interval.
For example,
30sor1m.If not specified, the default value is used.
Default:
1mPattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of log-based recording rules.-
stringspec.rules.expr
LogQL expression to evaluate the recording rule.
Do not use the
namespacelabel in the expression. The module adds it automatically based on the resource namespace.Minimum length:
1 -
objectspec.rules.labels
Additional labels attached to the recorded metric series.
The following labels are reserved and can’t be set by the user:
namespacescope_typecreated_byrule_group_name
-
stringspec.rules.record
Name of the recording rule.
Must comply with the Prometheus metric naming rules and be unique within the rule group.
Minimum length:
1Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
ObservabilityMetricsRulesGroup
Short names: omrg
Scope: Namespaced
Version: v1alpha1
-
objectspecRule group parameters.
-
stringspec.interval
Group rule evaluation interval.
If not specified, the default interval is used.
Default:
1mPattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of alerting and recording rules of the group.-
stringspec.rules.alert
Name of the alerting rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
objectspec.rules.annotations
Annotations to attach to the alert.
Applies only to alerting rules.
-
integer or stringspec.rules.exprPromQL expression to evaluate the rule.
-
stringspec.rules.for
Delay before the alert is triggered.
Defines how long the condition must continuously be true before the alert transitions to the firing state.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
stringspec.rules.keep_firing_for
Delay before the alert is resolved.
Defines how long the alert remains in the firing state after the condition becomes false.
Applies only to alerting rules.
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
objectspec.rules.labelsAdditional labels to attach to the alert or recording rule.
-
stringspec.rules.record
Name of the recording rule.
Only one of the fields can be specified at the same time:
alertorrecord.Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
-
objectstatusRule group state.
-
array of objectsstatus.conditionsThe latest available observed state of the rules group.
-
stringstatus.conditions.lastTransitionTimeLast time the condition transitioned from one status to another.
-
stringstatus.conditions.messageHuman-readable message indicating details about last transition.
-
stringstatus.conditions.reason
Reason for the condition’s last transition.
Specified in one word in CamelCase format.
-
stringstatus.conditions.status
Current status of the condition:
True: Condition is satisfied.False: Condition is not satisfied.Unknown: Condition could not be determined.
Allowed values:
True,False,Unknown -
stringstatus.conditions.type
Type of the rules group condition:
Created: Resource is created.Failed: Syncing failed.Ready: Rules group is applied and active.
Allowed values:
Created,Failed,Ready
-
-
stringstatus.lastSyncTime
Last time the rules group was successfully synced, which changed its PrometheusRule or its status.
Not refreshed when a sync changes nothing.
-
stringstatus.prometheusRuleNameName of the PrometheusRule resource created for this rules group.
-
ObservabilityNotificationChannel
Scope: Namespaced
Version: v1alpha1
Notification channel for the alerts of one namespace.
The module sends a notification when an alert fires and when it is resolved. Notification rules are set by an ObservabilityNotificationPolicy object in the same namespace.
-
objectspec
Channel parameters.
Set
typeand the section with the parameters of this type, for example,type: Emailandemail.-
objectspec.emailParameters of the
Emailchannel.-
stringspec.email.from
Required value
Sender email address. -
objectspec.email.smtp
Required value
Parameters of the SMTP server that sends the emails.-
stringspec.email.smtp.address
Required value
Address of the SMTP server in thehost:portformat, for example,smtp.example.com:587. -
objectspec.email.smtp.authCredentials for authentication on the SMTP server.
-
stringspec.email.smtp.auth.password
Required value
Password. -
stringspec.email.smtp.auth.username
Required value
Username.
-
-
booleanspec.email.smtp.requireTLSWhether TLS verification is required.
-
-
stringspec.email.templateEmail template.
-
-
objectspec.expressMessengerParameters of the
ExpressMessengerchannel.-
stringspec.expressMessenger.apiUrl
Required value
URL of the eXpress CTS server, for example,https://cts.company.ru. -
stringspec.expressMessenger.botId
Required value
ID (UUID) of the eXpress bot that sends the notifications.Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ -
stringspec.expressMessenger.secretKey
Required value
Secret key of the bot for authentication (JWT v2). -
stringspec.expressMessenger.templateMessage template.
-
-
objectspec.slackParameters of the
Slackchannel.-
stringspec.slack.apiUrl
Required value
Slack API URL. -
stringspec.slack.colorColor of the message attachment.
-
stringspec.slack.fallbackFallback text of the message.
-
stringFooter of the message.
-
stringspec.slack.iconEmojiEmoji for the message.
-
stringspec.slack.iconUrlURL of the icon image in the message.
-
stringspec.slack.pretextText above the main block of the message.
-
stringspec.slack.templateMessage template.
-
stringspec.slack.textMain text of the message.
-
stringspec.slack.titleTitle of the message.
-
stringspec.slack.titleLinkURL that the title links to.
-
stringspec.slack.usernameName of the message sender.
-
-
objectspec.telegramParameters of the
Telegramchannel.-
stringspec.telegram.apiToken
Required value
API token of the Telegram bot that sends the notifications. -
stringspec.telegram.apiUrlTelegram Bot API URL.
Default:
https://api.telegram.org -
objectspec.telegram.httpConfig
HTTP client parameters for requests to the Telegram API.
Use
proxyUrlorproxyFromEnvironmentif the Telegram API is reachable only through a proxy.Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.telegram.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.telegram.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.telegram.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.telegram.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.telegram.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.telegram.httpConfig.basicAuth.passwordPassword.
-
stringspec.telegram.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.telegram.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.telegram.httpConfig.enableHttp2Enable HTTP/2 support.
-
booleanspec.telegram.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow redirects because a redirect makes Alertmanager send a request to an address chosen by the notification recipient.
-
objectspec.telegram.httpConfig.httpHeaders
Custom HTTP headers of requests to the Telegram API.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.telegram.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
File contents are not inserted into request headers. Use
valuesorsecrets. -
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.telegram.httpConfig.noProxyComma-separated list of hosts for which the proxy is not used.
-
objectspec.telegram.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.telegram.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.telegram.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.telegram.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.telegram.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.telegram.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.telegram.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.telegram.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.telegram.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.telegram.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.telegram.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.telegram.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.telegram.httpConfig.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.telegram.httpConfig.proxyUrlURL of the HTTP proxy for requests to the Telegram API.
-
objectspec.telegram.httpConfig.tlsConfigTLS settings for the HTTP client of the Telegram receiver.
-
stringspec.telegram.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.telegram.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.telegram.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.telegram.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.telegram.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.telegram.templateMessage template.
-
-
stringspec.type
Required value
Notification channel type.Allowed values:
Email,Slack,Telegram,Webhook,ExpressMessenger,Zabbix -
objectspec.webhookParameters of the
Webhookchannel.-
objectspec.webhook.httpConfig
HTTP client parameters for requests to the webhook URL.
Set only one of the
basicAuth,authorizationandoauth2parameters.-
objectspec.webhook.httpConfig.authorizationValue of the
Authorizationheader.-
stringspec.webhook.httpConfig.authorization.credentialsCredentials inserted into the
Authorizationheader. -
stringspec.webhook.httpConfig.authorization.credentialsFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
credentials. -
stringspec.webhook.httpConfig.authorization.type
Authentication scheme, for example,
Bearer.If the parameter is omitted,
Beareris used.
-
-
objectspec.webhook.httpConfig.basicAuthHTTP Basic authentication.
-
stringspec.webhook.httpConfig.basicAuth.passwordPassword.
-
stringspec.webhook.httpConfig.basicAuth.passwordFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
password. -
stringspec.webhook.httpConfig.basicAuth.usernameUsername.
-
-
booleanspec.webhook.httpConfig.enableHttp2Enable HTTP/2 support for webhook requests.
-
booleanspec.webhook.httpConfig.followRedirects
Deprecated and ignored for security reasons.
The module does not follow HTTP redirects.
-
objectspec.webhook.httpConfig.httpHeaders
Custom HTTP headers of requests to the webhook URL.
The object key is the header name, the value is an object with a list of values and/or references to secrets and files.
-
objectspec.webhook.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— item (key) name.-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
valuesorsecrets. -
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secretsHeader values read from secrets.
-
array of stringsspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.valuesHeader values.
-
-
-
stringspec.webhook.httpConfig.noProxyComma-separated list of hosts that are accessed without the proxy.
-
objectspec.webhook.httpConfig.oauth2OAuth 2.0 authentication.
-
stringspec.webhook.httpConfig.oauth2.clientId
Required value
OAuth 2.0 client ID. -
stringspec.webhook.httpConfig.oauth2.clientSecretOAuth 2.0 client secret.
-
stringspec.webhook.httpConfig.oauth2.clientSecretFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container. Use
clientSecret. -
objectspec.webhook.httpConfig.oauth2.endpointParamsAdditional parameters passed in the token request.
-
stringspec.webhook.httpConfig.oauth2.noProxyComma-separated list of hosts for which the proxy is not used.
-
booleanspec.webhook.httpConfig.oauth2.proxyFromEnvironmentUse the proxy from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.oauth2.proxyUrlURL of the HTTP proxy used for the token request.
-
array of stringsspec.webhook.httpConfig.oauth2.scopesScopes requested for the token.
-
stringspec.webhook.httpConfig.oauth2.scopes.Element of the arrayScope name.
-
-
objectspec.webhook.httpConfig.oauth2.tlsConfigTLS settings for the token request.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.oauth2.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
stringspec.webhook.httpConfig.oauth2.tokenUrl
Required value
URL of the token endpoint.
-
-
objectspec.webhook.httpConfig.proxyConnectHeader
Headers of
CONNECTrequests to the proxy.Header names are mapped to lists of values.
-
booleanspec.webhook.httpConfig.proxyFromEnvironmentUse the proxy parameters from the
HTTP_PROXY,HTTPS_PROXYandNO_PROXYenvironment variables. -
stringspec.webhook.httpConfig.proxyUrlURL of the HTTP proxy for webhook requests.
-
objectspec.webhook.httpConfig.tlsConfigTLS settings for requests to the webhook URL.
-
stringspec.webhook.httpConfig.tlsConfig.caFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.certFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
booleanspec.webhook.httpConfig.tlsConfig.insecureSkipVerifyDisable verification of the server TLS certificate.
-
stringspec.webhook.httpConfig.tlsConfig.keyFile
Deprecated and ignored for security reasons.
The module does not read files from the Alertmanager container.
-
stringspec.webhook.httpConfig.tlsConfig.maxVersionMaximum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.minVersionMinimum TLS version.
-
stringspec.webhook.httpConfig.tlsConfig.serverNameServer name for TLS certificate verification (SNI).
-
-
-
stringspec.webhook.url
Required value
Webhook URL.
The module sends notifications to this URL as JSON in the Alertmanager webhook format.
Minimum length:
1
-
-
objectspec.zabbixParameters of the
Zabbixchannel.-
objectspec.zabbix.api
Connection to the Zabbix API for automatic import of the template.
If the section is set, the module imports the template and creates the cluster host and host group through the Zabbix JSON-RPC API. Otherwise, import the template from the ConfigMap manually.
-
objectspec.zabbix.api.tlsConfigTLS settings for the HTTPS connection to the Zabbix API. Certificates and keys are given inline as PEM.
-
stringspec.zabbix.api.tlsConfig.caPEM-encoded CA certificate(s) used to verify the Zabbix API server certificate. If unset, the system trust store is used.
-
stringspec.zabbix.api.tlsConfig.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.api.tlsConfig.certPEM-encoded client certificate, for an API behind mutual TLS. Must be set together with
key. -
stringspec.zabbix.api.tlsConfig.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.api.tlsConfig.insecureSkipVerifyDisable verification of the Zabbix API server TLS certificate.
-
stringspec.zabbix.api.tlsConfig.keyPEM-encoded unencrypted private key for
cert. Must be set together withcert. -
stringspec.zabbix.api.tlsConfig.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.api.tlsConfig.serverNameServer name used for TLS certificate verification (SNI). Defaults to the host of url.
-
-
stringspec.zabbix.api.token
Required value
Zabbix API token used to authenticateconfiguration.importcalls.Minimum length:
1 -
stringspec.zabbix.api.url
Required value
URL of the Zabbix JSON-RPC API, for example,
https://zabbix.example.com/api_jsonrpc.php.If the scheme is omitted,
https://is used.Minimum length:
1
-
-
stringspec.zabbix.clusterName
Required value
Name of the cluster in Zabbix.
The name becomes the technical name of the Zabbix host that receives the data. It must be unique among all clusters and channels that send data to the same Zabbix instance.
Minimum length:
1 -
booleanspec.zabbix.disableTLS
Connect to the trapper port without TLS.
If the parameter is disabled, the connection uses TLS with the settings from
tls. Iftlsis omitted, the certificate is verified.Default:
false -
stringspec.zabbix.hostGroupZabbix host group that the cluster host is added to.
Default:
Deckhouse -
integerspec.zabbix.portTrapper port of the Zabbix Server or Zabbix Proxy.
Default:
10051 -
stringspec.zabbix.server
Required value
Address of the Zabbix Server or Zabbix Proxy that receives trapper data.Minimum length:
1 -
objectspec.zabbix.tls
TLS settings of the connection to the Zabbix Server over the sender protocol.
Certificates and keys are given inline as PEM. Zabbix certificate mode (TLSAccept=cert) is mutual TLS:
certandkeyare mandatory for it. Zabbix PSK mode is not supported.-
stringspec.zabbix.tls.caPEM-encoded CA certificate(s) used to verify the Zabbix Server/Proxy certificate. If unset, the system trust store is used.
-
stringspec.zabbix.tls.caFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
cainstead. -
stringspec.zabbix.tls.certPEM-encoded client certificate presented to the Zabbix Server/Proxy. Must be set together with
key. -
stringspec.zabbix.tls.certFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
certinstead. -
booleanspec.zabbix.tls.insecureSkipVerifyDisable verification of the Zabbix server TLS certificate entirely. Does not lift the client certificate requirement of Zabbix certificate mode.
-
stringspec.zabbix.tls.keyPEM-encoded unencrypted private key for
cert. Must be set together withcert. -
stringspec.zabbix.tls.keyFileDeprecatedDeprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into
keyinstead. -
stringspec.zabbix.tls.serverNameServer name used for TLS certificate verification (SNI). Defaults to
spec.zabbix.server. -
booleanspec.zabbix.tls.skipServerNameVerification
Verify the server certificate chain against
cabut do not match the certificate against serverName.Needed when the Zabbix certificate has no Subject Alternative Name (Zabbix validates only the Subject, so this is common), which is otherwise rejected. Requires
ca: against the system trust store alone, a chain check without a name would accept any publicly trusted certificate. Ignored wheninsecureSkipVerifyis true.
-
-
-
-
objectstatusStatus of the notification channel, including which policies are using it.
-
array of stringsstatus.policiesList of ObservabilityNotificationPolicy objects using this channel.
-
stringstatus.policies.Element of the arrayName of the notification policy.
-
-
ObservabilityNotificationPolicy
Scope: Namespaced
Version: v1alpha1
Rules for sending notifications about the alerts of one namespace.
Using the policy, the module selects alerts of the namespace where the object is created by their labels and sends notifications about them to an ObservabilityNotificationChannel from the same namespace or to a ClusterObservabilityPropagatedNotificationChannel.
-
objectspecPolicy parameters.
-
objectspec.alert
Required value
Alerts that the policy applies to.-
array of stringsspec.alert.groupByLabels
Labels by which alerts are grouped into one notification.
Alerts with the same values of these labels are sent in one message. If the parameter is omitted, a separate notification is sent for each alert.
-
stringspec.alert.groupByLabels.Element of the arrayAlert label name.
-
-
objectspec.alert.selector
Required value
Selector of the alerts that the policy applies to.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.alert.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
The policy applies to an alert if the alert meets all of the conditions.
-
stringspec.alert.selector.matchExpressions.keyAlert label name.
-
stringspec.alert.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.alert.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.alert.selector.matchLabelsLabels and their values that an alert must have for the policy to apply to it.
-
-
-
objectspec.notification
Required value
Notification parameters.-
objectspec.notification.channel
Required value
Channel that receives the notifications.-
stringspec.notification.channel.kind
Required value
Kind of the notification channel object:
ObservabilityNotificationChannel: A channel from the namespace of the policy.ClusterObservabilityPropagatedNotificationChannel: A channel available in all namespaces.
Default:
ObservabilityNotificationChannelAllowed values:
ClusterObservabilityPropagatedNotificationChannel,ObservabilityNotificationChannel -
stringspec.notification.channel.name
Required value
Name of the channel object. -
objectspec.notification.channel.parameters
Required value
Notification channel parameters.
-
-
stringspec.notification.repeatInterval
Required value
Interval for resending the notification about an alert.Default:
1m
-
-
-
objectstatusNotification policy state.
-
stringstatus.descriptionReason why the module does not apply the policy.
-
stringstatus.state
Policy state:
Applicable: The module sends notifications according to the policy.NotApplicable: The module does not apply the policy, for example, because the channel does not exist orparametersdo not match the channel type. The reason is in thedescriptionfield.
-
ObservabilityNotificationSilence
Scope: Namespaced
Version: v1alpha1
Temporary silence of notifications about the alerts of one namespace.
During the silence, the module does not send notifications about the alerts of the namespace where the object is created if they match spec.selector.
-
objectspecSilence parameters.
-
stringspec.endsAt
Required value
Time when the silence ends. -
objectspec.selector
Required value
Selector of the alerts whose notifications are silenced.
Set only one of the fields:
matchLabelsormatchExpressions.-
array of objectsspec.selector.matchExpressions
Set of expressions (conditions) for filtering alerts.
Notifications about an alert are silenced if the alert meets all of the conditions.
-
stringspec.selector.matchExpressions.keyAlert label name.
-
stringspec.selector.matchExpressions.operator
Comparison operator:
Equal: The label value equalsvalue.NotEqual: The label value differs fromvalue.Regex: The label value matches thevalueregular expression.NotRegex: The label value does not match thevalueregular expression.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.selector.matchExpressions.valueValue or regular expression to compare the label value with.
-
-
objectspec.selector.matchLabelsLabels and their values that an alert must have for its notifications to be silenced.
-
-
stringspec.startsAt
Required value
Time when the silence starts.
-