Стадия жизненного цикла модуля: Общедоступная версия

У модуля есть требования для установки

Deckhouse Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.

ClusterLog

Область: Cluster
Версия: v1alpha1

Cluster-wide-ресурс, используемый в RBAC для разграничения доступа к логам.

ClusterObservabilityAlertAdditionalLabels

Короткие имена: coalabels

Область: Cluster
Версия: v1alpha1

Дополнительные лейблы, которые модуль добавляет к алертам, поставляемым с Deckhouse Platform.

Если у алерта уже есть лейбл с таким ключом, его значение не изменяется.

Внимание. Дополнительные лейблы применяются только к алертам, созданным с помощью ресурсов с лейблом heritage: deckhouse.

  • spec
    объект
    • spec.additionalLabels
      объект

      Обязательный параметр

      Дополнительные лейблы, которые будут добавлены к каждому соответствующему алерту.

      Если у алерта уже есть лейбл с таким ключом, его значение не изменяется.

    • spec.alertSelector
      объект

      Обязательный параметр

      Селектор алертов, к которым добавляются лейблы.

      Селектор проверяется по лейблам, заданным в правиле, и лейблу alertname с именем алерта.

      • spec.alertSelector.matchExpressions
        массив объектов

        Обязательный параметр

        Список требований к лейблам.

        Все требования должны быть выполнены.

        • spec.alertSelector.matchExpressions.key
          строка
          Имя лейбла, значение которого проверяется.
        • spec.alertSelector.matchExpressions.operator
          строка

          Оператор сравнения:

          • In — лейбл есть, и его значение входит в values;
          • NotIn — лейбла нет, или его значение не входит в values;
          • Exists — лейбл есть;
          • DoesNotExist — лейбла нет.

          Допустимые значения: In, NotIn, Exists, DoesNotExist

        • spec.alertSelector.matchExpressions.values
          массив строк
          Значения лейбла для операторов In и NotIn.
      • spec.alertSelector.matchLabels
        объект
        Точные пары ключ-значение, которые должны быть у алерта, чтобы к нему добавились лейблы.

ClusterObservabilityDashboard

Область: Cluster
Версия: v1alpha1

Дашборд уровня кластера, отображаемый в веб-интерфейсе Deckhouse.

Чтобы настроить отображение дашборда, используйте следующие аннотации:

  • metadata.deckhouse.io/category — папка (категория) дашборда в интерфейсе;
  • metadata.deckhouse.io/title — название дашборда в интерфейсе. Если аннотация не указана, модуль использует название из JSON-манифеста.
  • spec
    объект
    • spec.definition
      строка

      Обязательный параметр

      JSON-манифест дашборда в виде строки, совместимой с форматом Grafana.

ClusterObservabilityLogsRulesGroup

Короткие имена: colrg

Область: Cluster
Версия: v1alpha1

Группа производных метрик из логов уровня кластера.

Правила вычисляются сервисом logs-ruler, который выполняет LogQL-запросы к бэкенду хранения логов. Полученные временные ряды экспонируются как обычные метрики Prometheus.

Для настройки алертов на созданные производные метрики используйте ресурс ClusterObservabilityMetricsRulesGroup.

Применяется для мониторинга логов из kube-*, d8-* и компонентов уровня кластера.

  • spec
    объект
    Желаемое состояние группы правил производных метрик из логов уровня кластера.
    • spec.interval
      строка

      Интервал вычисления правил.

      Если параметр не указан, используется значение по умолчанию.

      По умолчанию: 1m

      Шаблон: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

    • spec.rules
      массив объектов

      Обязательный параметр

      Список правил производных метрик из логов уровня кластера.
      • spec.rules.expr
        строка

        LogQL-выражение для вычисления производной метрики.

        Выражение должно явно выбирать нужные потоки логов (например, по namespace, app или другим лейблам, доступным в бэкенде запросов).

        Значение namespace не подставляется автоматически.

        Минимальная длина: 1

      • spec.rules.labels
        объект

        Дополнительные лейблы, добавляемые к создаваемым временным рядам.

        Следующие лейблы зарезервированы и не должны задаваться пользователем:

        • scope_type;
        • created_by;
        • rule_group_name.
      • spec.rules.record
        строка

        Имя записываемой метрики.

        Должно соответствовать правилам именования метрик Prometheus и быть уникальным в пределах группы правил.

        Минимальная длина: 1

        Шаблон: ^[a-zA-Z_:][a-zA-Z0-9_:]*$

ClusterObservabilityMetricsRulesGroup

Короткие имена: comrg

Область: Cluster
Версия: v1alpha1

Группа триггеров и правил вычисления производных метрик уровня кластера для системных неймспейсов.

