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

Cluster-wide resource used in RBAC to control access to logs.

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.

  • spec
    object
    • spec.additionalLabels
      object

      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.

    • spec.alertSelector
      object

      Required value

      Alerts that will receive the additional labels.

      Matching is performed against alert labels set in the rule and the alertname label with the alert name.

      • spec.alertSelector.matchExpressions
        array of objects

        Required value

        List of label selector requirements.

        All requirements must be satisfied.

        • spec.alertSelector.matchExpressions.key
          string
          Label name.
        • spec.alertSelector.matchExpressions.operator
          string

          Comparison operator:

          • In: Label exists, and its value is in values.
          • NotIn: Label does not exist, or its value is not in values.
          • Exists: Label exists.
          • DoesNotExist: Label does not exist.

          Allowed values: In, NotIn, Exists, DoesNotExist

        • spec.alertSelector.matchExpressions.values
          array of strings
          Label values for the In and NotIn operators.
      • spec.alertSelector.matchLabels
        object
        Exact 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.
  • spec
    object
    • spec.definition
      string

      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.

  • spec
    object
    Desired state of a group of the log-based recording rules of the cluster scope.
    • spec.interval
      string

      Rule evaluation interval.

      If not specified, the default value is used.

      Default: 1m

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

    • spec.rules
      array of objects

      Required value

      List of log-based recording rules of the cluster scope.
      • spec.rules.expr
        string

        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 namespace value is not injected automatically.

        Minimum length: 1

      • spec.rules.labels
        object

        Additional labels attached to the recorded metric series.

        The following labels are reserved and can’t be set by the user:

        • scope_type
        • created_by
        • rule_group_name
      • spec.rules.record
        string

        Name of the recording rule.

        Must comply with the Prometheus metric naming rules and be unique within the rule group.

        Minimum length: 1

        Pattern: ^[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).

  • spec
    object
    Defines the desired state of the cluster rules group.
    • spec.interval
      string

      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)?)$

    • spec.rules
      array of objects

      Required value

      List of cluster-wide alerting or recording rules.
      • spec.rules.alert
        string

        Name of the alerting rule.

        Only one of the fields can be specified at the same time: alert or record.

        Pattern: ^[a-zA-Z-:][a-zA-Z0-9-:]*$

      • spec.rules.annotations
        object

        Annotations to attach to the alert.

        Applies only to alerting rules.

      • spec.rules.expr
        integer or string

        PromQL expression to evaluate the rule.

        Automatically scoped to infrastructure and system namespaces (kube-*, d8-*, and an empty namespace).

      • spec.rules.for
        string

        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)?)$

      • spec.rules.keep_firing_for
        string

        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)?)$

      • spec.rules.labels
        object
        Additional labels to attach to the alert or recording rule.
      • spec.rules.record
        string

        Name of the recording rule.

        Only one of the fields can be specified at the same time: alert or record.

        Pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]*$

  • status
    object
    State of the cluster rules group.
    • status.conditions
      array of objects
      The latest available observed state of the cluster rules group.
      • status.conditions.lastTransitionTime
        string
        Last time the condition transitioned from one status to another.
      • status.conditions.message
        string
        Human-readable message indicating details about last transition.
      • status.conditions.reason
        string

        Reason for the condition’s last transition.

        Specified in one word in CamelCase format.

      • status.conditions.status
        string

        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

      • status.conditions.type
        string

        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

    • status.lastSyncTime
      string
      Last time a sync of the cluster rules group changed its PrometheusRule or its status. Not refreshed when a sync changes nothing.
    • status.prometheusRuleName
      string
      Name 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.

  • spec
    object

    Channel parameters.

    Set type and the section with the parameters of this type, for example, type: Email and email.

    • spec.email
      object
      Parameters of the Email channel.
      • spec.email.from
        string

        Required value

        Sender email address.
      • spec.email.smtp
        object

        Required value

        Parameters of the SMTP server that sends the emails.
        • spec.email.smtp.address
          string

          Required value

          Address of the SMTP server in the host:port format, for example, smtp.example.com:587.
        • spec.email.smtp.auth
          object
          Credentials for authentication on the SMTP server.
          • spec.email.smtp.auth.password
            string

            Required value

            Password.
          • spec.email.smtp.auth.username
            string

            Required value

            Username.
        • spec.email.smtp.requireTLS
          boolean
          Whether TLS verification is required.
      • spec.email.template
        string
        Email template.
    • spec.expressMessenger
      object
      Parameters of the ExpressMessenger channel.
      • spec.expressMessenger.apiUrl
        string

        Required value

        URL of the eXpress CTS server, for example, https://cts.company.ru.
      • spec.expressMessenger.botId
        string

        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}$

      • spec.expressMessenger.secretKey
        string

        Required value

        Secret key of the bot for authentication (JWT v2).
      • spec.expressMessenger.template
        string
        Message template.
    • spec.slack
      object
      Parameters of the Slack channel.
      • spec.slack.apiUrl
        string

        Required value

        Slack API URL.
      • spec.slack.color
        string
        Color of the message attachment.
      • spec.slack.fallback
        string
        Fallback text of the message.
      • string
        Footer of the message.
      • spec.slack.iconEmoji
        string
        Emoji for the message.
      • spec.slack.iconUrl
        string
        URL of the icon image in the message.
      • spec.slack.pretext
        string
        Text above the main block of the message.
      • spec.slack.template
        string
        Message template.
      • spec.slack.text
        string
        Main text of the message.
      • spec.slack.title
        string
        Title of the message.
      • string
        URL that the title links to.
      • spec.slack.username
        string
        Name of the message sender.
    • spec.telegram
      object
      Parameters of the Telegram channel.
      • spec.telegram.apiToken
        string

        Required value

        API token of the Telegram bot that sends the notifications.
      • spec.telegram.apiUrl
        string
        Telegram Bot API URL.

        Default: https://api.telegram.org

      • spec.telegram.httpConfig
        object

        HTTP client parameters for requests to the Telegram API.

        Use proxyUrl or proxyFromEnvironment if the Telegram API is reachable only through a proxy.

        Set only one of the basicAuth, authorization and oauth2 parameters.

        • spec.telegram.httpConfig.authorization
          object
          Value of the Authorization header.
          • spec.telegram.httpConfig.authorization.credentials
            string
            Credentials inserted into the Authorization header.
          • spec.telegram.httpConfig.authorization.credentialsFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use credentials.

          • spec.telegram.httpConfig.authorization.type
            string

            Authentication scheme, for example, Bearer.

            If the parameter is omitted, Bearer is used.

        • spec.telegram.httpConfig.basicAuth
          object
          HTTP Basic authentication.
          • spec.telegram.httpConfig.basicAuth.password
            string
            Password.
          • spec.telegram.httpConfig.basicAuth.passwordFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use password.

          • spec.telegram.httpConfig.basicAuth.username
            string
            Username.
        • spec.telegram.httpConfig.enableHttp2
          boolean
          Enable HTTP/2 support.
        • spec.telegram.httpConfig.followRedirects
          boolean

          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.

        • spec.telegram.httpConfig.httpHeaders
          object

          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.

          • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings

              Deprecated and ignored for security reasons.

              File contents are not inserted into request headers. Use values or secrets.

            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
              Header values read from secrets.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
              Header values.
        • spec.telegram.httpConfig.noProxy
          string
          Comma-separated list of hosts for which the proxy is not used.
        • spec.telegram.httpConfig.oauth2
          object
          OAuth 2.0 authentication.
          • spec.telegram.httpConfig.oauth2.clientId
            string

            Required value

            OAuth 2.0 client ID.
          • spec.telegram.httpConfig.oauth2.clientSecret
            string
            OAuth 2.0 client secret.
          • spec.telegram.httpConfig.oauth2.clientSecretFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use clientSecret.

          • spec.telegram.httpConfig.oauth2.endpointParams
            object
            Additional parameters passed in the token request.
          • spec.telegram.httpConfig.oauth2.noProxy
            string
            Comma-separated list of hosts for which the proxy is not used.
          • spec.telegram.httpConfig.oauth2.proxyFromEnvironment
            boolean
            Use the proxy from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
          • spec.telegram.httpConfig.oauth2.proxyUrl
            string
            URL of the HTTP proxy used for the token request.
          • spec.telegram.httpConfig.oauth2.scopes
            array of strings
            Scopes requested for the token.
            • spec.telegram.httpConfig.oauth2.scopes.Element of the array
              string
              Scope name.
          • spec.telegram.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.telegram.httpConfig.oauth2.tlsConfig.caFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.telegram.httpConfig.oauth2.tlsConfig.certFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
              Disable verification of the server TLS certificate.
            • spec.telegram.httpConfig.oauth2.tlsConfig.keyFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.telegram.httpConfig.oauth2.tlsConfig.maxVersion
              string
              Maximum TLS version.
            • spec.telegram.httpConfig.oauth2.tlsConfig.minVersion
              string
              Minimum TLS version.
            • spec.telegram.httpConfig.oauth2.tlsConfig.serverName
              string
              Server name for TLS certificate verification (SNI).
          • spec.telegram.httpConfig.oauth2.tokenUrl
            string

            Required value

            URL of the token endpoint.
        • spec.telegram.httpConfig.proxyConnectHeader
          object

          Headers of CONNECT requests to the proxy.

          Header names are mapped to lists of values.

        • spec.telegram.httpConfig.proxyFromEnvironment
          boolean
          Use the proxy from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
        • spec.telegram.httpConfig.proxyUrl
          string
          URL of the HTTP proxy for requests to the Telegram API.
        • spec.telegram.httpConfig.tlsConfig
          object
          TLS settings for the HTTP client of the Telegram receiver.
          • spec.telegram.httpConfig.tlsConfig.caFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.telegram.httpConfig.tlsConfig.certFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.telegram.httpConfig.tlsConfig.insecureSkipVerify
            boolean
            Disable verification of the server TLS certificate.
          • spec.telegram.httpConfig.tlsConfig.keyFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.telegram.httpConfig.tlsConfig.maxVersion
            string
            Maximum TLS version.
          • spec.telegram.httpConfig.tlsConfig.minVersion
            string
            Minimum TLS version.
          • spec.telegram.httpConfig.tlsConfig.serverName
            string
            Server name for TLS certificate verification (SNI).
      • spec.telegram.template
        string
        Message template.
    • spec.type
      string

      Required value

      Notification channel type.

      Allowed values: Email, Slack, Telegram, Webhook, ExpressMessenger, Zabbix

    • spec.webhook
      object
      Parameters of the Webhook channel.
      • spec.webhook.httpConfig
        object

        HTTP client parameters for requests to the webhook URL.

        Set only one of the basicAuth, authorization and oauth2 parameters.

        • spec.webhook.httpConfig.authorization
          object
          Value of the Authorization header.
          • spec.webhook.httpConfig.authorization.credentials
            string
            Credentials inserted into the Authorization header.
          • spec.webhook.httpConfig.authorization.credentialsFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use credentials.

          • spec.webhook.httpConfig.authorization.type
            string

            Authentication scheme, for example, Bearer.

            If the parameter is omitted, Bearer is used.

        • spec.webhook.httpConfig.basicAuth
          object
          HTTP Basic authentication.
          • spec.webhook.httpConfig.basicAuth.password
            string
            Password.
          • spec.webhook.httpConfig.basicAuth.passwordFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use password.

          • spec.webhook.httpConfig.basicAuth.username
            string
            Username.
        • spec.webhook.httpConfig.enableHttp2
          boolean
          Enable HTTP/2 support for webhook requests.
        • spec.webhook.httpConfig.followRedirects
          boolean

          Deprecated and ignored for security reasons.

          The module does not follow HTTP redirects.

        • spec.webhook.httpConfig.httpHeaders
          object

          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.

          • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings

              Deprecated and ignored for security reasons.

              File contents are not inserted into request headers. Use values or secrets.

            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
              Header values read from secrets.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
              Header values.
        • spec.webhook.httpConfig.noProxy
          string
          Comma-separated list of hosts that are accessed without the proxy.
        • spec.webhook.httpConfig.oauth2
          object
          OAuth 2.0 authentication.
          • spec.webhook.httpConfig.oauth2.clientId
            string

            Required value

            OAuth 2.0 client ID.
          • spec.webhook.httpConfig.oauth2.clientSecret
            string
            OAuth 2.0 client secret.
          • spec.webhook.httpConfig.oauth2.clientSecretFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use clientSecret.

          • spec.webhook.httpConfig.oauth2.endpointParams
            object
            Additional parameters passed in the token request.
          • spec.webhook.httpConfig.oauth2.noProxy
            string
            Comma-separated list of hosts for which the proxy is not used.
          • spec.webhook.httpConfig.oauth2.proxyFromEnvironment
            boolean
            Use the proxy from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
          • spec.webhook.httpConfig.oauth2.proxyUrl
            string
            URL of the HTTP proxy used for the token request.
          • spec.webhook.httpConfig.oauth2.scopes
            array of strings
            Scopes requested for the token.
            • spec.webhook.httpConfig.oauth2.scopes.Element of the array
              string
              Scope name.
          • spec.webhook.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.webhook.httpConfig.oauth2.tlsConfig.caFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.webhook.httpConfig.oauth2.tlsConfig.certFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
              Disable verification of the server TLS certificate.
            • spec.webhook.httpConfig.oauth2.tlsConfig.keyFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.webhook.httpConfig.oauth2.tlsConfig.maxVersion
              string
              Maximum TLS version.
            • spec.webhook.httpConfig.oauth2.tlsConfig.minVersion
              string
              Minimum TLS version.
            • spec.webhook.httpConfig.oauth2.tlsConfig.serverName
              string
              Server name for TLS certificate verification (SNI).
          • spec.webhook.httpConfig.oauth2.tokenUrl
            string

            Required value

            URL of the token endpoint.
        • spec.webhook.httpConfig.proxyConnectHeader
          object

          Headers of CONNECT requests to the proxy.

          Header names are mapped to lists of values.

        • spec.webhook.httpConfig.proxyFromEnvironment
          boolean
          Use the proxy parameters from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
        • spec.webhook.httpConfig.proxyUrl
          string
          URL of the HTTP proxy for webhook requests.
        • spec.webhook.httpConfig.tlsConfig
          object
          TLS settings for requests to the webhook URL.
          • spec.webhook.httpConfig.tlsConfig.caFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.webhook.httpConfig.tlsConfig.certFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.webhook.httpConfig.tlsConfig.insecureSkipVerify
            boolean
            Disable verification of the server TLS certificate.
          • spec.webhook.httpConfig.tlsConfig.keyFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.webhook.httpConfig.tlsConfig.maxVersion
            string
            Maximum TLS version.
          • spec.webhook.httpConfig.tlsConfig.minVersion
            string
            Minimum TLS version.
          • spec.webhook.httpConfig.tlsConfig.serverName
            string
            Server name for TLS certificate verification (SNI).
      • spec.webhook.url
        string

        Required value

        Webhook URL.

        The module sends notifications to this URL as JSON in the Alertmanager webhook format.

        Minimum length: 1

    • spec.zabbix
      object
      Parameters of the Zabbix channel.
      • spec.zabbix.api
        object

        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.

        • spec.zabbix.api.tlsConfig
          object

          TLS settings of the HTTPS connection to the Zabbix API.

          Certificates and keys are given inline as PEM.

          • spec.zabbix.api.tlsConfig.ca
            string
            PEM-encoded CA certificate(s) used to verify the Zabbix API server certificate. If unset, the system trust store is used.
          • spec.zabbix.api.tlsConfig.caFile
            Deprecated
            string
            Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into ca instead.
          • spec.zabbix.api.tlsConfig.cert
            string
            PEM-encoded client certificate, for an API behind mutual TLS. Must be set together with key.
          • spec.zabbix.api.tlsConfig.certFile
            Deprecated
            string
            Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into cert instead.
          • spec.zabbix.api.tlsConfig.insecureSkipVerify
            boolean
            Disable verification of the Zabbix API server TLS certificate.
          • spec.zabbix.api.tlsConfig.key
            string
            PEM-encoded unencrypted private key for cert. Must be set together with cert.
          • spec.zabbix.api.tlsConfig.keyFile
            Deprecated
            string
            Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into key instead.
          • spec.zabbix.api.tlsConfig.serverName
            string
            Server name used for TLS certificate verification (SNI). Defaults to the host of url.
        • spec.zabbix.api.token
          string

          Required value

          Zabbix API token used to authenticate configuration.import calls.

          Minimum length: 1

        • spec.zabbix.api.url
          string

          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

      • spec.zabbix.clusterName
        string

        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

      • spec.zabbix.disableTLS
        boolean

        Connect to the trapper port without TLS.

        If the parameter is disabled, the connection uses TLS with the settings from tls. If tls is omitted, the certificate is verified.

        Default: false

      • spec.zabbix.hostGroup
        string
        Zabbix host group that the cluster host is added to.

        Default: Deckhouse

      • spec.zabbix.port
        integer
        Trapper port of the Zabbix Server or Zabbix Proxy.

        Default: 10051

      • spec.zabbix.server
        string

        Required value

        Address of the Zabbix Server or Zabbix Proxy that receives trapper data.

        Minimum length: 1

      • spec.zabbix.tls
        object

        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: cert and key are mandatory for it. Zabbix PSK mode is not supported.

        • spec.zabbix.tls.ca
          string
          PEM-encoded CA certificate(s) used to verify the Zabbix Server/Proxy certificate. If unset, the system trust store is used.
        • spec.zabbix.tls.caFile
          Deprecated
          string
          Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into ca instead.
        • spec.zabbix.tls.cert
          string
          PEM-encoded client certificate presented to the Zabbix Server/Proxy. Must be set together with key.
        • spec.zabbix.tls.certFile
          Deprecated
          string
          Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into cert instead.
        • spec.zabbix.tls.insecureSkipVerify
          boolean
          Disable verification of the Zabbix server TLS certificate entirely. Does not lift the client certificate requirement of Zabbix certificate mode.
        • spec.zabbix.tls.key
          string
          PEM-encoded unencrypted private key for cert. Must be set together with cert.
        • spec.zabbix.tls.keyFile
          Deprecated
          string
          Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into key instead.
        • spec.zabbix.tls.serverName
          string
          Server name used for TLS certificate verification (SNI). Defaults to spec.zabbix.server.
        • spec.zabbix.tls.skipServerNameVerification
          boolean

          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 when insecureSkipVerify is true.

  • status
    object
    Status of the notification channel, including which policies are using it.
    • status.policies
      array of objects
      List of notification policies that are using this channel across all namespaces.
      • status.policies.name
        string
        Name of the notification policy.
      • status.policies.namespace
        string

        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.

  • spec
    object
    Policy parameters.
    • spec.alert
      object

      Required value

      Alerts that the policy applies to.
      • spec.alert.groupByLabels
        array of strings

        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.

        • spec.alert.groupByLabels.Element of the array
          string
          Alert label name.
      • spec.alert.selector
        object

        Required value

        Selector of the alerts that the policy applies to.

        Set only one of the fields: matchLabels or matchExpressions.

        • spec.alert.selector.matchExpressions
          array of objects

          Set of expressions (conditions) for filtering alerts.

          The policy applies to an alert if the alert meets all of the conditions.

          • spec.alert.selector.matchExpressions.key
            string
            Alert label name.
          • spec.alert.selector.matchExpressions.operator
            string

            Comparison operator:

            • Equal: The label value equals value.
            • NotEqual: The label value differs from value.
            • Regex: The label value matches the value regular expression.
            • NotRegex: The label value does not match the value regular expression.

            Allowed values: Equal, NotEqual, Regex, NotRegex

          • spec.alert.selector.matchExpressions.value
            string
            Value or regular expression to compare the label value with.
        • spec.alert.selector.matchLabels
          object
          Labels and their values that an alert must have for the policy to apply to it.
    • spec.notification
      object

      Required value

      Notification parameters.
      • spec.notification.channel
        object

        Required value

        “Channel that receives the notifications.”
        • spec.notification.channel.kind
          string

          Required value

          Kind of the notification channel object.

          Default: ClusterObservabilityNotificationChannel

          Allowed values: ClusterObservabilityNotificationChannel

        • spec.notification.channel.name
          string

          Required value

          Name of the channel object.
        • spec.notification.channel.parameters
          object

          Required value

          Notification channel parameters.
      • spec.notification.repeatInterval
        string

        Required value

        Interval for resending the notification about an alert.

        Default: 1m

  • status
    object
    Notification policy state.
    • status.description
      string
      Reason why the module does not apply the policy.
    • status.state
      string

      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 or parameters do not match the channel type. The reason is in the description field.

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.

  • spec
    object
    Silence parameters.
    • spec.endsAt
      string

      Required value

      Time when the silence ends.
    • spec.selector
      object

      Required value

      Selector of the alerts whose notifications are silenced.

      Set only one of the fields: matchLabels or matchExpressions.

      • spec.selector.matchExpressions
        array of objects

        Set of expressions (conditions) for filtering alerts.

        Notifications about an alert are silenced if the alert meets all of the conditions.

        • spec.selector.matchExpressions.key
          string
          Alert label name.
        • spec.selector.matchExpressions.operator
          string

          Comparison operator:

          • Equal: The label value equals value.
          • NotEqual: The label value differs from value.
          • Regex: The label value matches the value regular expression.
          • NotRegex: The label value does not match the value regular expression.

          Allowed values: Equal, NotEqual, Regex, NotRegex

        • spec.selector.matchExpressions.value
          string
          Value or regular expression to compare the label value with.
      • spec.selector.matchLabels
        object
        Labels and their values that an alert must have for its notifications to be silenced.
    • spec.startsAt
      string

      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.
  • spec
    object
    • spec.definition
      string

      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.

  • spec
    object
    Propagated rule group parameters.
    • spec.interval
      string

      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)?)$

    • spec.rules
      array of objects

      Required value

      List of alerting and recording rules of the group.
      • spec.rules.alert
        string

        Name of the alerting rule.

        Only one of the fields can be specified at the same time: alert or record.

        Pattern: ^[a-zA-Z-:][a-zA-Z0-9-:]*$

      • spec.rules.annotations
        object

        Annotations to attach to the alert.

        Applies only to alerting rules.

      • spec.rules.expr
        integer or string

        PromQL expression to evaluate the rule.

        Propagated rules aren’t restricted by namespaces.

      • spec.rules.for
        string

        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)?)$

      • spec.rules.keep_firing_for
        string

        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)?)$

      • spec.rules.labels
        object
        Additional labels to attach to the alert or recording rule.
      • spec.rules.record
        string

        Name of the recording rule.

        Only one of the fields can be specified at the same time: alert or record.

        Pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]*$

  • status
    object
    State of the cluster rules group.
    • status.conditions
      array of objects
      The latest available observed state of the propagated rules group.
      • status.conditions.lastTransitionTime
        string
        Last time the condition transitioned from one status to another.
      • status.conditions.message
        string
        Human-readable message indicating details about last transition.
      • status.conditions.reason
        string

        Reason for the condition’s last transition.

        Specified in one word in CamelCase format.

      • status.conditions.status
        string

        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

      • status.conditions.type
        string

        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

    • status.lastSyncTime
      string

      Last time the propagated rules group was successfully synced, which changed its PrometheusRule or its status.

      Not refreshed when a sync changes nothing.

    • status.prometheusRuleName
      string
      Name 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.

  • spec
    object

    Channel parameters.

    Set type and the section with the parameters of this type, for example, type: Email and email.

    • spec.email
      object
      Parameters of the Email channel.
      • spec.email.from
        string

        Required value

        Sender email address.
      • spec.email.smtp
        object

        Required value

        Parameters of the SMTP server that sends the emails.
        • spec.email.smtp.address
          string

          Required value

          Address of the SMTP server in the host:port format, for example, smtp.example.com:587.
        • spec.email.smtp.auth
          object
          Credentials for authentication on the SMTP server.
          • spec.email.smtp.auth.password
            string

            Required value

            Password.
          • spec.email.smtp.auth.username
            string

            Required value

            Username.
        • spec.email.smtp.requireTLS
          boolean
          Whether TLS verification is required.
      • spec.email.template
        string
        Email template.
    • spec.expressMessenger
      object
      Parameters of the ExpressMessenger channel.
      • spec.expressMessenger.apiUrl
        string

        Required value

        URL of the eXpress CTS server, for example, https://cts.company.ru.
      • spec.expressMessenger.botId
        string

        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}$

      • spec.expressMessenger.secretKey
        string

        Required value

        Secret key of the bot for authentication (JWT v2).
      • spec.expressMessenger.template
        string
        Message template.
    • spec.slack
      object
      Parameters of the Slack channel.
      • spec.slack.apiUrl
        string

        Required value

        Slack API URL.
      • spec.slack.color
        string
        Color of the message attachment.
      • spec.slack.fallback
        string
        Fallback text of the message.
      • string
        Footer of the message.
      • spec.slack.iconEmoji
        string
        Emoji for the message.
      • spec.slack.iconUrl
        string
        URL of the icon image in the message.
      • spec.slack.pretext
        string
        Text above the main block of the message.
      • spec.slack.template
        string
        Message template.
      • spec.slack.text
        string
        Main text of the message.
      • spec.slack.title
        string
        Title of the message.
      • string
        URL that the title links to.
      • spec.slack.username
        string
        Name of the message sender.
    • spec.telegram
      object
      Parameters of the Telegram channel.
      • spec.telegram.apiToken
        string

        Required value

        API token of the Telegram bot that sends the notifications.
      • spec.telegram.apiUrl
        string
        Telegram Bot API URL.

        Default: https://api.telegram.org

      • spec.telegram.httpConfig
        object

        HTTP client parameters for requests to the Telegram API.

        Use proxyUrl or proxyFromEnvironment if the Telegram API is reachable only through a proxy.

        Set only one of the basicAuth, authorization and oauth2 parameters.

        • spec.telegram.httpConfig.authorization
          object
          Value of the Authorization header.
          • spec.telegram.httpConfig.authorization.credentials
            string
            Credentials inserted into the Authorization header.
          • spec.telegram.httpConfig.authorization.credentialsFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use credentials.

          • spec.telegram.httpConfig.authorization.type
            string

            Authentication scheme, for example, Bearer.

            If the parameter is omitted, Bearer is used.

        • spec.telegram.httpConfig.basicAuth
          object
          HTTP Basic authentication.
          • spec.telegram.httpConfig.basicAuth.password
            string
            Password.
          • spec.telegram.httpConfig.basicAuth.passwordFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use password.

          • spec.telegram.httpConfig.basicAuth.username
            string
            Username.
        • spec.telegram.httpConfig.enableHttp2
          boolean
          Enable HTTP/2 support.
        • spec.telegram.httpConfig.followRedirects
          boolean

          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.

        • spec.telegram.httpConfig.httpHeaders
          object

          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.

          • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings

              Deprecated and ignored for security reasons.

              File contents are not inserted into request headers. Use values or secrets.

            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
              Header values read from secrets.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
              Header values.
        • spec.telegram.httpConfig.noProxy
          string
          Comma-separated list of hosts for which the proxy is not used.
        • spec.telegram.httpConfig.oauth2
          object
          OAuth 2.0 authentication.
          • spec.telegram.httpConfig.oauth2.clientId
            string

            Required value

            OAuth 2.0 client ID.
          • spec.telegram.httpConfig.oauth2.clientSecret
            string
            OAuth 2.0 client secret.
          • spec.telegram.httpConfig.oauth2.clientSecretFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use clientSecret.

          • spec.telegram.httpConfig.oauth2.endpointParams
            object
            Additional parameters passed in the token request.
          • spec.telegram.httpConfig.oauth2.noProxy
            string
            Comma-separated list of hosts for which the proxy is not used.
          • spec.telegram.httpConfig.oauth2.proxyFromEnvironment
            boolean
            Use the proxy from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
          • spec.telegram.httpConfig.oauth2.proxyUrl
            string
            URL of the HTTP proxy used for the token request.
          • spec.telegram.httpConfig.oauth2.scopes
            array of strings
            Scopes requested for the token.
            • spec.telegram.httpConfig.oauth2.scopes.Element of the array
              string
              Scope name.
          • spec.telegram.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.telegram.httpConfig.oauth2.tlsConfig.caFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.telegram.httpConfig.oauth2.tlsConfig.certFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
              Disable verification of the server TLS certificate.
            • spec.telegram.httpConfig.oauth2.tlsConfig.keyFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.telegram.httpConfig.oauth2.tlsConfig.maxVersion
              string
              Maximum TLS version.
            • spec.telegram.httpConfig.oauth2.tlsConfig.minVersion
              string
              Minimum TLS version.
            • spec.telegram.httpConfig.oauth2.tlsConfig.serverName
              string
              Server name for TLS certificate verification (SNI).
          • spec.telegram.httpConfig.oauth2.tokenUrl
            string

            Required value

            URL of the token endpoint.
        • spec.telegram.httpConfig.proxyConnectHeader
          object

          Headers of CONNECT requests to the proxy.

          Header names are mapped to lists of values.

        • spec.telegram.httpConfig.proxyFromEnvironment
          boolean
          Use the proxy from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
        • spec.telegram.httpConfig.proxyUrl
          string
          URL of the HTTP proxy for requests to the Telegram API.
        • spec.telegram.httpConfig.tlsConfig
          object
          TLS settings for the HTTP client of the Telegram receiver.
          • spec.telegram.httpConfig.tlsConfig.caFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.telegram.httpConfig.tlsConfig.certFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.telegram.httpConfig.tlsConfig.insecureSkipVerify
            boolean
            Disable verification of the server TLS certificate.
          • spec.telegram.httpConfig.tlsConfig.keyFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.telegram.httpConfig.tlsConfig.maxVersion
            string
            Maximum TLS version.
          • spec.telegram.httpConfig.tlsConfig.minVersion
            string
            Minimum TLS version.
          • spec.telegram.httpConfig.tlsConfig.serverName
            string
            Server name for TLS certificate verification (SNI).
      • spec.telegram.template
        string
        Message template.
    • spec.type
      string

      Required value

      Notification channel type.

      Allowed values: Email, Slack, Telegram, Webhook, ExpressMessenger, Zabbix

    • spec.webhook
      object
      Parameters of the Webhook channel.
      • spec.webhook.httpConfig
        object

        HTTP client parameters for requests to the webhook URL.

        Set only one of the basicAuth, authorization and oauth2 parameters.

        • spec.webhook.httpConfig.authorization
          object
          Value of the Authorization header.
          • spec.webhook.httpConfig.authorization.credentials
            string
            Credentials inserted into the Authorization header.
          • spec.webhook.httpConfig.authorization.credentialsFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use credentials.

          • spec.webhook.httpConfig.authorization.type
            string

            Authentication scheme, for example, Bearer.

            If the parameter is omitted, Bearer is used.

        • spec.webhook.httpConfig.basicAuth
          object
          HTTP Basic authentication.
          • spec.webhook.httpConfig.basicAuth.password
            string
            Password.
          • spec.webhook.httpConfig.basicAuth.passwordFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use password.

          • spec.webhook.httpConfig.basicAuth.username
            string
            Username.
        • spec.webhook.httpConfig.enableHttp2
          boolean
          Enable HTTP/2 support for webhook requests.
        • spec.webhook.httpConfig.followRedirects
          boolean

          Deprecated and ignored for security reasons.

          The module does not follow HTTP redirects.

        • spec.webhook.httpConfig.httpHeaders
          object

          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.

          • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings

              Deprecated and ignored for security reasons.

              File contents are not inserted into request headers. Use values or secrets.

            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
              Header values read from secrets.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
              Header values.
        • spec.webhook.httpConfig.noProxy
          string
          Comma-separated list of hosts that are accessed without the proxy.
        • spec.webhook.httpConfig.oauth2
          object
          OAuth 2.0 authentication.
          • spec.webhook.httpConfig.oauth2.clientId
            string

            Required value

            OAuth 2.0 client ID.
          • spec.webhook.httpConfig.oauth2.clientSecret
            string
            OAuth 2.0 client secret.
          • spec.webhook.httpConfig.oauth2.clientSecretFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use clientSecret.

          • spec.webhook.httpConfig.oauth2.endpointParams
            object
            Additional parameters passed in the token request.
          • spec.webhook.httpConfig.oauth2.noProxy
            string
            Comma-separated list of hosts for which the proxy is not used.
          • spec.webhook.httpConfig.oauth2.proxyFromEnvironment
            boolean
            Use the proxy from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
          • spec.webhook.httpConfig.oauth2.proxyUrl
            string
            URL of the HTTP proxy used for the token request.
          • spec.webhook.httpConfig.oauth2.scopes
            array of strings
            Scopes requested for the token.
            • spec.webhook.httpConfig.oauth2.scopes.Element of the array
              string
              Scope name.
          • spec.webhook.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.webhook.httpConfig.oauth2.tlsConfig.caFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.webhook.httpConfig.oauth2.tlsConfig.certFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
              Disable verification of the server TLS certificate.
            • spec.webhook.httpConfig.oauth2.tlsConfig.keyFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.webhook.httpConfig.oauth2.tlsConfig.maxVersion
              string
              Maximum TLS version.
            • spec.webhook.httpConfig.oauth2.tlsConfig.minVersion
              string
              Minimum TLS version.
            • spec.webhook.httpConfig.oauth2.tlsConfig.serverName
              string
              Server name for TLS certificate verification (SNI).
          • spec.webhook.httpConfig.oauth2.tokenUrl
            string

            Required value

            URL of the token endpoint.
        • spec.webhook.httpConfig.proxyConnectHeader
          object

          Headers of CONNECT requests to the proxy.

          Header names are mapped to lists of values.

        • spec.webhook.httpConfig.proxyFromEnvironment
          boolean
          Use the proxy parameters from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
        • spec.webhook.httpConfig.proxyUrl
          string
          URL of the HTTP proxy for webhook requests.
        • spec.webhook.httpConfig.tlsConfig
          object
          TLS settings for requests to the webhook URL.
          • spec.webhook.httpConfig.tlsConfig.caFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.webhook.httpConfig.tlsConfig.certFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.webhook.httpConfig.tlsConfig.insecureSkipVerify
            boolean
            Disable verification of the server TLS certificate.
          • spec.webhook.httpConfig.tlsConfig.keyFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.webhook.httpConfig.tlsConfig.maxVersion
            string
            Maximum TLS version.
          • spec.webhook.httpConfig.tlsConfig.minVersion
            string
            Minimum TLS version.
          • spec.webhook.httpConfig.tlsConfig.serverName
            string
            Server name for TLS certificate verification (SNI).
      • spec.webhook.url
        string

        Required value

        Webhook URL.

        The module sends notifications to this URL as JSON in the Alertmanager webhook format.

        Minimum length: 1

    • spec.zabbix
      object
      Parameters of the Zabbix channel.
      • spec.zabbix.api
        object

        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.

        • spec.zabbix.api.tlsConfig
          object
          TLS settings of the HTTPS connection to the Zabbix API. Certificates and keys are given inline as PEM.
          • spec.zabbix.api.tlsConfig.ca
            string
            PEM-encoded CA certificate(s) used to verify the Zabbix API server certificate. If unset, the system trust store is used.
          • spec.zabbix.api.tlsConfig.caFile
            Deprecated
            string
            Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into ca instead.
          • spec.zabbix.api.tlsConfig.cert
            string
            PEM-encoded client certificate, for an API behind mutual TLS. Must be set together with key.
          • spec.zabbix.api.tlsConfig.certFile
            Deprecated
            string
            Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into cert instead.
          • spec.zabbix.api.tlsConfig.insecureSkipVerify
            boolean
            Disable verification of the Zabbix API server TLS certificate.
          • spec.zabbix.api.tlsConfig.key
            string
            PEM-encoded unencrypted private key for cert. Must be set together with cert.
          • spec.zabbix.api.tlsConfig.keyFile
            Deprecated
            string
            Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into key instead.
          • spec.zabbix.api.tlsConfig.serverName
            string
            Server name used for TLS certificate verification (SNI). Defaults to the host of url.
        • spec.zabbix.api.token
          string

          Required value

          Zabbix API token used to authenticate configuration.import calls.

          Minimum length: 1

        • spec.zabbix.api.url
          string

          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

      • spec.zabbix.clusterName
        string

        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

      • spec.zabbix.disableTLS
        boolean

        Connect to the trapper port without TLS.

        If the parameter is disabled, the connection uses TLS with the settings from tls. If tls is omitted, the certificate is verified.

        Default: false

      • spec.zabbix.hostGroup
        string
        Zabbix host group that the cluster host is added to.

        Default: Deckhouse

      • spec.zabbix.port
        integer
        Trapper port of the Zabbix Server or Zabbix Proxy.

        Default: 10051

      • spec.zabbix.server
        string

        Required value

        Address of the Zabbix Server or Zabbix Proxy that receives trapper data.

        Minimum length: 1

      • spec.zabbix.tls
        object

        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: cert and key are mandatory for it. Zabbix PSK mode is not supported.

        • spec.zabbix.tls.ca
          string
          PEM-encoded CA certificate(s) used to verify the Zabbix Server/Proxy certificate. If unset, the system trust store is used.
        • spec.zabbix.tls.caFile
          Deprecated
          string
          Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into ca instead.
        • spec.zabbix.tls.cert
          string
          PEM-encoded client certificate presented to the Zabbix Server/Proxy. Must be set together with key.
        • spec.zabbix.tls.certFile
          Deprecated
          string
          Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into cert instead.
        • spec.zabbix.tls.insecureSkipVerify
          boolean
          Disable verification of the Zabbix server TLS certificate entirely. Does not lift the client certificate requirement of Zabbix certificate mode.
        • spec.zabbix.tls.key
          string
          PEM-encoded unencrypted private key for cert. Must be set together with cert.
        • spec.zabbix.tls.keyFile
          Deprecated
          string
          Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into key instead.
        • spec.zabbix.tls.serverName
          string
          Server name used for TLS certificate verification (SNI). Defaults to spec.zabbix.server.
        • spec.zabbix.tls.skipServerNameVerification
          boolean

          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 when insecureSkipVerify is true.

  • status
    object
    Status of the notification channel, including which policies are using it.
    • status.policies
      array of objects
      List of notification policies that are using this channel across all namespaces.
      • status.policies.name
        string
        Name of the notification policy.
      • status.policies.namespace
        string

        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.

  • spec
    object
    Policy parameters.
    • spec.alert
      object

      Required value

      Alerts that the policy applies to.
      • spec.alert.groupByLabels
        array of strings

        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.

        • spec.alert.groupByLabels.Element of the array
          string
          Alert label name.
      • spec.alert.selector
        object

        Required value

        Selector of the alerts that the policy applies to.

        Set only one of the fields: matchLabels or matchExpressions.

        • spec.alert.selector.matchExpressions
          array of objects

          Set of expressions (conditions) for filtering alerts.

          The policy applies to an alert if the alert meets all of the conditions.

          • spec.alert.selector.matchExpressions.key
            string
            Alert label name.
          • spec.alert.selector.matchExpressions.operator
            string

            Comparison operator:

            • Equal: The label value equals value.
            • NotEqual: The label value differs from value.
            • Regex: The label value matches the value regular expression.
            • NotRegex: The label value does not match the value regular expression.

            Allowed values: Equal, NotEqual, Regex, NotRegex

          • spec.alert.selector.matchExpressions.value
            string
            Value or regular expression to compare the label value with.
        • spec.alert.selector.matchLabels
          object
          Labels and their values that an alert must have for the policy to apply to it.
    • spec.notification
      object

      Required value

      Notification parameters.
      • spec.notification.channel
        object

        Required value

        “Channel that receives the notifications.”
        • spec.notification.channel.kind
          string

          Required value

          Kind of the notification channel object.

          Default: ClusterObservabilityPropagatedNotificationChannel

          Allowed values: ClusterObservabilityPropagatedNotificationChannel

        • spec.notification.channel.name
          string

          Required value

          Name of the channel object.
        • spec.notification.channel.parameters
          object

          Required value

          Notification channel parameters.
      • spec.notification.repeatInterval
        string

        Required value

        Interval for resending the notification about an alert.

        Default: 1m

  • status
    object
    Notification policy state.
    • status.description
      string
      Reason why the module does not apply the policy.
    • status.state
      string

      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 or parameters do not match the channel type. The reason is in the description field.

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.
  • spec
    object
    • spec.definition
      string

      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.

  • spec
    object
    Parameters of a group of the log-based recording rules.
    • spec.interval
      string

      Rule evaluation interval.

      For example, 30s or 1m.

      If not specified, the default value is used.

      Default: 1m

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

    • spec.rules
      array of objects

      Required value

      List of log-based recording rules.
      • spec.rules.expr
        string

        LogQL expression to evaluate the recording rule.

        Do not use the namespace label in the expression. The module adds it automatically based on the resource namespace.

        Minimum length: 1

      • spec.rules.labels
        object

        Additional labels attached to the recorded metric series.

        The following labels are reserved and can’t be set by the user:

        • namespace
        • scope_type
        • created_by
        • rule_group_name
      • spec.rules.record
        string

        Name of the recording rule.

        Must comply with the Prometheus metric naming rules and be unique within the rule group.

        Minimum length: 1

        Pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]*$