Позволяет администраторам платформы управлять правилами мониторинга и алертами, которые применяются к инфраструктурным и системным неймспейсам (kube-*, d8-* и пустой неймспейс).

  • spec
    объект
    Определяет желаемое состояние группы правил кластера.
    • spec.interval
      строка

      Интервал вычисления правил группы.

      Например, 30s.

      Если параметр не задан, используется интервал по умолчанию.

      Шаблон: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

    • spec.rules
      массив объектов

      Обязательный параметр

      Список триггеров и правил вычисления производных метрик группы кластера.
      • spec.rules.alert
        строка

        Имя триггера.

        Одновременно можно указать только одно из полей: alert или record.

        Шаблон: ^[a-zA-Z-:][a-zA-Z0-9-:]*$

      • spec.rules.annotations
        объект

        Аннотации для присоединения к алерту.

        Применяются только к триггерам.

      • spec.rules.expr
        строка или число

        PromQL-выражение для вычисления правила.

        Автоматически ограничивается инфраструктурными и системными неймспейсами (kube-*, d8-*, пустой неймспейс).

      • spec.rules.for
        строка

        Задержка перед срабатыванием алерта.

        Определяет время, в течение которого условие должно непрерывно выполняться, прежде чем алерт перейдёт в активное состояние (firing).

        Применяется только к триггерам.

        Шаблон: ^(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
        строка

        Задержка снятия алерта.

        Определяет время, в течение которого алерт остаётся в активном состоянии (firing) после того, как условие перестало выполняться.

        Применяется только к триггерам.

        Шаблон: ^(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
        объект
        Дополнительные лейблы для присоединения к алерту или производной метрике.
      • spec.rules.record
        строка

        Имя производной метрики, которую записывает правило.

        Одновременно можно указать только одно из полей: alert или record.

        Шаблон: ^[a-zA-Z_:][a-zA-Z0-9_:]*$

  • status
    объект
    Состояние группы правил кластера.
    • status.conditions
      массив объектов
      Последнее доступное наблюдаемое состояние группы правил кластера.
      • status.conditions.lastTransitionTime
        строка
        Время последнего изменения состояния условия.
      • status.conditions.message
        строка
        Человекочитаемое сообщение с деталями о последнем изменении состояния условия.
      • status.conditions.reason
        строка

        Причина последнего изменения состояния условия.

        Указывается одним словом в формате CamelCase.

      • status.conditions.status
        строка

        Текущее состояние условия:

        • True — условие выполнено;
        • False — условие не выполнено;
        • Unknown — условие не удалось определить.

        Допустимые значения: True, False, Unknown

      • status.conditions.type
        строка

        Тип условия.

        • Created — ресурс создан;
        • Failed — синхронизация завершилась ошибкой;
        • Ready — группа правил успешно применена и активна.

        Допустимые значения: Created, Failed, Ready

    • status.lastSyncTime
      строка
      Время последней синхронизации, которая изменила PrometheusRule или статус группы правил кластера. Не обновляется, если синхронизация ничего не изменила.
    • status.prometheusRuleName
      строка
      Имя ресурса PrometheusRule, созданного для этой группы правил кластера.

ClusterObservabilityNotificationChannel

Область: Cluster
Версия: v1alpha1

Канал уведомлений для алертов уровня кластера.

Модуль отправляет уведомление при срабатывании алерта и при его разрешении. Правила отправки уведомлений задаются объектом ClusterObservabilityNotificationPolicy.

  • spec
    объект

    Параметры канала.

    Укажите type и секцию с параметрами этого типа, например type: Email и email.

    • spec.email
      объект
      Параметры канала типа Email.
      • spec.email.from
        строка

        Обязательный параметр

        Адрес электронной почты отправителя.
      • spec.email.smtp
        объект

        Обязательный параметр

        Параметры SMTP-сервера, через который отправляются письма.
        • spec.email.smtp.address
          строка

          Обязательный параметр

          Адрес SMTP-сервера в формате host:port, например smtp.example.com:587.
        • spec.email.smtp.auth
          объект
          Учётные данные для аутентификации на SMTP-сервере.
          • spec.email.smtp.auth.password
            строка

            Обязательный параметр

            Пароль.
          • spec.email.smtp.auth.username
            строка

            Обязательный параметр

            Имя пользователя.
        • spec.email.smtp.requireTLS
          булевый
          Требуется ли TLS-верификация.
      • spec.email.template
        строка
        Шаблон письма.
    • spec.expressMessenger
      объект
      Параметры канала типа ExpressMessenger.
      • spec.expressMessenger.apiUrl
        строка

        Обязательный параметр

        URL-адрес сервера eXpress CTS, например https://cts.company.ru.
      • spec.expressMessenger.botId
        строка

        Обязательный параметр

        Идентификатор (UUID) бота eXpress, от имени которого отправляются уведомления.

        Шаблон: ^[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
        строка

        Обязательный параметр

        Секретный ключ бота для аутентификации (JWT v2).
      • spec.expressMessenger.template
        строка
        Шаблон сообщения.
    • spec.slack
      объект
      Параметры канала типа Slack.
      • spec.slack.apiUrl
        строка

        Обязательный параметр

        URL-адрес API Slack.
      • spec.slack.color
        строка
        Цвет вложения сообщения.
      • spec.slack.fallback
        строка
        Резервный текст сообщения.
      • строка
        Нижний колонтитул сообщения.
      • spec.slack.iconEmoji
        строка
        Эмодзи для сообщения.
      • spec.slack.iconUrl
        строка
        URL-адрес изображения иконки в сообщении.
      • spec.slack.pretext
        строка
        Текст над основным блоком сообщения.
      • spec.slack.template
        строка
        Шаблон сообщения.
      • spec.slack.text
        строка
        Основной текст сообщения.
      • spec.slack.title
        строка
        Заголовок сообщения.
      • строка
        URL-адрес, на который ведёт заголовок.
      • spec.slack.username
        строка
        Имя отправителя сообщения.
    • spec.telegram
      объект
      Параметры канала типа Telegram.
      • spec.telegram.apiToken
        строка

        Обязательный параметр

        API-токен бота Telegram, от имени которого отправляются уведомления.
      • spec.telegram.apiUrl
        строка
        URL-адрес API Telegram Bot.

        По умолчанию: https://api.telegram.org

      • spec.telegram.httpConfig
        объект

        Параметры HTTP-клиента для запросов к Telegram API.

        Используйте proxyUrl или proxyFromEnvironment, если Telegram API доступен только через прокси.

        Укажите только один из параметров: basicAuth, authorization или oauth2.

        • spec.telegram.httpConfig.authorization
          объект
          Значение заголовка Authorization.
          • spec.telegram.httpConfig.authorization.credentials
            строка
            Значение учётных данных, подставляемое в заголовок Authorization.
          • spec.telegram.httpConfig.authorization.credentialsFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте credentials.

          • spec.telegram.httpConfig.authorization.type
            строка

            Схема аутентификации, например Bearer.

            Если параметр не указан, используется Bearer.

        • spec.telegram.httpConfig.basicAuth
          объект
          HTTP Basic-аутентификация.
          • spec.telegram.httpConfig.basicAuth.password
            строка
            Пароль.
          • spec.telegram.httpConfig.basicAuth.passwordFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте password.

          • spec.telegram.httpConfig.basicAuth.username
            строка
            Имя пользователя.
        • spec.telegram.httpConfig.enableHttp2
          булевый
          Включить поддержку HTTP/2.
        • spec.telegram.httpConfig.followRedirects
          булевый

          Устарело и игнорируется из соображений безопасности.

          Модуль не выполняет перенаправления, поскольку это заставляет Alertmanager обратиться по адресу, который выбирает получатель уведомления.

        • spec.telegram.httpConfig.httpHeaders
          объект

          Пользовательские HTTP-заголовки запросов к Telegram API.

          Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.

          • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>
            объект
            <KEY_NAME> — имя параметра (ключ объекта).
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
              массив строк

              Устарело и игнорируется из соображений безопасности.

              Содержимое файлов не подставляется в заголовки запросов. Используйте values или secrets.

            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secrets
              массив строк
              Значения заголовка, считываемые из секретов.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.values
              массив строк
              Значения заголовка.
        • spec.telegram.httpConfig.noProxy
          строка
          Список хостов через запятую, для которых прокси не применяется.
        • spec.telegram.httpConfig.oauth2
          объект
          Аутентификация OAuth 2.0.
          • spec.telegram.httpConfig.oauth2.clientId
            строка

            Обязательный параметр

            Идентификатор клиента OAuth 2.0.
          • spec.telegram.httpConfig.oauth2.clientSecret
            строка
            Секрет клиента OAuth 2.0.
          • spec.telegram.httpConfig.oauth2.clientSecretFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте clientSecret.

          • spec.telegram.httpConfig.oauth2.endpointParams
            объект
            Дополнительные параметры, передаваемые в запросе на получение токена.
          • spec.telegram.httpConfig.oauth2.noProxy
            строка
            Список хостов через запятую, для которых прокси не применяется.
          • spec.telegram.httpConfig.oauth2.proxyFromEnvironment
            булевый
            Использовать прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
          • spec.telegram.httpConfig.oauth2.proxyUrl
            строка
            URL-адрес HTTP-прокси, используемого для запроса токена.
          • spec.telegram.httpConfig.oauth2.scopes
            массив строк
            Области доступа (scopes), которые запрашиваются для токена.
            • spec.telegram.httpConfig.oauth2.scopes.Элемент массива
              строка
              Имя области доступа.
          • spec.telegram.httpConfig.oauth2.tlsConfig
            объект
            Настройки TLS для запроса токена.
            • spec.telegram.httpConfig.oauth2.tlsConfig.caFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.telegram.httpConfig.oauth2.tlsConfig.certFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              булевый
              Отключить проверку TLS-сертификата сервера.
            • spec.telegram.httpConfig.oauth2.tlsConfig.keyFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.telegram.httpConfig.oauth2.tlsConfig.maxVersion
              строка
              Максимальная версия TLS.
            • spec.telegram.httpConfig.oauth2.tlsConfig.minVersion
              строка
              Минимальная версия TLS.
            • spec.telegram.httpConfig.oauth2.tlsConfig.serverName
              строка
              Имя сервера для проверки TLS-сертификата (SNI).
          • spec.telegram.httpConfig.oauth2.tokenUrl
            строка

            Обязательный параметр

            URL-адрес эндпоинта для получения токена.
        • spec.telegram.httpConfig.proxyConnectHeader
          объект

          Заголовки CONNECT-запросов к прокси.

          Имена заголовков сопоставляются со списком значений.

        • spec.telegram.httpConfig.proxyFromEnvironment
          булевый
          Использовать прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
        • spec.telegram.httpConfig.proxyUrl
          строка
          URL-адрес HTTP-прокси для запросов к Telegram API.
        • spec.telegram.httpConfig.tlsConfig
          объект
          Настройки TLS для HTTP-клиента Telegram-получателя.
          • spec.telegram.httpConfig.tlsConfig.caFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.telegram.httpConfig.tlsConfig.certFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.telegram.httpConfig.tlsConfig.insecureSkipVerify
            булевый
            Отключить проверку TLS-сертификата сервера.
          • spec.telegram.httpConfig.tlsConfig.keyFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.telegram.httpConfig.tlsConfig.maxVersion
            строка
            Максимальная версия TLS.
          • spec.telegram.httpConfig.tlsConfig.minVersion
            строка
            Минимальная версия TLS.
          • spec.telegram.httpConfig.tlsConfig.serverName
            строка
            Имя сервера для проверки TLS-сертификата (SNI).
      • spec.telegram.template
        строка
        Шаблон сообщения.
    • spec.type
      строка

      Обязательный параметр

      Тип канала уведомлений.

      Допустимые значения: Email, Slack, Telegram, Webhook, ExpressMessenger, Zabbix

    • spec.webhook
      объект
      Параметры канала типа Webhook.
      • spec.webhook.httpConfig
        объект

        Параметры HTTP-клиента для запросов на URL-адрес вебхука.

        Укажите только один из параметров: basicAuth, authorization или oauth2.

        • spec.webhook.httpConfig.authorization
          объект
          Значение заголовка Authorization.
          • spec.webhook.httpConfig.authorization.credentials
            строка
            Значение учётных данных, подставляемое в заголовок Authorization.
          • spec.webhook.httpConfig.authorization.credentialsFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте credentials.

          • spec.webhook.httpConfig.authorization.type
            строка

            Схема аутентификации, например Bearer.

            Если параметр не указан, используется Bearer.

        • spec.webhook.httpConfig.basicAuth
          объект
          HTTP Basic-аутентификация.
          • spec.webhook.httpConfig.basicAuth.password
            строка
            Пароль.
          • spec.webhook.httpConfig.basicAuth.passwordFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте password.

          • spec.webhook.httpConfig.basicAuth.username
            строка
            Имя пользователя.
        • spec.webhook.httpConfig.enableHttp2
          булевый
          Включить поддержку HTTP/2 для вебхук-запросов.
        • spec.webhook.httpConfig.followRedirects
          булевый

          Устарело и игнорируется из соображений безопасности.

          Модуль не выполняет HTTP-перенаправления.

        • spec.webhook.httpConfig.httpHeaders
          объект

          Пользовательские HTTP-заголовки запросов на URL-адрес вебхука.

          Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.

          • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>
            объект
            <KEY_NAME> — имя параметра (ключ объекта).
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
              массив строк

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager. Используйте values или secrets.

            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secrets
              массив строк
              Значения заголовка, считываемые из секретов.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.values
              массив строк
              Значения заголовка.
        • spec.webhook.httpConfig.noProxy
          строка
          Список хостов через запятую, к которым запросы выполняются без прокси.
        • spec.webhook.httpConfig.oauth2
          объект
          Аутентификация OAuth 2.0.
          • spec.webhook.httpConfig.oauth2.clientId
            строка

            Обязательный параметр

            Идентификатор клиента OAuth 2.0.
          • spec.webhook.httpConfig.oauth2.clientSecret
            строка
            Секрет клиента OAuth 2.0.
          • spec.webhook.httpConfig.oauth2.clientSecretFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте clientSecret.

          • spec.webhook.httpConfig.oauth2.endpointParams
            объект
            Дополнительные параметры, передаваемые в запросе на получение токена.
          • spec.webhook.httpConfig.oauth2.noProxy
            строка
            Список хостов через запятую, для которых прокси не применяется.
          • spec.webhook.httpConfig.oauth2.proxyFromEnvironment
            булевый
            Использовать прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
          • spec.webhook.httpConfig.oauth2.proxyUrl
            строка
            URL-адрес HTTP-прокси, используемого для запроса токена.
          • spec.webhook.httpConfig.oauth2.scopes
            массив строк
            Области доступа (scopes), которые запрашиваются для токена.
            • spec.webhook.httpConfig.oauth2.scopes.Элемент массива
              строка
              Имя области доступа.
          • spec.webhook.httpConfig.oauth2.tlsConfig
            объект
            Настройки TLS для запроса токена.
            • spec.webhook.httpConfig.oauth2.tlsConfig.caFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.webhook.httpConfig.oauth2.tlsConfig.certFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              булевый
              Отключить проверку TLS-сертификата сервера.
            • spec.webhook.httpConfig.oauth2.tlsConfig.keyFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.webhook.httpConfig.oauth2.tlsConfig.maxVersion
              строка
              Максимальная версия TLS.
            • spec.webhook.httpConfig.oauth2.tlsConfig.minVersion
              строка
              Минимальная версия TLS.
            • spec.webhook.httpConfig.oauth2.tlsConfig.serverName
              строка
              Имя сервера для проверки TLS-сертификата (SNI).
          • spec.webhook.httpConfig.oauth2.tokenUrl
            строка

            Обязательный параметр

            URL-адрес эндпоинта для получения токена.
        • spec.webhook.httpConfig.proxyConnectHeader
          объект

          Заголовки CONNECT-запросов к прокси.

          Имена заголовков сопоставляются со списком значений.

        • spec.webhook.httpConfig.proxyFromEnvironment
          булевый
          Использовать параметры прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
        • spec.webhook.httpConfig.proxyUrl
          строка
          URL-адрес HTTP-прокси для вебхук-запросов.
        • spec.webhook.httpConfig.tlsConfig
          объект
          Настройки TLS для запросов на URL-адрес вебхука.
          • spec.webhook.httpConfig.tlsConfig.caFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.webhook.httpConfig.tlsConfig.certFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.webhook.httpConfig.tlsConfig.insecureSkipVerify
            булевый
            Отключить проверку TLS-сертификата сервера.
          • spec.webhook.httpConfig.tlsConfig.keyFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.webhook.httpConfig.tlsConfig.maxVersion
            строка
            Максимальная версия TLS.
          • spec.webhook.httpConfig.tlsConfig.minVersion
            строка
            Минимальная версия TLS.
          • spec.webhook.httpConfig.tlsConfig.serverName
            строка
            Имя сервера для проверки TLS-сертификата (SNI).
      • spec.webhook.url
        строка

        Обязательный параметр

        URL-адрес вебхука.

        Модуль отправляет уведомления на указанный URL-адрес в формате JSON вебхука Alertmanager.

        Минимальная длина: 1

    • spec.zabbix
      объект
      Параметры канала типа Zabbix.
      • spec.zabbix.api
        объект

        Подключение к API Zabbix для автоматического импорта шаблона.

        Если секция указана, модуль импортирует шаблон и создаёт узел сети и группу узлов сети кластера через JSON-RPC API Zabbix. Иначе импортируйте шаблон из ConfigMap вручную.

        • spec.zabbix.api.tlsConfig
          объект
          Настройки TLS для HTTPS-соединения с API Zabbix. Сертификаты и ключи задаются содержимым в формате PEM.
          • spec.zabbix.api.tlsConfig.ca
            строка
            CA-сертификат(ы) в формате PEM для проверки сертификата API-сервера Zabbix. Если не задан, используется системное хранилище доверенных сертификатов.
          • spec.zabbix.api.tlsConfig.caFile
            Параметр устарел
            строка
            Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в ca.
          • spec.zabbix.api.tlsConfig.cert
            строка
            Клиентский сертификат в формате PEM для API за взаимным TLS. Задаётся только вместе с key.
          • spec.zabbix.api.tlsConfig.certFile
            Параметр устарел
            строка
            Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в cert.
          • spec.zabbix.api.tlsConfig.insecureSkipVerify
            булевый
            Отключить проверку TLS-сертификата API-сервера Zabbix.
          • spec.zabbix.api.tlsConfig.key
            строка
            Незашифрованный приватный ключ для cert в формате PEM. Задаётся только вместе с cert.
          • spec.zabbix.api.tlsConfig.keyFile
            Параметр устарел
            строка
            Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в key.
          • spec.zabbix.api.tlsConfig.serverName
            строка
            Имя сервера для проверки TLS-сертификата (SNI). По умолчанию — хост из url.
        • spec.zabbix.api.token
          строка

          Обязательный параметр

          Токен API Zabbix для аутентификации вызовов “configuration.import”.

          Токен хранится в этом ресурсе в открытом виде.

          Минимальная длина: 1

        • spec.zabbix.api.url
          строка

          Обязательный параметр

          URL-адрес JSON-RPC API Zabbix, например https://zabbix.example.com/api_jsonrpc.php.

          Если схема не указана, используется https://.

          Минимальная длина: 1

      • spec.zabbix.clusterName
        строка

        Обязательный параметр

        Имя кластера в Zabbix.

        Имя становится техническим именем узла сети (host) Zabbix, который принимает данные. Оно должно быть уникальным среди всех кластеров и каналов, которые отправляют данные в один экземпляр Zabbix.

        Минимальная длина: 1

      • spec.zabbix.disableTLS
        булевый

        Подключаться к trapper-порту без использования TLS.

        Если параметр выключен, соединение использует TLS с настройками из tls. Если tls не указан, выполняется проверка сертификата.

        По умолчанию: false

      • spec.zabbix.hostGroup
        строка
        Группа узлов сети (host group) Zabbix, в которую добавляется узел сети кластера.

        По умолчанию: Deckhouse

      • spec.zabbix.port
        целое число
        Trapper-порт Zabbix Server или Zabbix Proxy.

        По умолчанию: 10051

      • spec.zabbix.server
        строка

        Обязательный параметр

        Адрес Zabbix Server или Zabbix Proxy, на который отправляются trapper-данные.

        Минимальная длина: 1

      • spec.zabbix.tls
        объект

        Настройки TLS для соединения с Zabbix Server по протоколу sender.

        Сертификаты и ключи задаются содержимым в формате PEM. Режим сертификатов Zabbix (TLSAccept=cert) — это взаимный TLS: cert и key для него обязательны. Режим PSK не поддерживается.

        • spec.zabbix.tls.ca
          строка
          CA-сертификат(ы) в формате PEM для проверки сертификата Zabbix Server/Proxy. Если не задан, используется системное хранилище доверенных сертификатов.
        • spec.zabbix.tls.caFile
          Параметр устарел
          строка
          Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в ca.
        • spec.zabbix.tls.cert
          строка
          Клиентский сертификат в формате PEM, предъявляемый Zabbix Server/Proxy. Задаётся только вместе с key.
        • spec.zabbix.tls.certFile
          Параметр устарел
          строка
          Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в cert.
        • spec.zabbix.tls.insecureSkipVerify
          булевый
          Полностью отключить проверку TLS-сертификата сервера Zabbix. Требование клиентского сертификата в режиме сертификатов Zabbix при этом не снимается.
        • spec.zabbix.tls.key
          строка
          Незашифрованный приватный ключ для cert в формате PEM. Задаётся только вместе с cert.
        • spec.zabbix.tls.keyFile
          Параметр устарел
          строка
          Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в key.
        • spec.zabbix.tls.serverName
          строка
          Имя сервера для проверки TLS-сертификата (SNI). По умолчанию — spec.zabbix.server.
        • spec.zabbix.tls.skipServerNameVerification
          булевый

          Проверять цепочку сертификата сервера по ca, но не сверять сертификат с serverName.

          Нужно, когда в сертификате Zabbix нет Subject Alternative Name (Zabbix проверяет только Subject, так что это обычное дело) — иначе такой сертификат отклоняется. Требует ca: по одному системному хранилищу проверка цепочки без имени приняла бы любой публично доверенный сертификат. Игнорируется при insecureSkipVerify: true.

  • status
    объект
    Состояние канала уведомлений, включая информацию о политиках уведомлений, использующих канал.
    • status.policies
      массив объектов
      Список политик уведомлений, использующих этот канал во всех неймспейсах.
      • status.policies.name
        строка
        Имя политики уведомлений.
      • status.policies.namespace
        строка

        Неймспейс политики уведомлений.

        Пустая строка для ClusterObservabilityNotificationPolicy.

ClusterObservabilityNotificationPolicy

Область: Cluster
Версия: v1alpha1

Правила отправки уведомлений об алертах уровня кластера.

При помощи политики модуль по лейблам выбирает алерты уровня кластера и отправляет уведомления о них в канал ClusterObservabilityNotificationChannel.

  • spec
    объект
    Параметры политики.
    • spec.alert
      объект

      Обязательный параметр

      Алерты, к которым применяется политика.
      • spec.alert.groupByLabels
        массив строк

        Лейблы, по которым алерты группируются в одно уведомление.

        Алерты с одинаковыми значениями этих лейблов отправляются одним сообщением. Если параметр не указан, по каждому алерту отправляется отдельное уведомление.

        • spec.alert.groupByLabels.Элемент массива
          строка
          Имя лейбла алерта.
      • spec.alert.selector
        объект

        Обязательный параметр

        Селектор алертов, к которым применяется политика.

        Укажите только одно из полей: matchLabels или matchExpressions.

        • spec.alert.selector.matchExpressions
          массив объектов

          Набор выражений (условий) для фильтрации алертов.

          Политика применяется к алерту, если он удовлетворяет всем условиям.

          • spec.alert.selector.matchExpressions.key
            строка
            Имя лейбла алерта.
          • spec.alert.selector.matchExpressions.operator
            строка

            Оператор сравнения:

            • Equal — значение лейбла равно value;
            • NotEqual — значение лейбла отличается от value;
            • Regex — значение лейбла соответствует регулярному выражению value;
            • NotRegex — значение лейбла не соответствует регулярному выражению value.

            Допустимые значения: Equal, NotEqual, Regex, NotRegex

          • spec.alert.selector.matchExpressions.value
            строка
            Значение или регулярное выражение, с которым сравнивается значение лейбла.
        • spec.alert.selector.matchLabels
          объект
          Лейблы и их значения, которые должны быть у алерта, чтобы к нему применялась политика.
    • spec.notification
      объект

      Обязательный параметр

      Параметры уведомлений.
      • spec.notification.channel
        объект

        Обязательный параметр

        “Канал, в который отправляются уведомления.”
        • spec.notification.channel.kind
          строка

          Обязательный параметр

          Тип объекта канала уведомлений.

          По умолчанию: ClusterObservabilityNotificationChannel

          Допустимые значения: ClusterObservabilityNotificationChannel

        • spec.notification.channel.name
          строка

          Обязательный параметр

          Имя объекта канала.
        • spec.notification.channel.parameters
          объект

          Обязательный параметр

          Параметры канала уведомлений.
      • spec.notification.repeatInterval
        строка

        Обязательный параметр

        Интервал повторной отправки уведомления об алерте.

        По умолчанию: 1m

  • status
    объект
    Состояние политики уведомлений.
    • status.description
      строка
      Причина, по которой модуль не применяет политику.
    • status.state
      строка

      Состояние политики:

      • Applicable — модуль отправляет уведомления в соответствии с политикой;
      • NotApplicable — модуль не применяет политику, например потому что канал не существует или parameters не соответствуют типу канала. Причина указана в поле description.

ClusterObservabilityNotificationSilence

Область: Cluster
Версия: v1alpha1

Временное отключение (silence) отправки уведомлений об алертах уровня кластера.

Во время отключения модуль не отправляет уведомления об алертах уровня кластера, если они соответствуют spec.selector.

  • spec
    объект
    Параметры отключения.
    • spec.endsAt
      строка

      Обязательный параметр

      Время окончания отключения.
    • spec.selector
      объект

      Обязательный параметр

      Селектор алертов, уведомления о которых отключаются.

      Укажите только одно из полей: matchLabels или matchExpressions.

      • spec.selector.matchExpressions
        массив объектов

        Набор выражений (условий) для фильтрации алертов.

        Уведомления по алерту отключаются, если он удовлетворяет всем условиям.

        • spec.selector.matchExpressions.key
          строка
          Имя лейбла алерта.
        • spec.selector.matchExpressions.operator
          строка

          Оператор сравнения:

          • Equal — значение лейбла равно value;
          • NotEqual — значение лейбла отличается от value;
          • Regex — значение лейбла соответствует регулярному выражению value;
          • NotRegex — значение лейбла не соответствует регулярному выражению value.

          Допустимые значения: Equal, NotEqual, Regex, NotRegex

        • spec.selector.matchExpressions.value
          строка
          Значение или регулярное выражение, с которым сравнивается значение лейбла.
      • spec.selector.matchLabels
        объект
        Лейблы и их значения, которые должны быть у алерта, чтобы уведомления о нём отключились.
    • spec.startsAt
      строка

      Обязательный параметр

      Время начала отключения.

ClusterObservabilityPropagatedDashboard

Область: Cluster
Версия: v1alpha1

Дашборд, отображаемый в веб-интерфейсе Deckhouse на уровне кластера и во всех неймспейсах (проектах).

Чтобы настроить отображение дашборда, используйте следующие аннотации:

  • metadata.deckhouse.io/category — папка (категория) дашборда в интерфейсе;
  • metadata.deckhouse.io/title — название дашборда в интерфейсе. Если аннотация не указана, модуль использует название из JSON-манифеста.
  • spec
    объект
    • spec.definition
      строка

      Обязательный параметр

      JSON-манифест дашборда в виде строки, совместимой с форматом Grafana.

ClusterObservabilityPropagatedMetricsRulesGroup

Короткие имена: copmrg

Область: Cluster
Версия: v1alpha1

Группа триггеров и правил вычисления производных метрик уровня кластера, распространяемая на все неймспейсы.

Ресурсы с лейблом heritage: deckhouse поставляются вместе с Deckhouse Platform, управлять ими может только ServiceAccount deckhouse.

  • spec
    объект
    Параметры распространяемой группы правил.
    • spec.interval
      строка

      Интервал вычисления правил группы.

      Например, 30s.

      Если параметр не задан, используется интервал по умолчанию.

      Шаблон: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

    • spec.rules
      массив объектов

      Обязательный параметр

      Список триггеров и правил вычисления производных метрик группы.
      • spec.rules.alert
        строка

        Имя триггера.

        Одновременно можно указать только одно из полей: alert или record.

        Шаблон: ^[a-zA-Z-:][a-zA-Z0-9-:]*$

      • spec.rules.annotations
        объект

        Аннотации для присоединения к алерту.

        Применяются только к триггерам.

      • spec.rules.expr
        строка или число

        PromQL-выражение для вычисления правила.

        К распространяемым правилам не применяется ограничение по неймспейсам.

      • spec.rules.for
        строка

        Задержка перед срабатыванием алерта.

        Определяет время, в течение которого условие должно непрерывно выполняться, прежде чем алерт перейдёт в активное состояние (firing).

        Применяется только к триггерам.

        Шаблон: ^(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
        строка

        Задержка снятия алерта.

        Определяет время, в течение которого алерт остаётся в активном состоянии (firing) после того, как условие перестало выполняться.

        Применяется только к триггерам.

        Шаблон: ^(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
        объект
        Дополнительные лейблы для присоединения к алерту или производной метрике.
      • spec.rules.record
        строка

        Имя производной метрики, которую записывает правило.

        Одновременно можно указать только одно из полей: alert или record.

        Шаблон: ^[a-zA-Z_:][a-zA-Z0-9_:]*$

  • status
    объект
    Наблюдаемое состояние распространяемой группы правил.
    • status.conditions
      массив объектов
      Последнее доступное наблюдаемое состояние распространяемой группы правил.
      • status.conditions.lastTransitionTime
        строка
        Время последнего изменения состояния условия.
      • status.conditions.message
        строка
        Человекочитаемое сообщение с деталями о последнем изменении состояния условия.
      • status.conditions.reason
        строка

        Причина последнего изменения состояния условия.

        Указывается одним словом в формате CamelCase.

      • status.conditions.status
        строка

        Текущее значение условия:

        • True — условие выполнено;
        • False — условие не выполнено;
        • Unknown — условие не удалось определить.

        Допустимые значения: True, False, Unknown

      • status.conditions.type
        строка

        Тип состояния группы правил:

        • Created — ресурс создан;
        • Failed — синхронизация завершилась ошибкой;
        • Ready — группа правил успешно применена и активна.

        Допустимые значения: Created, Failed, Ready

    • status.lastSyncTime
      строка

      Время последней успешной синхронизации распространяемой группы правил, которая изменила PrometheusRule или статус распространяемой группы правил.

      Не обновляется, если синхронизация ничего не изменила.

    • status.prometheusRuleName
      строка
      Имя ресурса PrometheusRule, созданного для этой распространяемой группы правил.

ClusterObservabilityPropagatedNotificationChannel

Область: Cluster
Версия: v1alpha1

Канал уведомлений, доступный во всех неймспейсах.

Модуль отправляет уведомление при срабатывании алерта и при его разрешении. Правила отправки уведомлений задаются объектами ObservabilityNotificationPolicy в любом неймспейсе или объектом ClusterObservabilityPropagatedNotificationPolicy.

  • spec
    объект

    Параметры канала.

    Укажите type и секцию с параметрами этого типа, например type: Email и email.

    • spec.email
      объект
      Параметры канала типа Email.
      • spec.email.from
        строка

        Обязательный параметр

        Адрес электронной почты отправителя.
      • spec.email.smtp
        объект

        Обязательный параметр

        Параметры SMTP-сервера, через который отправляются письма.
        • spec.email.smtp.address
          строка

          Обязательный параметр

          Адрес SMTP-сервера в формате host:port, например smtp.example.com:587.
        • spec.email.smtp.auth
          объект
          Учётные данные для аутентификации на SMTP-сервере.
          • spec.email.smtp.auth.password
            строка

            Обязательный параметр

            Пароль.
          • spec.email.smtp.auth.username
            строка

            Обязательный параметр

            Имя пользователя.
        • spec.email.smtp.requireTLS
          булевый
          Требуется ли TLS-верификация.
      • spec.email.template
        строка
        Шаблон письма.
    • spec.expressMessenger
      объект
      Параметры канала типа ExpressMessenger.
      • spec.expressMessenger.apiUrl
        строка

        Обязательный параметр

        URL-адрес сервера eXpress CTS, например https://cts.company.ru.
      • spec.expressMessenger.botId
        строка

        Обязательный параметр

        Идентификатор (UUID) бота eXpress, от имени которого отправляются уведомления.

        Шаблон: ^[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
        строка

        Обязательный параметр

        Секретный ключ бота для аутентификации (JWT v2).
      • spec.expressMessenger.template
        строка
        Шаблон сообщения.
    • spec.slack
      объект
      Параметры канала типа Slack.
      • spec.slack.apiUrl
        строка

        Обязательный параметр

        URL-адрес API Slack.
      • spec.slack.color
        строка
        Цвет вложения сообщения.
      • spec.slack.fallback
        строка
        Резервный текст сообщения.
      • строка
        Нижний колонтитул сообщения.
      • spec.slack.iconEmoji
        строка
        Эмодзи для сообщения.
      • spec.slack.iconUrl
        строка
        URL-адрес изображения иконки в сообщении.
      • spec.slack.pretext
        строка
        Текст над основным блоком сообщения.
      • spec.slack.template
        строка
        Шаблон сообщения.
      • spec.slack.text
        строка
        Основной текст сообщения.
      • spec.slack.title
        строка
        Заголовок сообщения.
      • строка
        URL-адрес, на который ведёт заголовок.
      • spec.slack.username
        строка
        Имя отправителя сообщения.
    • spec.telegram
      объект
      Параметры канала типа Telegram.
      • spec.telegram.apiToken
        строка

        Обязательный параметр

        API-токен бота Telegram, от имени которого отправляются уведомления.
      • spec.telegram.apiUrl
        строка
        URL-адрес API Telegram Bot.

        По умолчанию: https://api.telegram.org

      • spec.telegram.httpConfig
        объект

        Параметры HTTP-клиента для запросов к Telegram API.

        Используйте proxyUrl или proxyFromEnvironment, если Telegram API доступен только через прокси.

        Укажите только один из параметров: basicAuth, authorization или oauth2.

        • spec.telegram.httpConfig.authorization
          объект
          Значение заголовка Authorization.
          • spec.telegram.httpConfig.authorization.credentials
            строка
            Значение учётных данных, подставляемое в заголовок Authorization.
          • spec.telegram.httpConfig.authorization.credentialsFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте credentials.

          • spec.telegram.httpConfig.authorization.type
            строка

            Схема аутентификации, например Bearer.

            Если параметр не указан, используется Bearer.

        • spec.telegram.httpConfig.basicAuth
          объект
          HTTP Basic-аутентификация.
          • spec.telegram.httpConfig.basicAuth.password
            строка
            Пароль.
          • spec.telegram.httpConfig.basicAuth.passwordFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте password.

          • spec.telegram.httpConfig.basicAuth.username
            строка
            Имя пользователя.
        • spec.telegram.httpConfig.enableHttp2
          булевый
          Включить поддержку HTTP/2.
        • spec.telegram.httpConfig.followRedirects
          булевый

          Устарело и игнорируется из соображений безопасности.

          Модуль не выполняет перенаправления, поскольку это заставляет Alertmanager обратиться по адресу, который выбирает получатель уведомления.

        • spec.telegram.httpConfig.httpHeaders
          объект

          Пользовательские HTTP-заголовки запросов к Telegram API.

          Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.

          • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>
            объект
            <KEY_NAME> — имя параметра (ключ объекта).
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
              массив строк

              Устарело и игнорируется из соображений безопасности.

              Содержимое файлов не подставляется в заголовки запросов. Используйте values или secrets.

            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secrets
              массив строк
              Значения заголовка, считываемые из секретов.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.values
              массив строк
              Значения заголовка.
        • spec.telegram.httpConfig.noProxy
          строка
          Список хостов через запятую, для которых прокси не применяется.
        • spec.telegram.httpConfig.oauth2
          объект
          Аутентификация OAuth 2.0.
          • spec.telegram.httpConfig.oauth2.clientId
            строка

            Обязательный параметр

            Идентификатор клиента OAuth 2.0.
          • spec.telegram.httpConfig.oauth2.clientSecret
            строка
            Секрет клиента OAuth 2.0.
          • spec.telegram.httpConfig.oauth2.clientSecretFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте clientSecret.

          • spec.telegram.httpConfig.oauth2.endpointParams
            объект
            Дополнительные параметры, передаваемые в запросе на получение токена.
          • spec.telegram.httpConfig.oauth2.noProxy
            строка
            Список хостов через запятую, для которых прокси не применяется.
          • spec.telegram.httpConfig.oauth2.proxyFromEnvironment
            булевый
            Использовать прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
          • spec.telegram.httpConfig.oauth2.proxyUrl
            строка
            URL-адрес HTTP-прокси, используемого для запроса токена.
          • spec.telegram.httpConfig.oauth2.scopes
            массив строк
            Области доступа (scopes), которые запрашиваются для токена.
            • spec.telegram.httpConfig.oauth2.scopes.Элемент массива
              строка
              Имя области доступа.
          • spec.telegram.httpConfig.oauth2.tlsConfig
            объект
            Настройки TLS для запроса токена.
            • spec.telegram.httpConfig.oauth2.tlsConfig.caFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.telegram.httpConfig.oauth2.tlsConfig.certFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              булевый
              Отключить проверку TLS-сертификата сервера.
            • spec.telegram.httpConfig.oauth2.tlsConfig.keyFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.telegram.httpConfig.oauth2.tlsConfig.maxVersion
              строка
              Максимальная версия TLS.
            • spec.telegram.httpConfig.oauth2.tlsConfig.minVersion
              строка
              Минимальная версия TLS.
            • spec.telegram.httpConfig.oauth2.tlsConfig.serverName
              строка
              Имя сервера для проверки TLS-сертификата (SNI).
          • spec.telegram.httpConfig.oauth2.tokenUrl
            строка

            Обязательный параметр

            URL-адрес эндпоинта для получения токена.
        • spec.telegram.httpConfig.proxyConnectHeader
          объект

          Заголовки CONNECT-запросов к прокси.

          Имена заголовков сопоставляются со списком значений.

        • spec.telegram.httpConfig.proxyFromEnvironment
          булевый
          Использовать прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
        • spec.telegram.httpConfig.proxyUrl
          строка
          URL-адрес HTTP-прокси для запросов к Telegram API.
        • spec.telegram.httpConfig.tlsConfig
          объект
          Настройки TLS для HTTP-клиента Telegram-получателя.
          • spec.telegram.httpConfig.tlsConfig.caFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.telegram.httpConfig.tlsConfig.certFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.telegram.httpConfig.tlsConfig.insecureSkipVerify
            булевый
            Отключить проверку TLS-сертификата сервера.
          • spec.telegram.httpConfig.tlsConfig.keyFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.telegram.httpConfig.tlsConfig.maxVersion
            строка
            Максимальная версия TLS.
          • spec.telegram.httpConfig.tlsConfig.minVersion
            строка
            Минимальная версия TLS.
          • spec.telegram.httpConfig.tlsConfig.serverName
            строка
            Имя сервера для проверки TLS-сертификата (SNI).
      • spec.telegram.template
        строка
        Шаблон сообщения.
    • spec.type
      строка

      Обязательный параметр

      Тип канала уведомлений.

      Допустимые значения: Email, Slack, Telegram, Webhook, ExpressMessenger, Zabbix

    • spec.webhook
      объект
      Параметры канала типа Webhook.
      • spec.webhook.httpConfig
        объект

        Параметры HTTP-клиента для запросов на URL-адрес вебхука.

        Укажите только один из параметров: basicAuth, authorization или oauth2.

        • spec.webhook.httpConfig.authorization
          объект
          Значение заголовка Authorization.
          • spec.webhook.httpConfig.authorization.credentials
            строка
            Значение учётных данных, подставляемое в заголовок Authorization.
          • spec.webhook.httpConfig.authorization.credentialsFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте credentials.

          • spec.webhook.httpConfig.authorization.type
            строка

            Схема аутентификации, например Bearer.

            Если параметр не указан, используется Bearer.

        • spec.webhook.httpConfig.basicAuth
          объект
          HTTP Basic-аутентификация.
          • spec.webhook.httpConfig.basicAuth.password
            строка
            Пароль.
          • spec.webhook.httpConfig.basicAuth.passwordFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте password.

          • spec.webhook.httpConfig.basicAuth.username
            строка
            Имя пользователя.
        • spec.webhook.httpConfig.enableHttp2
          булевый
          Включить поддержку HTTP/2 для вебхук-запросов.
        • spec.webhook.httpConfig.followRedirects
          булевый

          Устарело и игнорируется из соображений безопасности.

          Модуль не выполняет HTTP-перенаправления.

        • spec.webhook.httpConfig.httpHeaders
          объект

          Пользовательские HTTP-заголовки запросов на URL-адрес вебхука.

          Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.

          • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>
            объект
            <KEY_NAME> — имя параметра (ключ объекта).
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
              массив строк

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager. Используйте values или secrets.

            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secrets
              массив строк
              Значения заголовка, считываемые из секретов.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.values
              массив строк
              Значения заголовка.
        • spec.webhook.httpConfig.noProxy
          строка
          Список хостов через запятую, к которым запросы выполняются без прокси.
        • spec.webhook.httpConfig.oauth2
          объект
          Аутентификация OAuth 2.0.
          • spec.webhook.httpConfig.oauth2.clientId
            строка

            Обязательный параметр

            Идентификатор клиента OAuth 2.0.
          • spec.webhook.httpConfig.oauth2.clientSecret
            строка
            Секрет клиента OAuth 2.0.
          • spec.webhook.httpConfig.oauth2.clientSecretFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте clientSecret.

          • spec.webhook.httpConfig.oauth2.endpointParams
            объект
            Дополнительные параметры, передаваемые в запросе на получение токена.
          • spec.webhook.httpConfig.oauth2.noProxy
            строка
            Список хостов через запятую, для которых прокси не применяется.
          • spec.webhook.httpConfig.oauth2.proxyFromEnvironment
            булевый
            Использовать прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
          • spec.webhook.httpConfig.oauth2.proxyUrl
            строка
            URL-адрес HTTP-прокси, используемого для запроса токена.
          • spec.webhook.httpConfig.oauth2.scopes
            массив строк
            Области доступа (scopes), которые запрашиваются для токена.
            • spec.webhook.httpConfig.oauth2.scopes.Элемент массива
              строка
              Имя области доступа.
          • spec.webhook.httpConfig.oauth2.tlsConfig
            объект
            Настройки TLS для запроса токена.
            • spec.webhook.httpConfig.oauth2.tlsConfig.caFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.webhook.httpConfig.oauth2.tlsConfig.certFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              булевый
              Отключить проверку TLS-сертификата сервера.
            • spec.webhook.httpConfig.oauth2.tlsConfig.keyFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.webhook.httpConfig.oauth2.tlsConfig.maxVersion
              строка
              Максимальная версия TLS.
            • spec.webhook.httpConfig.oauth2.tlsConfig.minVersion
              строка
              Минимальная версия TLS.
            • spec.webhook.httpConfig.oauth2.tlsConfig.serverName
              строка
              Имя сервера для проверки TLS-сертификата (SNI).
          • spec.webhook.httpConfig.oauth2.tokenUrl
            строка

            Обязательный параметр

            URL-адрес эндпоинта для получения токена.
        • spec.webhook.httpConfig.proxyConnectHeader
          объект

          Заголовки CONNECT-запросов к прокси.

          Имена заголовков сопоставляются со списком значений.

        • spec.webhook.httpConfig.proxyFromEnvironment
          булевый
          Использовать параметры прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
        • spec.webhook.httpConfig.proxyUrl
          строка
          URL-адрес HTTP-прокси для вебхук-запросов.
        • spec.webhook.httpConfig.tlsConfig
          объект
          Настройки TLS для запросов на URL-адрес вебхука.
          • spec.webhook.httpConfig.tlsConfig.caFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.webhook.httpConfig.tlsConfig.certFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.webhook.httpConfig.tlsConfig.insecureSkipVerify
            булевый
            Отключить проверку TLS-сертификата сервера.
          • spec.webhook.httpConfig.tlsConfig.keyFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.webhook.httpConfig.tlsConfig.maxVersion
            строка
            Максимальная версия TLS.
          • spec.webhook.httpConfig.tlsConfig.minVersion
            строка
            Минимальная версия TLS.
          • spec.webhook.httpConfig.tlsConfig.serverName
            строка
            Имя сервера для проверки TLS-сертификата (SNI).
      • spec.webhook.url
        строка

        Обязательный параметр

        URL-адрес вебхука.

        Модуль отправляет уведомления на указанный URL-адрес в формате JSON вебхука Alertmanager.

        Минимальная длина: 1

    • spec.zabbix
      объект
      Параметры канала типа Zabbix.
      • spec.zabbix.api
        объект

        Подключение к API Zabbix для автоматического импорта шаблона.

        Если секция указана, модуль импортирует шаблон и создаёт узел сети и группу узлов сети кластера через JSON-RPC API Zabbix. Иначе импортируйте шаблон из ConfigMap вручную.

        • spec.zabbix.api.tlsConfig
          объект
          Настройки TLS для HTTPS-соединения с API Zabbix. Сертификаты и ключи задаются содержимым в формате PEM.
          • spec.zabbix.api.tlsConfig.ca
            строка
            CA-сертификат(ы) в формате PEM для проверки сертификата API-сервера Zabbix. Если не задан, используется системное хранилище доверенных сертификатов.
          • spec.zabbix.api.tlsConfig.caFile
            Параметр устарел
            строка
            Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в ca.
          • spec.zabbix.api.tlsConfig.cert
            строка
            Клиентский сертификат в формате PEM для API за взаимным TLS. Задаётся только вместе с key.
          • spec.zabbix.api.tlsConfig.certFile
            Параметр устарел
            строка
            Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в cert.
          • spec.zabbix.api.tlsConfig.insecureSkipVerify
            булевый
            Отключить проверку TLS-сертификата API-сервера Zabbix.
          • spec.zabbix.api.tlsConfig.key
            строка
            Незашифрованный приватный ключ для cert в формате PEM. Задаётся только вместе с cert.
          • spec.zabbix.api.tlsConfig.keyFile
            Параметр устарел
            строка
            Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в key.
          • spec.zabbix.api.tlsConfig.serverName
            строка
            Имя сервера для проверки TLS-сертификата (SNI). По умолчанию — хост из url.
        • spec.zabbix.api.token
          строка

          Обязательный параметр

          Токен API Zabbix для аутентификации вызовов “configuration.import”.

          Токен хранится в этом ресурсе в открытом виде.

          Минимальная длина: 1

        • spec.zabbix.api.url
          строка

          Обязательный параметр

          URL-адрес JSON-RPC API Zabbix, например https://zabbix.example.com/api_jsonrpc.php.

          Если схема не указана, используется https://.

          Минимальная длина: 1

      • spec.zabbix.clusterName
        строка

        Обязательный параметр

        Имя кластера в Zabbix.

        Имя становится техническим именем узла сети (host) Zabbix, который принимает данные. Оно должно быть уникальным среди всех кластеров и каналов, которые отправляют данные в один экземпляр Zabbix.

        Минимальная длина: 1

      • spec.zabbix.disableTLS
        булевый

        Подключаться к trapper-порту без использования TLS.

        Если параметр выключен, соединение использует TLS с настройками из tls. Если tls не указан, выполняется проверка сертификата.

        По умолчанию: false

      • spec.zabbix.hostGroup
        строка
        Группа узлов сети (host group) Zabbix, в которую добавляется узел сети кластера.

        По умолчанию: Deckhouse

      • spec.zabbix.port
        целое число
        Trapper-порт Zabbix Server или Zabbix Proxy.

        По умолчанию: 10051

      • spec.zabbix.server
        строка

        Обязательный параметр

        Адрес Zabbix Server или Zabbix Proxy, на который отправляются trapper-данные.

        Минимальная длина: 1

      • spec.zabbix.tls
        объект

        Настройки TLS для соединения с Zabbix Server по протоколу sender.

        Сертификаты и ключи задаются содержимым в формате PEM. Режим сертификатов Zabbix (TLSAccept=cert) — это взаимный TLS: cert и key для него обязательны. Режим PSK не поддерживается.

        • spec.zabbix.tls.ca
          строка
          CA-сертификат(ы) в формате PEM для проверки сертификата Zabbix Server/Proxy. Если не задан, используется системное хранилище доверенных сертификатов.
        • spec.zabbix.tls.caFile
          Параметр устарел
          строка
          Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в ca.
        • spec.zabbix.tls.cert
          строка
          Клиентский сертификат в формате PEM, предъявляемый Zabbix Server/Proxy. Задаётся только вместе с key.
        • spec.zabbix.tls.certFile
          Параметр устарел
          строка
          Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в cert.
        • spec.zabbix.tls.insecureSkipVerify
          булевый
          Полностью отключить проверку TLS-сертификата сервера Zabbix. Требование клиентского сертификата в режиме сертификатов Zabbix при этом не снимается.
        • spec.zabbix.tls.key
          строка
          Незашифрованный приватный ключ для cert в формате PEM. Задаётся только вместе с cert.
        • spec.zabbix.tls.keyFile
          Параметр устарел
          строка
          Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в key.
        • spec.zabbix.tls.serverName
          строка
          Имя сервера для проверки TLS-сертификата (SNI). По умолчанию — spec.zabbix.server.
        • spec.zabbix.tls.skipServerNameVerification
          булевый

          Проверять цепочку сертификата сервера по ca, но не сверять сертификат с serverName.

          Нужно, когда в сертификате Zabbix нет Subject Alternative Name (Zabbix проверяет только Subject, так что это обычное дело) — иначе такой сертификат отклоняется. Требует ca: по одному системному хранилищу проверка цепочки без имени приняла бы любой публично доверенный сертификат. Игнорируется при insecureSkipVerify: true.

  • status
    объект
    Состояние канала уведомлений, включая информацию о политиках уведомлений, использующих канал.
    • status.policies
      массив объектов
      Список политик уведомлений, использующих этот канал во всех неймспейсах.
      • status.policies.name
        строка
        Имя политики уведомлений.
      • status.policies.namespace
        строка

        Неймспейс политики уведомлений.

        Пустая строка для ClusterObservabilityPropagatedNotificationPolicy.

ClusterObservabilityPropagatedNotificationPolicy

Область: Cluster
Версия: v1alpha1

Правила отправки уведомлений об алертах, которые действуют во всех неймспейсах.

При помощи политики модуль по лейблам выбирает алерты каждого неймспейса и отправляет уведомления о них в канал ClusterObservabilityPropagatedNotificationChannel. В каждом неймспейсе политика работает так же, как созданная в нём ObservabilityNotificationPolicy.

  • spec
    объект
    Параметры политики.
    • spec.alert
      объект

      Обязательный параметр

      Алерты, к которым применяется политика.
      • spec.alert.groupByLabels
        массив строк

        Лейблы, по которым алерты группируются в одно уведомление.

        Алерты с одинаковыми значениями этих лейблов отправляются одним сообщением. Если параметр не указан, по каждому алерту отправляется отдельное уведомление.

        • spec.alert.groupByLabels.Элемент массива
          строка
          Имя лейбла алерта.
      • spec.alert.selector
        объект

        Обязательный параметр

        Селектор алертов, к которым применяется политика.

        Укажите только одно из полей: matchLabels или matchExpressions.

        • spec.alert.selector.matchExpressions
          массив объектов

          Набор выражений (условий) для фильтрации алертов.

          Политика применяется к алерту, если он удовлетворяет всем условиям.

          • spec.alert.selector.matchExpressions.key
            строка
            Имя лейбла алерта.
          • spec.alert.selector.matchExpressions.operator
            строка

            Оператор сравнения:

            • Equal — значение лейбла равно value;
            • NotEqual — значение лейбла отличается от value;
            • Regex — значение лейбла соответствует регулярному выражению value;
            • NotRegex — значение лейбла не соответствует регулярному выражению value.

            Допустимые значения: Equal, NotEqual, Regex, NotRegex

          • spec.alert.selector.matchExpressions.value
            строка
            Значение или регулярное выражение, с которым сравнивается значение лейбла.
        • spec.alert.selector.matchLabels
          объект
          Лейблы и их значения, которые должны быть у алерта, чтобы к нему применялась политика.
    • spec.notification
      объект

      Обязательный параметр

      Параметры уведомлений.
      • spec.notification.channel
        объект

        Обязательный параметр

        “Канал, в который отправляются уведомления.”
        • spec.notification.channel.kind
          строка

          Обязательный параметр

          Тип объекта канала уведомлений.

          По умолчанию: ClusterObservabilityPropagatedNotificationChannel

          Допустимые значения: ClusterObservabilityPropagatedNotificationChannel

        • spec.notification.channel.name
          строка

          Обязательный параметр

          Имя объекта канала.
        • spec.notification.channel.parameters
          объект

          Обязательный параметр

          Параметры канала уведомлений.
      • spec.notification.repeatInterval
        строка

        Обязательный параметр

        Интервал повторной отправки уведомления об алерте.

        По умолчанию: 1m

  • status
    объект
    Состояние политики уведомлений.
    • status.description
      строка
      Причина, по которой модуль не применяет политику.
    • status.state
      строка

      Состояние политики:

      • Applicable — модуль отправляет уведомления в соответствии с политикой;
      • NotApplicable — модуль не применяет политику, например потому что канал не существует или parameters не соответствуют типу канала. Причина указана в поле description.

ObservabilityDashboard

Область: Namespaced
Версия: v1alpha1

Дашборд одного неймспейса в веб-интерфейсе Deckhouse.

Дашборд отображается в проекте неймспейса, в котором создан объект.

Чтобы настроить отображение дашборда, используйте следующие аннотации:

  • metadata.deckhouse.io/category — папка (категория) дашборда в интерфейсе;
  • metadata.deckhouse.io/title — название дашборда в интерфейсе. Если аннотация не указана, модуль использует название из JSON-манифеста.
  • spec
    объект
    • spec.definition
      строка

      Обязательный параметр

      JSON-манифест дашборда в виде строки, совместимой с форматом Grafana.

ObservabilityLogsRulesGroup

Короткие имена: olrg

Область: Namespaced
Версия: v1alpha1

Группа производных метрик из логов в рамках неймспейса.

Правила вычисляются сервисом logs-ruler, который выполняет LogQL-запросы к бэкенду хранения логов. Полученные временные ряды экспонируются как обычные метрики Prometheus.

Для настройки алертов на созданные производные метрики используйте ресурс ObservabilityMetricsRulesGroup.

LogQL-выражения выполняются только на логах неймспейса, в котором создан ресурс.

  • spec
    объект
    Параметры группы правил производных метрик из логов.
    • spec.interval
      строка

      Интервал вычисления правил.

      Например, 30s или 1m.

      Если параметр не указан, используется значение по умолчанию.

      По умолчанию: 1m

      Шаблон: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

    • spec.rules
      массив объектов

      Обязательный параметр

      Список правил производных метрик из логов.
      • spec.rules.expr
        строка

        LogQL-выражение для вычисления производной метрики.

        Не используйте в выражении лейбл namespace. Модуль автоматически добавляет его значение в соответствии с неймспейсом ресурса.

        Минимальная длина: 1

      • spec.rules.labels
        объект

        Дополнительные лейблы, добавляемые к создаваемым временным рядам.

        Следующие лейблы зарезервированы и не должны задаваться пользователем:

        • namespace;
        • scope_type;
        • created_by;
        • rule_group_name.
      • spec.rules.record
        строка

        Имя записываемой метрики.

        Должно соответствовать правилам именования метрик Prometheus и быть уникальным в пределах группы правил.

        Минимальная длина: 1

        Шаблон: ^[a-zA-Z_:][a-zA-Z0-9_:]*$

ObservabilityMetricsRulesGroup

Короткие имена: omrg

Область: Namespaced
Версия: v1alpha1

Группа триггеров и правил вычисления производных метрик в рамках одного неймспейса.
  • spec
    объект
    Параметры группы правил.
    • spec.interval
      строка

      Интервал вычисления правил группы.

      Например, 30s.

      Если параметр не задан, используется интервал по умолчанию.

      По умолчанию: 1m

      Шаблон: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

    • spec.rules
      массив объектов

      Обязательный параметр

      Список триггеров и правил вычисления производных метрик группы.
      • spec.rules.alert
        строка

        Имя триггера.

        Одновременно можно указать только одно из полей: alert или record.

        Шаблон: ^[a-zA-Z-:][a-zA-Z0-9-:]*$

      • spec.rules.annotations
        объект

        Аннотации для присоединения к алерту.

        Применяются только к триггерам.

      • spec.rules.expr
        строка или число
        PromQL-выражение для вычисления правила.
      • spec.rules.for
        строка

        Задержка перед срабатыванием алерта.

        Определяет время, в течение которого условие должно непрерывно выполняться, прежде чем алерт перейдёт в активное состояние (firing).

        Применяется только к триггерам.

        Шаблон: ^(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
        строка

        Задержка снятия алерта.

        Определяет время, в течение которого алерт остаётся в активном состоянии (firing) после того, как условие перестало выполняться.

        Применяется только к триггерам.

        Шаблон: ^(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
        объект
        Дополнительные лейблы для присоединения к алерту или производной метрике.
      • spec.rules.record
        строка

        Имя производной метрики, которую записывает правило.

        Одновременно можно указать только одно из полей: alert или record.

        Шаблон: ^[a-zA-Z_:][a-zA-Z0-9_:]*$

  • status
    объект
    Состояние группы правил.
    • status.conditions
      массив объектов
      Последнее доступное наблюдаемое состояние группы правил.
      • status.conditions.lastTransitionTime
        строка
        Время последнего изменения состояния условия.
      • status.conditions.message
        строка
        Человекочитаемое сообщение с деталями о последнем изменении состояния условия.
      • status.conditions.reason
        строка

        Причина последнего изменения состояния условия.

        Указывается одним словом в формате CamelCase.

      • status.conditions.status
        строка

        Текущее состояние условия:

        • True — условие выполнено;
        • False — условие не выполнено;
        • Unknown — условие не удалось определить.

        Допустимые значения: True, False, Unknown

      • status.conditions.type
        строка

        Тип состояния группы правил:

        • Created — ресурс создан;
        • Failed — синхронизация завершилась ошибкой;
        • Ready — группа правил успешно применена и активна.

        Допустимые значения: Created, Failed, Ready

    • status.lastSyncTime
      строка

      Время последней успешной синхронизации группы правил, которая изменила PrometheusRule или статус группы правил.

      Не обновляется, если синхронизация ничего не изменила.

    • status.prometheusRuleName
      строка
      Имя ресурса PrometheusRule, созданного для этой группы правил.

ObservabilityNotificationChannel

Область: Namespaced
Версия: v1alpha1

Канал уведомлений для алертов одного неймспейса.

Модуль отправляет уведомление при срабатывании алерта и при его разрешении. Правила отправки уведомлений задаются объектом ObservabilityNotificationPolicy в том же неймспейсе.

  • spec
    объект

    Параметры канала.

    Укажите type и секцию с параметрами этого типа, например type: Email и email.

    • spec.email
      объект
      Параметры канала типа Email.
      • spec.email.from
        строка

        Обязательный параметр

        Адрес электронной почты отправителя.
      • spec.email.smtp
        объект

        Обязательный параметр

        Параметры SMTP-сервера, через который отправляются письма.
        • spec.email.smtp.address
          строка

          Обязательный параметр

          Адрес SMTP-сервера в формате host:port, например smtp.example.com:587.
        • spec.email.smtp.auth
          объект
          Учётные данные для аутентификации на SMTP-сервере.
          • spec.email.smtp.auth.password
            строка

            Обязательный параметр

            Пароль.
          • spec.email.smtp.auth.username
            строка

            Обязательный параметр

            Имя пользователя.
        • spec.email.smtp.requireTLS
          булевый
          Требуется ли TLS-верификация.
      • spec.email.template
        строка
        Шаблон письма.
    • spec.expressMessenger
      объект
      Параметры канала типа ExpressMessenger.
      • spec.expressMessenger.apiUrl
        строка

        Обязательный параметр

        URL-адрес сервера eXpress CTS, например https://cts.company.ru.
      • spec.expressMessenger.botId
        строка

        Обязательный параметр

        Идентификатор (UUID) бота eXpress, от имени которого отправляются уведомления.

        Шаблон: ^[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
        строка

        Обязательный параметр

        Секретный ключ бота для аутентификации (JWT v2).
      • spec.expressMessenger.template
        строка
        Шаблон сообщения.
    • spec.slack
      объект
      Параметры канала типа Slack.
      • spec.slack.apiUrl
        строка

        Обязательный параметр

        URL-адрес API Slack.
      • spec.slack.color
        строка
        Цвет вложения сообщения.
      • spec.slack.fallback
        строка
        Резервный текст сообщения.
      • строка
        Нижний колонтитул сообщения.
      • spec.slack.iconEmoji
        строка
        Эмодзи для сообщения.
      • spec.slack.iconUrl
        строка
        URL-адрес изображения иконки в сообщении.
      • spec.slack.pretext
        строка
        Текст над основным блоком сообщения.
      • spec.slack.template
        строка
        Шаблон сообщения.
      • spec.slack.text
        строка
        Основной текст сообщения.
      • spec.slack.title
        строка
        Заголовок сообщения.
      • строка
        URL-адрес, на который ведёт заголовок.
      • spec.slack.username
        строка
        Имя отправителя сообщения.
    • spec.telegram
      объект
      Параметры канала типа Telegram.
      • spec.telegram.apiToken
        строка

        Обязательный параметр

        API-токен бота Telegram, от имени которого отправляются уведомления.
      • spec.telegram.apiUrl
        строка
        URL-адрес API Telegram Bot.

        По умолчанию: https://api.telegram.org

      • spec.telegram.httpConfig
        объект

        Параметры HTTP-клиента для запросов к Telegram API.

        Используйте proxyUrl или proxyFromEnvironment, если Telegram API доступен только через прокси.

        Укажите только один из параметров: basicAuth, authorization или oauth2.

        • spec.telegram.httpConfig.authorization
          объект
          Значение заголовка Authorization.
          • spec.telegram.httpConfig.authorization.credentials
            строка
            Значение учётных данных, подставляемое в заголовок Authorization.
          • spec.telegram.httpConfig.authorization.credentialsFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте credentials.

          • spec.telegram.httpConfig.authorization.type
            строка

            Схема аутентификации, например Bearer.

            Если параметр не указан, используется Bearer.

        • spec.telegram.httpConfig.basicAuth
          объект
          HTTP Basic-аутентификация.
          • spec.telegram.httpConfig.basicAuth.password
            строка
            Пароль.
          • spec.telegram.httpConfig.basicAuth.passwordFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте password.

          • spec.telegram.httpConfig.basicAuth.username
            строка
            Имя пользователя.
        • spec.telegram.httpConfig.enableHttp2
          булевый
          Включить поддержку HTTP/2.
        • spec.telegram.httpConfig.followRedirects
          булевый

          Устарело и игнорируется из соображений безопасности.

          Модуль не выполняет перенаправления, поскольку это заставляет Alertmanager обратиться по адресу, который выбирает получатель уведомления.

        • spec.telegram.httpConfig.httpHeaders
          объект

          Пользовательские HTTP-заголовки запросов к Telegram API.

          Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.

          • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>
            объект
            <KEY_NAME> — имя параметра (ключ объекта).
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
              массив строк

              Устарело и игнорируется из соображений безопасности.

              Содержимое файлов не подставляется в заголовки запросов. Используйте values или secrets.

            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secrets
              массив строк
              Значения заголовка, считываемые из секретов.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.values
              массив строк
              Значения заголовка.
        • spec.telegram.httpConfig.noProxy
          строка
          Список хостов через запятую, для которых прокси не применяется.
        • spec.telegram.httpConfig.oauth2
          объект
          Аутентификация OAuth 2.0.
          • spec.telegram.httpConfig.oauth2.clientId
            строка

            Обязательный параметр

            Идентификатор клиента OAuth 2.0.
          • spec.telegram.httpConfig.oauth2.clientSecret
            строка
            Секрет клиента OAuth 2.0.
          • spec.telegram.httpConfig.oauth2.clientSecretFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте clientSecret.

          • spec.telegram.httpConfig.oauth2.endpointParams
            объект
            Дополнительные параметры, передаваемые в запросе на получение токена.
          • spec.telegram.httpConfig.oauth2.noProxy
            строка
            Список хостов через запятую, для которых прокси не применяется.
          • spec.telegram.httpConfig.oauth2.proxyFromEnvironment
            булевый
            Использовать прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
          • spec.telegram.httpConfig.oauth2.proxyUrl
            строка
            URL-адрес HTTP-прокси, используемого для запроса токена.
          • spec.telegram.httpConfig.oauth2.scopes
            массив строк
            Области доступа (scopes), которые запрашиваются для токена.
            • spec.telegram.httpConfig.oauth2.scopes.Элемент массива
              строка
              Имя области доступа.
          • spec.telegram.httpConfig.oauth2.tlsConfig
            объект
            Настройки TLS для запроса токена.
            • spec.telegram.httpConfig.oauth2.tlsConfig.caFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.telegram.httpConfig.oauth2.tlsConfig.certFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              булевый
              Отключить проверку TLS-сертификата сервера.
            • spec.telegram.httpConfig.oauth2.tlsConfig.keyFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.telegram.httpConfig.oauth2.tlsConfig.maxVersion
              строка
              Максимальная версия TLS.
            • spec.telegram.httpConfig.oauth2.tlsConfig.minVersion
              строка
              Минимальная версия TLS.
            • spec.telegram.httpConfig.oauth2.tlsConfig.serverName
              строка
              Имя сервера для проверки TLS-сертификата (SNI).
          • spec.telegram.httpConfig.oauth2.tokenUrl
            строка

            Обязательный параметр

            URL-адрес эндпоинта для получения токена.
        • spec.telegram.httpConfig.proxyConnectHeader
          объект

          Заголовки CONNECT-запросов к прокси.

          Имена заголовков сопоставляются со списком значений.

        • spec.telegram.httpConfig.proxyFromEnvironment
          булевый
          Использовать прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
        • spec.telegram.httpConfig.proxyUrl
          строка
          URL-адрес HTTP-прокси для запросов к Telegram API.
        • spec.telegram.httpConfig.tlsConfig
          объект
          Настройки TLS для HTTP-клиента Telegram-получателя.
          • spec.telegram.httpConfig.tlsConfig.caFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.telegram.httpConfig.tlsConfig.certFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.telegram.httpConfig.tlsConfig.insecureSkipVerify
            булевый
            Отключить проверку TLS-сертификата сервера.
          • spec.telegram.httpConfig.tlsConfig.keyFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.telegram.httpConfig.tlsConfig.maxVersion
            строка
            Максимальная версия TLS.
          • spec.telegram.httpConfig.tlsConfig.minVersion
            строка
            Минимальная версия TLS.
          • spec.telegram.httpConfig.tlsConfig.serverName
            строка
            Имя сервера для проверки TLS-сертификата (SNI).
      • spec.telegram.template
        строка
        Шаблон сообщения.
    • spec.type
      строка

      Обязательный параметр

      Тип канала уведомлений.

      Допустимые значения: Email, Slack, Telegram, Webhook, ExpressMessenger, Zabbix

    • spec.webhook
      объект
      Параметры канала типа Webhook.
      • spec.webhook.httpConfig
        объект

        Параметры HTTP-клиента для запросов на URL-адрес вебхука.

        Укажите только один из параметров: basicAuth, authorization или oauth2.

        • spec.webhook.httpConfig.authorization
          объект
          Значение заголовка Authorization.
          • spec.webhook.httpConfig.authorization.credentials
            строка
            Значение учётных данных, подставляемое в заголовок Authorization.
          • spec.webhook.httpConfig.authorization.credentialsFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте credentials.

          • spec.webhook.httpConfig.authorization.type
            строка

            Схема аутентификации, например Bearer.

            Если параметр не указан, используется Bearer.

        • spec.webhook.httpConfig.basicAuth
          объект
          HTTP Basic-аутентификация.
          • spec.webhook.httpConfig.basicAuth.password
            строка
            Пароль.
          • spec.webhook.httpConfig.basicAuth.passwordFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте password.

          • spec.webhook.httpConfig.basicAuth.username
            строка
            Имя пользователя.
        • spec.webhook.httpConfig.enableHttp2
          булевый
          Включить поддержку HTTP/2 для вебхук-запросов.
        • spec.webhook.httpConfig.followRedirects
          булевый

          Устарело и игнорируется из соображений безопасности.

          Модуль не выполняет HTTP-перенаправления.

        • spec.webhook.httpConfig.httpHeaders
          объект

          Пользовательские HTTP-заголовки запросов на URL-адрес вебхука.

          Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.

          • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>
            объект
            <KEY_NAME> — имя параметра (ключ объекта).
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
              массив строк

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager. Используйте values или secrets.

            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secrets
              массив строк
              Значения заголовка, считываемые из секретов.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.values
              массив строк
              Значения заголовка.
        • spec.webhook.httpConfig.noProxy
          строка
          Список хостов через запятую, к которым запросы выполняются без прокси.
        • spec.webhook.httpConfig.oauth2
          объект
          Аутентификация OAuth 2.0.
          • spec.webhook.httpConfig.oauth2.clientId
            строка

            Обязательный параметр

            Идентификатор клиента OAuth 2.0.
          • spec.webhook.httpConfig.oauth2.clientSecret
            строка
            Секрет клиента OAuth 2.0.
          • spec.webhook.httpConfig.oauth2.clientSecretFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager. Используйте clientSecret.

          • spec.webhook.httpConfig.oauth2.endpointParams
            объект
            Дополнительные параметры, передаваемые в запросе на получение токена.
          • spec.webhook.httpConfig.oauth2.noProxy
            строка
            Список хостов через запятую, для которых прокси не применяется.
          • spec.webhook.httpConfig.oauth2.proxyFromEnvironment
            булевый
            Использовать прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
          • spec.webhook.httpConfig.oauth2.proxyUrl
            строка
            URL-адрес HTTP-прокси, используемого для запроса токена.
          • spec.webhook.httpConfig.oauth2.scopes
            массив строк
            Области доступа (scopes), которые запрашиваются для токена.
            • spec.webhook.httpConfig.oauth2.scopes.Элемент массива
              строка
              Имя области доступа.
          • spec.webhook.httpConfig.oauth2.tlsConfig
            объект
            Настройки TLS для запроса токена.
            • spec.webhook.httpConfig.oauth2.tlsConfig.caFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.webhook.httpConfig.oauth2.tlsConfig.certFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              булевый
              Отключить проверку TLS-сертификата сервера.
            • spec.webhook.httpConfig.oauth2.tlsConfig.keyFile
              строка

              Устарело и игнорируется из соображений безопасности.

              Модуль не читает файлы из контейнера Alertmanager.

            • spec.webhook.httpConfig.oauth2.tlsConfig.maxVersion
              строка
              Максимальная версия TLS.
            • spec.webhook.httpConfig.oauth2.tlsConfig.minVersion
              строка
              Минимальная версия TLS.
            • spec.webhook.httpConfig.oauth2.tlsConfig.serverName
              строка
              Имя сервера для проверки TLS-сертификата (SNI).
          • spec.webhook.httpConfig.oauth2.tokenUrl
            строка

            Обязательный параметр

            URL-адрес эндпоинта для получения токена.
        • spec.webhook.httpConfig.proxyConnectHeader
          объект

          Заголовки CONNECT-запросов к прокси.

          Имена заголовков сопоставляются со списком значений.

        • spec.webhook.httpConfig.proxyFromEnvironment
          булевый
          Использовать параметры прокси из переменных окружения HTTP_PROXY, HTTPS_PROXY и NO_PROXY.
        • spec.webhook.httpConfig.proxyUrl
          строка
          URL-адрес HTTP-прокси для вебхук-запросов.
        • spec.webhook.httpConfig.tlsConfig
          объект
          Настройки TLS для запросов на URL-адрес вебхука.
          • spec.webhook.httpConfig.tlsConfig.caFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.webhook.httpConfig.tlsConfig.certFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.webhook.httpConfig.tlsConfig.insecureSkipVerify
            булевый
            Отключить проверку TLS-сертификата сервера.
          • spec.webhook.httpConfig.tlsConfig.keyFile
            строка

            Устарело и игнорируется из соображений безопасности.

            Модуль не читает файлы из контейнера Alertmanager.

          • spec.webhook.httpConfig.tlsConfig.maxVersion
            строка
            Максимальная версия TLS.
          • spec.webhook.httpConfig.tlsConfig.minVersion
            строка
            Минимальная версия TLS.
          • spec.webhook.httpConfig.tlsConfig.serverName
            строка
            Имя сервера для проверки TLS-сертификата (SNI).
      • spec.webhook.url
        строка

        Обязательный параметр

        URL-адрес вебхука.

        Модуль отправляет уведомления на указанный URL-адрес в формате JSON вебхука Alertmanager.

        Минимальная длина: 1

    • spec.zabbix
      объект
      Параметры канала типа Zabbix.
      • spec.zabbix.api
        объект

        Подключение к API Zabbix для автоматического импорта шаблона.

        Если секция указана, модуль импортирует шаблон и создаёт узел сети и группу узлов сети кластера через JSON-RPC API Zabbix. Иначе импортируйте шаблон из ConfigMap вручную.

        • spec.zabbix.api.tlsConfig
          объект
          Настройки TLS для HTTPS-соединения с API Zabbix. Сертификаты и ключи задаются содержимым в формате PEM.
          • spec.zabbix.api.tlsConfig.ca
            строка
            CA-сертификат(ы) в формате PEM для проверки сертификата API-сервера Zabbix. Если не задан, используется системное хранилище доверенных сертификатов.
          • spec.zabbix.api.tlsConfig.caFile
            Параметр устарел
            строка
            Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в ca.
          • spec.zabbix.api.tlsConfig.cert
            строка
            Клиентский сертификат в формате PEM для API за взаимным TLS. Задаётся только вместе с key.
          • spec.zabbix.api.tlsConfig.certFile
            Параметр устарел
            строка
            Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в cert.
          • spec.zabbix.api.tlsConfig.insecureSkipVerify
            булевый
            Отключить проверку TLS-сертификата API-сервера Zabbix.
          • spec.zabbix.api.tlsConfig.key
            строка
            Незашифрованный приватный ключ для cert в формате PEM. Задаётся только вместе с cert.
          • spec.zabbix.api.tlsConfig.keyFile
            Параметр устарел
            строка
            Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в key.
          • spec.zabbix.api.tlsConfig.serverName
            строка
            Имя сервера для проверки TLS-сертификата (SNI). По умолчанию — хост из url.
        • spec.zabbix.api.token
          строка

          Обязательный параметр

          Токен API Zabbix для аутентификации вызовов “configuration.import”.

          Токен хранится в этом ресурсе в открытом виде.

          Минимальная длина: 1

        • spec.zabbix.api.url
          строка

          Обязательный параметр

          URL-адрес JSON-RPC API Zabbix, например https://zabbix.example.com/api_jsonrpc.php.

          Если схема не указана, используется https://.

          Минимальная длина: 1

      • spec.zabbix.clusterName
        строка

        Обязательный параметр

        Имя кластера в Zabbix.

        Имя становится техническим именем узла сети (host) Zabbix, который принимает данные. Оно должно быть уникальным среди всех кластеров и каналов, которые отправляют данные в один экземпляр Zabbix.

        Минимальная длина: 1

      • spec.zabbix.disableTLS
        булевый

        Подключаться к trapper-порту без использования TLS.

        Если параметр выключен, соединение использует TLS с настройками из tls. Если tls не указан, выполняется проверка сертификата.

        По умолчанию: false

      • spec.zabbix.hostGroup
        строка
        Группа узлов сети (host group) Zabbix, в которую добавляется узел сети кластера.

        По умолчанию: Deckhouse

      • spec.zabbix.port
        целое число
        Trapper-порт Zabbix Server или Zabbix Proxy.

        По умолчанию: 10051

      • spec.zabbix.server
        строка

        Обязательный параметр

        Адрес Zabbix Server или Zabbix Proxy, на который отправляются trapper-данные.

        Минимальная длина: 1

      • spec.zabbix.tls
        объект

        Настройки TLS для соединения с Zabbix по протоколу sender.

        Сертификаты и ключи задаются содержимым в формате PEM. Режим сертификатов Zabbix (TLSAccept=cert) — это взаимный TLS: cert и key для него обязательны. Режим PSK не поддерживается.

        • spec.zabbix.tls.ca
          строка
          CA-сертификат(ы) в формате PEM для проверки сертификата Zabbix Server/Proxy. Если не задан, используется системное хранилище доверенных сертификатов.
        • spec.zabbix.tls.caFile
          Параметр устарел
          строка
          Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в ca.
        • spec.zabbix.tls.cert
          строка
          Клиентский сертификат в формате PEM, предъявляемый Zabbix Server/Proxy. Задаётся только вместе с key.
        • spec.zabbix.tls.certFile
          Параметр устарел
          строка
          Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в cert.
        • spec.zabbix.tls.insecureSkipVerify
          булевый
          Полностью отключить проверку TLS-сертификата сервера Zabbix. Требование клиентского сертификата в режиме сертификатов Zabbix при этом не снимается.
        • spec.zabbix.tls.key
          строка
          Незашифрованный приватный ключ для cert в формате PEM. Задаётся только вместе с cert.
        • spec.zabbix.tls.keyFile
          Параметр устарел
          строка
          Устарело и игнорируется из соображений безопасности: путь к файлу больше не читается. Укажите содержимое PEM в key.
        • spec.zabbix.tls.serverName
          строка
          Имя сервера для проверки TLS-сертификата (SNI). По умолчанию — spec.zabbix.server.
        • spec.zabbix.tls.skipServerNameVerification
          булевый

          Проверять цепочку сертификата сервера по ca, но не сверять сертификат с serverName.

          Нужно, когда в сертификате Zabbix нет Subject Alternative Name (Zabbix проверяет только Subject, так что это обычное дело) — иначе такой сертификат отклоняется. Требует ca: по одному системному хранилищу проверка цепочки без имени приняла бы любой публично доверенный сертификат. Игнорируется при insecureSkipVerify: true.

  • status
    объект
    Состояние канала уведомлений, включая информацию о политиках уведомлений, использующих канал.
    • status.policies
      массив строк
      Имена объектов ObservabilityNotificationPolicy, которые используют канал.
      • status.policies.Элемент массива
        строка
        Имя политики уведомлений.

ObservabilityNotificationPolicy

Область: Namespaced
Версия: v1alpha1

Правила отправки уведомлений об алертах одного неймспейса.

При помощи политики модуль по лейблам выбирает алерты неймспейса, в котором создан объект, и отправляет уведомления о них в канал ObservabilityNotificationChannel из того же неймспейса или ClusterObservabilityPropagatedNotificationChannel.

  • spec
    объект
    Параметры политики.
    • spec.alert
      объект

      Обязательный параметр

      Алерты, к которым применяется политика.
      • spec.alert.groupByLabels
        массив строк

        Лейблы, по которым алерты группируются в одно уведомление.

        Алерты с одинаковыми значениями этих лейблов отправляются одним сообщением. Если параметр не указан, по каждому алерту отправляется отдельное уведомление.

        • spec.alert.groupByLabels.Элемент массива
          строка
          Имя лейбла алерта.
      • spec.alert.selector
        объект

        Обязательный параметр

        Селектор алертов, к которым применяется политика.

        Укажите только одно из полей: matchLabels или matchExpressions.

        • spec.alert.selector.matchExpressions
          массив объектов

          Набор выражений (условий) для фильтрации алертов.

          Политика применяется к алерту, если он удовлетворяет всем условиям.

          • spec.alert.selector.matchExpressions.key
            строка
            Имя лейбла алерта.
          • spec.alert.selector.matchExpressions.operator
            строка

            Оператор сравнения:

            • Equal — значение лейбла равно value;
            • NotEqual — значение лейбла отличается от value;
            • Regex — значение лейбла соответствует регулярному выражению value;
            • NotRegex — значение лейбла не соответствует регулярному выражению value.

            Допустимые значения: Equal, NotEqual, Regex, NotRegex

          • spec.alert.selector.matchExpressions.value
            строка
            Значение или регулярное выражение, с которым сравнивается значение лейбла.
        • spec.alert.selector.matchLabels
          объект
          Лейблы и их значения, которые должны быть у алерта, чтобы к нему применялась политика.
    • spec.notification
      объект

      Обязательный параметр

      Параметры уведомлений.
      • spec.notification.channel
        объект

        Обязательный параметр

        Канал, в который отправляются уведомления.
        • spec.notification.channel.kind
          строка

          Обязательный параметр

          Тип объекта канала уведомлений:

          • ObservabilityNotificationChannel — канал из неймспейса политики;
          • ClusterObservabilityPropagatedNotificationChannel — канал, доступный во всех неймспейсах.

          По умолчанию: ObservabilityNotificationChannel

          Допустимые значения: ClusterObservabilityPropagatedNotificationChannel, ObservabilityNotificationChannel

        • spec.notification.channel.name
          строка

          Обязательный параметр

          Имя объекта канала.
        • spec.notification.channel.parameters
          объект

          Обязательный параметр

          Параметры канала уведомлений.
      • spec.notification.repeatInterval
        строка

        Обязательный параметр

        Интервал повторной отправки уведомления об алерте.

        По умолчанию: 1m

  • status
    объект
    Состояние политики уведомлений.
    • status.description
      строка
      Причина, по которой модуль не применяет политику.
    • status.state
      строка

      Состояние политики:

      • Applicable — модуль отправляет уведомления в соответствии с политикой;
      • NotApplicable — модуль не применяет политику, например потому что канал не существует или parameters не соответствуют типу канала. Причина указана в поле description.

ObservabilityNotificationSilence

Область: Namespaced
Версия: v1alpha1

Временное отключение (silence) отправки уведомлений об алертах одного неймспейса.

Во время отключения модуль не отправляет уведомления об алертах неймспейса, в котором создан объект, если они соответствуют spec.selector.

  • spec
    объект
    Параметры отключения.
    • spec.endsAt
      строка

      Обязательный параметр

      Время окончания отключения.
    • spec.selector
      объект

      Обязательный параметр

      Селектор алертов, уведомления о которых отключаются.

      Укажите только одно из полей: matchLabels или matchExpressions.

      • spec.selector.matchExpressions
        массив объектов

        Набор выражений (условий) для фильтрации алертов.

        Уведомления по алерту отключаются, если он удовлетворяет всем условиям.

        • spec.selector.matchExpressions.key
          строка
          Имя лейбла алерта.
        • spec.selector.matchExpressions.operator
          строка

          Оператор сравнения:

          • Equal — значение лейбла равно value;
          • NotEqual — значение лейбла отличается от value;
          • Regex — значение лейбла соответствует регулярному выражению value;
          • NotRegex — значение лейбла не соответствует регулярному выражению value.

          Допустимые значения: Equal, NotEqual, Regex, NotRegex

        • spec.selector.matchExpressions.value
          строка
          Значение или регулярное выражение, с которым сравнивается значение лейбла.
      • spec.selector.matchLabels
        объект
        Лейблы и их значения, которые должны быть у алерта, чтобы уведомления о нём отключились.
    • spec.startsAt
      строка

      Обязательный параметр

      Время начала отключения.