ObservabilityMetricsRulesGroup

Short names: omrg

Scope: Namespaced
Version: v1alpha1

Group of alerting or recording rules for a single namespace.
  • spec
    object
    Rule group parameters.
    • spec.interval
      string

      Group rule evaluation interval.

      If not specified, the default interval is used.

      Default: 1m

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

    • spec.rules
      array of objects

      Required value

      List of alerting and recording rules of the group.
      • spec.rules.alert
        string

        Name of the alerting rule.

        Only one of the fields can be specified at the same time: alert or record.

        Pattern: ^[a-zA-Z-:][a-zA-Z0-9-:]*$

      • spec.rules.annotations
        object

        Annotations to attach to the alert.

        Applies only to alerting rules.

      • spec.rules.expr
        integer or string
        PromQL expression to evaluate the rule.
      • spec.rules.for
        string

        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)?)$

      • spec.rules.keep_firing_for
        string

        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)?)$

      • spec.rules.labels
        object
        Additional labels to attach to the alert or recording rule.
      • spec.rules.record
        string

        Name of the recording rule.

        Only one of the fields can be specified at the same time: alert or record.

        Pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]*$

  • status
    object
    Rule group state.
    • status.conditions
      array of objects
      The latest available observed state of the rules group.
      • status.conditions.lastTransitionTime
        string
        Last time the condition transitioned from one status to another.
      • status.conditions.message
        string
        Human-readable message indicating details about last transition.
      • status.conditions.reason
        string

        Reason for the condition’s last transition.

        Specified in one word in CamelCase format.

      • status.conditions.status
        string

        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

      • status.conditions.type
        string

        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

    • status.lastSyncTime
      string

      Last time the rules group was successfully synced, which changed its PrometheusRule or its status.

      Not refreshed when a sync changes nothing.

    • status.prometheusRuleName
      string
      Name 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.

  • spec
    object

    Channel parameters.

    Set type and the section with the parameters of this type, for example, type: Email and email.

    • spec.email
      object
      Parameters of the Email channel.
      • spec.email.from
        string

        Required value

        Sender email address.
      • spec.email.smtp
        object

        Required value

        Parameters of the SMTP server that sends the emails.
        • spec.email.smtp.address
          string

          Required value

          Address of the SMTP server in the host:port format, for example, smtp.example.com:587.
        • spec.email.smtp.auth
          object
          Credentials for authentication on the SMTP server.
          • spec.email.smtp.auth.password
            string

            Required value

            Password.
          • spec.email.smtp.auth.username
            string

            Required value

            Username.
        • spec.email.smtp.requireTLS
          boolean
          Whether TLS verification is required.
      • spec.email.template
        string
        Email template.
    • spec.expressMessenger
      object
      Parameters of the ExpressMessenger channel.
      • spec.expressMessenger.apiUrl
        string

        Required value

        URL of the eXpress CTS server, for example, https://cts.company.ru.
      • spec.expressMessenger.botId
        string

        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}$

      • spec.expressMessenger.secretKey
        string

        Required value

        Secret key of the bot for authentication (JWT v2).
      • spec.expressMessenger.template
        string
        Message template.
    • spec.slack
      object
      Parameters of the Slack channel.
      • spec.slack.apiUrl
        string

        Required value

        Slack API URL.
      • spec.slack.color
        string
        Color of the message attachment.
      • spec.slack.fallback
        string
        Fallback text of the message.
      • string
        Footer of the message.
      • spec.slack.iconEmoji
        string
        Emoji for the message.
      • spec.slack.iconUrl
        string
        URL of the icon image in the message.
      • spec.slack.pretext
        string
        Text above the main block of the message.
      • spec.slack.template
        string
        Message template.
      • spec.slack.text
        string
        Main text of the message.
      • spec.slack.title
        string
        Title of the message.
      • string
        URL that the title links to.
      • spec.slack.username
        string
        Name of the message sender.
    • spec.telegram
      object
      Parameters of the Telegram channel.
      • spec.telegram.apiToken
        string

        Required value

        API token of the Telegram bot that sends the notifications.
      • spec.telegram.apiUrl
        string
        Telegram Bot API URL.

        Default: https://api.telegram.org

      • spec.telegram.httpConfig
        object

        HTTP client parameters for requests to the Telegram API.

        Use proxyUrl or proxyFromEnvironment if the Telegram API is reachable only through a proxy.

        Set only one of the basicAuth, authorization and oauth2 parameters.

        • spec.telegram.httpConfig.authorization
          object
          Value of the Authorization header.
          • spec.telegram.httpConfig.authorization.credentials
            string
            Credentials inserted into the Authorization header.
          • spec.telegram.httpConfig.authorization.credentialsFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use credentials.

          • spec.telegram.httpConfig.authorization.type
            string

            Authentication scheme, for example, Bearer.

            If the parameter is omitted, Bearer is used.

        • spec.telegram.httpConfig.basicAuth
          object
          HTTP Basic authentication.
          • spec.telegram.httpConfig.basicAuth.password
            string
            Password.
          • spec.telegram.httpConfig.basicAuth.passwordFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use password.

          • spec.telegram.httpConfig.basicAuth.username
            string
            Username.
        • spec.telegram.httpConfig.enableHttp2
          boolean
          Enable HTTP/2 support.
        • spec.telegram.httpConfig.followRedirects
          boolean

          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.

        • spec.telegram.httpConfig.httpHeaders
          object

          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.

          • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings

              Deprecated and ignored for security reasons.

              File contents are not inserted into request headers. Use values or secrets.

            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
              Header values read from secrets.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
              Header values.
        • spec.telegram.httpConfig.noProxy
          string
          Comma-separated list of hosts for which the proxy is not used.
        • spec.telegram.httpConfig.oauth2
          object
          OAuth 2.0 authentication.
          • spec.telegram.httpConfig.oauth2.clientId
            string

            Required value

            OAuth 2.0 client ID.
          • spec.telegram.httpConfig.oauth2.clientSecret
            string
            OAuth 2.0 client secret.
          • spec.telegram.httpConfig.oauth2.clientSecretFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use clientSecret.

          • spec.telegram.httpConfig.oauth2.endpointParams
            object
            Additional parameters passed in the token request.
          • spec.telegram.httpConfig.oauth2.noProxy
            string
            Comma-separated list of hosts for which the proxy is not used.
          • spec.telegram.httpConfig.oauth2.proxyFromEnvironment
            boolean
            Use the proxy from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
          • spec.telegram.httpConfig.oauth2.proxyUrl
            string
            URL of the HTTP proxy used for the token request.
          • spec.telegram.httpConfig.oauth2.scopes
            array of strings
            Scopes requested for the token.
            • spec.telegram.httpConfig.oauth2.scopes.Element of the array
              string
              Scope name.
          • spec.telegram.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.telegram.httpConfig.oauth2.tlsConfig.caFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.telegram.httpConfig.oauth2.tlsConfig.certFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
              Disable verification of the server TLS certificate.
            • spec.telegram.httpConfig.oauth2.tlsConfig.keyFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.telegram.httpConfig.oauth2.tlsConfig.maxVersion
              string
              Maximum TLS version.
            • spec.telegram.httpConfig.oauth2.tlsConfig.minVersion
              string
              Minimum TLS version.
            • spec.telegram.httpConfig.oauth2.tlsConfig.serverName
              string
              Server name for TLS certificate verification (SNI).
          • spec.telegram.httpConfig.oauth2.tokenUrl
            string

            Required value

            URL of the token endpoint.
        • spec.telegram.httpConfig.proxyConnectHeader
          object

          Headers of CONNECT requests to the proxy.

          Header names are mapped to lists of values.

        • spec.telegram.httpConfig.proxyFromEnvironment
          boolean
          Use the proxy from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
        • spec.telegram.httpConfig.proxyUrl
          string
          URL of the HTTP proxy for requests to the Telegram API.
        • spec.telegram.httpConfig.tlsConfig
          object
          TLS settings for the HTTP client of the Telegram receiver.
          • spec.telegram.httpConfig.tlsConfig.caFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.telegram.httpConfig.tlsConfig.certFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.telegram.httpConfig.tlsConfig.insecureSkipVerify
            boolean
            Disable verification of the server TLS certificate.
          • spec.telegram.httpConfig.tlsConfig.keyFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.telegram.httpConfig.tlsConfig.maxVersion
            string
            Maximum TLS version.
          • spec.telegram.httpConfig.tlsConfig.minVersion
            string
            Minimum TLS version.
          • spec.telegram.httpConfig.tlsConfig.serverName
            string
            Server name for TLS certificate verification (SNI).
      • spec.telegram.template
        string
        Message template.
    • spec.type
      string

      Required value

      Notification channel type.

      Allowed values: Email, Slack, Telegram, Webhook, ExpressMessenger, Zabbix

    • spec.webhook
      object
      Parameters of the Webhook channel.
      • spec.webhook.httpConfig
        object

        HTTP client parameters for requests to the webhook URL.

        Set only one of the basicAuth, authorization and oauth2 parameters.

        • spec.webhook.httpConfig.authorization
          object
          Value of the Authorization header.
          • spec.webhook.httpConfig.authorization.credentials
            string
            Credentials inserted into the Authorization header.
          • spec.webhook.httpConfig.authorization.credentialsFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use credentials.

          • spec.webhook.httpConfig.authorization.type
            string

            Authentication scheme, for example, Bearer.

            If the parameter is omitted, Bearer is used.

        • spec.webhook.httpConfig.basicAuth
          object
          HTTP Basic authentication.
          • spec.webhook.httpConfig.basicAuth.password
            string
            Password.
          • spec.webhook.httpConfig.basicAuth.passwordFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use password.

          • spec.webhook.httpConfig.basicAuth.username
            string
            Username.
        • spec.webhook.httpConfig.enableHttp2
          boolean
          Enable HTTP/2 support for webhook requests.
        • spec.webhook.httpConfig.followRedirects
          boolean

          Deprecated and ignored for security reasons.

          The module does not follow HTTP redirects.

        • spec.webhook.httpConfig.httpHeaders
          object

          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.

          • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container. Use values or secrets.

            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
              Header values read from secrets.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
              Header values.
        • spec.webhook.httpConfig.noProxy
          string
          Comma-separated list of hosts that are accessed without the proxy.
        • spec.webhook.httpConfig.oauth2
          object
          OAuth 2.0 authentication.
          • spec.webhook.httpConfig.oauth2.clientId
            string

            Required value

            OAuth 2.0 client ID.
          • spec.webhook.httpConfig.oauth2.clientSecret
            string
            OAuth 2.0 client secret.
          • spec.webhook.httpConfig.oauth2.clientSecretFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container. Use clientSecret.

          • spec.webhook.httpConfig.oauth2.endpointParams
            object
            Additional parameters passed in the token request.
          • spec.webhook.httpConfig.oauth2.noProxy
            string
            Comma-separated list of hosts for which the proxy is not used.
          • spec.webhook.httpConfig.oauth2.proxyFromEnvironment
            boolean
            Use the proxy from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
          • spec.webhook.httpConfig.oauth2.proxyUrl
            string
            URL of the HTTP proxy used for the token request.
          • spec.webhook.httpConfig.oauth2.scopes
            array of strings
            Scopes requested for the token.
            • spec.webhook.httpConfig.oauth2.scopes.Element of the array
              string
              Scope name.
          • spec.webhook.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.webhook.httpConfig.oauth2.tlsConfig.caFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.webhook.httpConfig.oauth2.tlsConfig.certFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
              Disable verification of the server TLS certificate.
            • spec.webhook.httpConfig.oauth2.tlsConfig.keyFile
              string

              Deprecated and ignored for security reasons.

              The module does not read files from the Alertmanager container.

            • spec.webhook.httpConfig.oauth2.tlsConfig.maxVersion
              string
              Maximum TLS version.
            • spec.webhook.httpConfig.oauth2.tlsConfig.minVersion
              string
              Minimum TLS version.
            • spec.webhook.httpConfig.oauth2.tlsConfig.serverName
              string
              Server name for TLS certificate verification (SNI).
          • spec.webhook.httpConfig.oauth2.tokenUrl
            string

            Required value

            URL of the token endpoint.
        • spec.webhook.httpConfig.proxyConnectHeader
          object

          Headers of CONNECT requests to the proxy.

          Header names are mapped to lists of values.

        • spec.webhook.httpConfig.proxyFromEnvironment
          boolean
          Use the proxy parameters from the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
        • spec.webhook.httpConfig.proxyUrl
          string
          URL of the HTTP proxy for webhook requests.
        • spec.webhook.httpConfig.tlsConfig
          object
          TLS settings for requests to the webhook URL.
          • spec.webhook.httpConfig.tlsConfig.caFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.webhook.httpConfig.tlsConfig.certFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.webhook.httpConfig.tlsConfig.insecureSkipVerify
            boolean
            Disable verification of the server TLS certificate.
          • spec.webhook.httpConfig.tlsConfig.keyFile
            string

            Deprecated and ignored for security reasons.

            The module does not read files from the Alertmanager container.

          • spec.webhook.httpConfig.tlsConfig.maxVersion
            string
            Maximum TLS version.
          • spec.webhook.httpConfig.tlsConfig.minVersion
            string
            Minimum TLS version.
          • spec.webhook.httpConfig.tlsConfig.serverName
            string
            Server name for TLS certificate verification (SNI).
      • spec.webhook.url
        string

        Required value

        Webhook URL.

        The module sends notifications to this URL as JSON in the Alertmanager webhook format.

        Minimum length: 1

    • spec.zabbix
      object
      Parameters of the Zabbix channel.
      • spec.zabbix.api
        object

        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.

        • spec.zabbix.api.tlsConfig
          object
          TLS settings for the HTTPS connection to the Zabbix API. Certificates and keys are given inline as PEM.
          • spec.zabbix.api.tlsConfig.ca
            string
            PEM-encoded CA certificate(s) used to verify the Zabbix API server certificate. If unset, the system trust store is used.
          • spec.zabbix.api.tlsConfig.caFile
            Deprecated
            string
            Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into ca instead.
          • spec.zabbix.api.tlsConfig.cert
            string
            PEM-encoded client certificate, for an API behind mutual TLS. Must be set together with key.
          • spec.zabbix.api.tlsConfig.certFile
            Deprecated
            string
            Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into cert instead.
          • spec.zabbix.api.tlsConfig.insecureSkipVerify
            boolean
            Disable verification of the Zabbix API server TLS certificate.
          • spec.zabbix.api.tlsConfig.key
            string
            PEM-encoded unencrypted private key for cert. Must be set together with cert.
          • spec.zabbix.api.tlsConfig.keyFile
            Deprecated
            string
            Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into key instead.
          • spec.zabbix.api.tlsConfig.serverName
            string
            Server name used for TLS certificate verification (SNI). Defaults to the host of url.
        • spec.zabbix.api.token
          string

          Required value

          Zabbix API token used to authenticate configuration.import calls.

          Minimum length: 1

        • spec.zabbix.api.url
          string

          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

      • spec.zabbix.clusterName
        string

        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

      • spec.zabbix.disableTLS
        boolean

        Connect to the trapper port without TLS.

        If the parameter is disabled, the connection uses TLS with the settings from tls. If tls is omitted, the certificate is verified.

        Default: false

      • spec.zabbix.hostGroup
        string
        Zabbix host group that the cluster host is added to.

        Default: Deckhouse

      • spec.zabbix.port
        integer
        Trapper port of the Zabbix Server or Zabbix Proxy.

        Default: 10051

      • spec.zabbix.server
        string

        Required value

        Address of the Zabbix Server or Zabbix Proxy that receives trapper data.

        Minimum length: 1

      • spec.zabbix.tls
        object

        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: cert and key are mandatory for it. Zabbix PSK mode is not supported.

        • spec.zabbix.tls.ca
          string
          PEM-encoded CA certificate(s) used to verify the Zabbix Server/Proxy certificate. If unset, the system trust store is used.
        • spec.zabbix.tls.caFile
          Deprecated
          string
          Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into ca instead.
        • spec.zabbix.tls.cert
          string
          PEM-encoded client certificate presented to the Zabbix Server/Proxy. Must be set together with key.
        • spec.zabbix.tls.certFile
          Deprecated
          string
          Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into cert instead.
        • spec.zabbix.tls.insecureSkipVerify
          boolean
          Disable verification of the Zabbix server TLS certificate entirely. Does not lift the client certificate requirement of Zabbix certificate mode.
        • spec.zabbix.tls.key
          string
          PEM-encoded unencrypted private key for cert. Must be set together with cert.
        • spec.zabbix.tls.keyFile
          Deprecated
          string
          Deprecated and ignored for security reasons: this filesystem path is no longer read. Put the PEM content into key instead.
        • spec.zabbix.tls.serverName
          string
          Server name used for TLS certificate verification (SNI). Defaults to spec.zabbix.server.
        • spec.zabbix.tls.skipServerNameVerification
          boolean

          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 when insecureSkipVerify is true.

  • status
    object
    Status of the notification channel, including which policies are using it.
    • status.policies
      array of strings
      List of ObservabilityNotificationPolicy objects using this channel.
      • status.policies.Element of the array
        string
        Name 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.

  • spec
    object
    Policy parameters.
    • spec.alert
      object

      Required value

      Alerts that the policy applies to.
      • spec.alert.groupByLabels
        array of strings

        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.

        • spec.alert.groupByLabels.Element of the array
          string
          Alert label name.
      • spec.alert.selector
        object

        Required value

        Selector of the alerts that the policy applies to.

        Set only one of the fields: matchLabels or matchExpressions.

        • spec.alert.selector.matchExpressions
          array of objects

          Set of expressions (conditions) for filtering alerts.

          The policy applies to an alert if the alert meets all of the conditions.

          • spec.alert.selector.matchExpressions.key
            string
            Alert label name.
          • spec.alert.selector.matchExpressions.operator
            string

            Comparison operator:

            • Equal: The label value equals value.
            • NotEqual: The label value differs from value.
            • Regex: The label value matches the value regular expression.
            • NotRegex: The label value does not match the value regular expression.

            Allowed values: Equal, NotEqual, Regex, NotRegex

          • spec.alert.selector.matchExpressions.value
            string
            Value or regular expression to compare the label value with.
        • spec.alert.selector.matchLabels
          object
          Labels and their values that an alert must have for the policy to apply to it.
    • spec.notification
      object

      Required value

      Notification parameters.
      • spec.notification.channel
        object

        Required value

        Channel that receives the notifications.
        • spec.notification.channel.kind
          string

          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: ObservabilityNotificationChannel

          Allowed values: ClusterObservabilityPropagatedNotificationChannel, ObservabilityNotificationChannel

        • spec.notification.channel.name
          string

          Required value

          Name of the channel object.
        • spec.notification.channel.parameters
          object

          Required value

          Notification channel parameters.
      • spec.notification.repeatInterval
        string

        Required value

        Interval for resending the notification about an alert.

        Default: 1m

  • status
    object
    Notification policy state.
    • status.description
      string
      Reason why the module does not apply the policy.
    • status.state
      string

      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 or parameters do not match the channel type. The reason is in the description field.

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.

  • spec
    object
    Silence parameters.
    • spec.endsAt
      string

      Required value

      Time when the silence ends.
    • spec.selector
      object

      Required value

      Selector of the alerts whose notifications are silenced.

      Set only one of the fields: matchLabels or matchExpressions.

      • spec.selector.matchExpressions
        array of objects

        Set of expressions (conditions) for filtering alerts.

        Notifications about an alert are silenced if the alert meets all of the conditions.

        • spec.selector.matchExpressions.key
          string
          Alert label name.
        • spec.selector.matchExpressions.operator
          string

          Comparison operator:

          • Equal: The label value equals value.
          • NotEqual: The label value differs from value.
          • Regex: The label value matches the value regular expression.
          • NotRegex: The label value does not match the value regular expression.

          Allowed values: Equal, NotEqual, Regex, NotRegex

        • spec.selector.matchExpressions.value
          string
          Value or regular expression to compare the label value with.
      • spec.selector.matchLabels
        object
        Labels and their values that an alert must have for its notifications to be silenced.
    • spec.startsAt
      string

      Required value

      Time when the silence starts.