Стадия жизненного цикла модуля: General Availability
У модуля есть требования для установки
Deckhouse Kubernetes Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.
ClusterLog
Scope: Cluster
Version: v1alpha1
ClusterObservabilityAlertAdditionalLabels
Scope: Cluster
Version: v1alpha1
Описывает дополнительные лейблы, которые будут добавлены к уведомлениям алертов, поставляемых с DKP.
Если у алерта уже есть лейбл с таким ключом, его значение не изменяется.
Внимание. Дополнительные лейблы применяются только к алертам, созданным с помощью ресурсов с лейблом
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
Scope: Cluster
Version: v1alpha1
Определяет дашборд кластерного уровня, отображаемый в интерфейсе Deckhouse Console.
Этот ресурс не привязан к какому-либо пространству имён.
Поддерживаются аннотации:
metadata.deckhouse.io/category— задаёт папку (категорию) в интерфейсе;metadata.deckhouse.io/title— задаёт отображаемое название дашборда. Если не указано, будет использовано название из JSON-манифеста.
-
объектspec
-
строкаspec.definition
Обязательный параметр
JSON-манифест дашборда. JSON должен быть передан в виде строки, совместимой с форматом Grafana dashboard.
-
ClusterObservabilityMetricsRulesGroup
Scope: Cluster
Version: 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Время последней успешной синхронизации группы правил кластера.
-
строкаstatus.prometheusRuleNameИмя ресурса PrometheusRule, созданного для этой группы правил кластера.
-
ClusterObservabilityNotificationChannel
Scope: Cluster
Version: v1alpha1
-
объектspec
-
объектspec.emailПараметры Email канала.
-
строкаspec.email.from
Обязательный параметр
Email адрес отправителя. -
объектspec.email.smtp
Обязательный параметр
SMTP-параметры отправителя.-
строкаspec.email.smtp.address
Обязательный параметр
Email-адрес получателя. -
объектspec.email.smtp.authАвторизационные параметры отправителя.
-
строкаspec.email.smtp.auth.password
Обязательный параметр
Пароль. -
строкаspec.email.smtp.auth.username
Обязательный параметр
Имя пользователя.
-
-
булевыйspec.email.smtp.requireTLSТребуется ли TLS верификация.
-
-
строкаspec.email.templateШаблон письма.
-
-
объектspec.expressMessengerПараметры канала eXpress Messenger.
-
строка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
Обязательный параметр
API URL Slack-а. -
строкаspec.slack.colorЦвет вложения сообщения в Slack.
-
строкаspec.slack.fallbackРезервный текст для сообщения в Slack.
-
строкаНижний колонтитул для сообщения в Slack.
-
строкаspec.slack.iconEmojiЭмодзи иконка для сообщения в Slack.
-
строкаspec.slack.iconUrlURL для изображения иконки.
-
строкаspec.slack.pretextТекст, отображаемый над основным блоком сообщения в Slack (pretext).
-
строкаspec.slack.templateШаблон сообщения Slack.
-
строкаspec.slack.textОсновной текст сообщения в Slack.
-
строкаspec.slack.titleЗаголовок сообщения в Slack.
-
строкаspec.slack.titleLinkURL для ссылки в заголовке.
-
строкаspec.slack.usernameИмя пользователя для сообщения в Slack.
-
-
объектspec.telegramПараметры Telegram канала.
-
строкаspec.telegram.apiToken
Обязательный параметр
API-токен Telegram. -
строкаspec.telegram.apiUrlAPI URL Telegram-а.
По умолчанию:
https://api.telegram.org -
объектspec.telegram.httpConfigПараметры HTTP-клиента для Telegram-получателя Alertmanager (
http_config). ИспользуйтеproxyUrlилиproxyFromEnvironment, если Telegram API доступен только через прокси. ПараметрыbasicAuthиauthorizationне могут использоваться одновременно. Параметрoauth2не может использоваться одновременно сbasicAuthилиauthorization.-
объектspec.telegram.httpConfig.authorizationСтатический HTTP-заголовок
Authorization. Взаимоисключим сbasicAuth.-
строкаspec.telegram.httpConfig.authorization.credentialsЗначение учётных данных, подставляемое в заголовок
Authorization. -
строкаspec.telegram.httpConfig.authorization.credentialsFileПуть к файлу с учётными данными, доступному внутри контейнера Alertmanager.
-
строкаspec.telegram.httpConfig.authorization.typeСхема аутентификации (по умолчанию в Alertmanager используется
Bearer, если не задано).
-
-
объектspec.telegram.httpConfig.basicAuthHTTP Basic-аутентификация для исходящих запросов к Telegram API.
-
строкаspec.telegram.httpConfig.basicAuth.passwordПароль.
-
строкаspec.telegram.httpConfig.basicAuth.passwordFileПуть к файлу с паролем, доступному внутри контейнера Alertmanager.
-
строкаspec.telegram.httpConfig.basicAuth.usernameИмя пользователя.
-
-
булевыйspec.telegram.httpConfig.enableHttp2Включить поддержку HTTP/2 для запросов к Telegram API.
-
булевыйspec.telegram.httpConfig.followRedirectsСледовать ли HTTP-редиректам при отправке запроса к Telegram API.
-
объектspec.telegram.httpConfig.httpHeadersПользовательские HTTP-заголовки, добавляемые к запросам к Telegram API. Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.
-
объектspec.telegram.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— имя параметра (ключ объекта).-
массив строкspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.filesСписок значений заголовка, считываемых из файлов.
-
массив строкspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secretsСписок значений заголовка, считываемых из секретов.
-
массив строкspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.valuesСписок значений заголовка, заданных в открытом виде.
-
-
-
строкаspec.telegram.httpConfig.noProxyСписок хостов через запятую, для которых прокси не применяется.
-
объектspec.telegram.httpConfig.oauth2Учётные данные клиента OAuth2. Взаимоисключим с
basicAuthиauthorization.-
строкаspec.telegram.httpConfig.oauth2.clientId
Обязательный параметр
Идентификатор клиента OAuth2. -
строкаspec.telegram.httpConfig.oauth2.clientSecretСекрет клиента OAuth2.
-
строкаspec.telegram.httpConfig.oauth2.clientSecretFileПуть к файлу с секретом клиента OAuth2.
-
объект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.proxyUrlURL HTTP-прокси, используемого для запроса токена.
-
массив строкspec.telegram.httpConfig.oauth2.scopesСписок запрашиваемых OAuth2-скоупов.
-
объектspec.telegram.httpConfig.oauth2.tlsConfigНастройки TLS для запроса токена OAuth2.
-
строкаspec.telegram.httpConfig.oauth2.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.telegram.httpConfig.oauth2.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.telegram.httpConfig.oauth2.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строка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 для получения токена OAuth2.
-
-
объектspec.telegram.httpConfig.proxyConnectHeaderЗаголовки, добавляемые к
CONNECT-запросам к прокси (имена заголовков сопоставлены со списком значений). -
булевыйspec.telegram.httpConfig.proxyFromEnvironmentИспользовать параметры прокси из переменных окружения (
HTTP_PROXY,HTTPS_PROXY,NO_PROXY). -
строкаspec.telegram.httpConfig.proxyUrlURL HTTP-прокси для запросов к Telegram API.
-
объектspec.telegram.httpConfig.tlsConfigНастройки TLS для HTTP-клиента Telegram-получателя.
-
строкаspec.telegram.httpConfig.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.telegram.httpConfig.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.telegram.httpConfig.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.telegram.httpConfig.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строкаspec.telegram.httpConfig.tlsConfig.maxVersionМаксимальная допустимая версия TLS.
-
строкаspec.telegram.httpConfig.tlsConfig.minVersionМинимальная допустимая версия TLS.
-
строкаspec.telegram.httpConfig.tlsConfig.serverNameИмя сервера для проверки TLS-сертификата (SNI).
-
-
-
строкаspec.telegram.templateШаблон сообщения Telegram.
-
-
строкаspec.type
Обязательный параметр
Тип канала уведомлений.Допустимые значения:
Email,Slack,Telegram,Webhook,ExpressMessenger -
объектspec.webhookПараметры канала Webhook.
-
объектspec.webhook.httpConfigПараметры HTTP-клиента для webhook-получателя Alertmanager (
http_config). ПараметрыbasicAuthиauthorizationне могут использоваться одновременно. Параметрoauth2не может использоваться одновременно сbasicAuthилиauthorization.-
объектspec.webhook.httpConfig.authorizationСтатический HTTP-заголовок
Authorization. Взаимоисключим сbasicAuth.-
строкаspec.webhook.httpConfig.authorization.credentialsЗначение учётных данных, подставляемое в заголовок
Authorization. -
строкаspec.webhook.httpConfig.authorization.credentialsFileПуть к файлу с учётными данными, доступному внутри контейнера Alertmanager.
-
строкаspec.webhook.httpConfig.authorization.typeСхема аутентификации (по умолчанию в Alertmanager используется
Bearer, если не задано).
-
-
объектspec.webhook.httpConfig.basicAuthHTTP Basic-аутентификация для webhook-запросов.
-
строкаspec.webhook.httpConfig.basicAuth.passwordПароль.
-
строкаspec.webhook.httpConfig.basicAuth.passwordFileПуть к файлу с паролем, доступному внутри контейнера Alertmanager.
-
строкаspec.webhook.httpConfig.basicAuth.usernameИмя пользователя.
-
-
булевыйspec.webhook.httpConfig.enableHttp2Включить поддержку HTTP/2 для webhook-запросов.
-
булевыйspec.webhook.httpConfig.followRedirectsСледовать ли HTTP-редиректам при отправке webhook-запроса.
-
объектspec.webhook.httpConfig.httpHeadersПользовательские HTTP-заголовки, добавляемые к webhook-запросам. Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.
-
объектspec.webhook.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— имя параметра (ключ объекта).-
массив строкspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.filesСписок значений заголовка, считываемых из файлов.
-
массив строкspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secretsСписок значений заголовка, считываемых из секретов.
-
массив строкspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.valuesСписок значений заголовка, заданных в открытом виде.
-
-
-
строкаspec.webhook.httpConfig.noProxyСписок хостов через запятую, для которых прокси не применяется.
-
объектspec.webhook.httpConfig.oauth2Учётные данные клиента OAuth2. Взаимоисключим с
basicAuthиauthorization.-
строкаspec.webhook.httpConfig.oauth2.clientId
Обязательный параметр
Идентификатор клиента OAuth2. -
строкаspec.webhook.httpConfig.oauth2.clientSecretСекрет клиента OAuth2.
-
строкаspec.webhook.httpConfig.oauth2.clientSecretFileПуть к файлу с секретом клиента OAuth2.
-
объект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.proxyUrlURL HTTP-прокси, используемого для запроса токена.
-
массив строкspec.webhook.httpConfig.oauth2.scopesСписок запрашиваемых OAuth2-скоупов.
-
объектspec.webhook.httpConfig.oauth2.tlsConfigНастройки TLS для запроса токена OAuth2.
-
строкаspec.webhook.httpConfig.oauth2.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.webhook.httpConfig.oauth2.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.webhook.httpConfig.oauth2.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строка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 для получения токена OAuth2.
-
-
объектspec.webhook.httpConfig.proxyConnectHeaderЗаголовки, добавляемые к
CONNECT-запросам к прокси (имена заголовков сопоставлены со списком значений). -
булевыйspec.webhook.httpConfig.proxyFromEnvironmentИспользовать параметры прокси из переменных окружения (
HTTP_PROXY,HTTPS_PROXY,NO_PROXY). -
строкаspec.webhook.httpConfig.proxyUrlURL HTTP-прокси для webhook-запросов.
-
объектspec.webhook.httpConfig.tlsConfigНастройки TLS для HTTP-клиента webhook.
-
строкаspec.webhook.httpConfig.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.webhook.httpConfig.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.webhook.httpConfig.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.webhook.httpConfig.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строкаspec.webhook.httpConfig.tlsConfig.maxVersionМаксимальная допустимая версия TLS.
-
строкаspec.webhook.httpConfig.tlsConfig.minVersionМинимальная допустимая версия TLS.
-
строкаspec.webhook.httpConfig.tlsConfig.serverNameИмя сервера для проверки TLS-сертификата (SNI).
-
-
-
строкаspec.webhook.url
Обязательный параметр
Адрес Webhook-а.Минимальная длина:
1
-
-
-
объектstatusИнформация о статусе канала уведомлений, включая политики, которые его используют.
-
массив объектовstatus.policiesСписок политик уведомлений, использующих этот канал во всех пространствах имён.
-
строкаstatus.policies.nameИмя политики уведомлений, использующей этот канал.
-
строкаstatus.policies.namespaceПространство имён политики уведомлений. Пустая строка для политик уровня кластера.
-
-
ClusterObservabilityNotificationPolicy
Scope: Cluster
Version: v1alpha1
-
объектspec
-
объектspec.alert
Обязательный параметр
Условия фильтрации алертов: по каким алертам будет применяться данная политика уведомлений.-
массив строкspec.alert.groupByLabelsСписок лейблов, по которым алерты группируются в одно уведомление: алерты с одинаковыми значениями указанных лейблов будут объединены и отправлены в канал как одно сообщение.
-
строкаspec.alert.groupByLabels.Элемент массиваИмя лейбла.
-
-
объектspec.alert.selector
Обязательный параметр
Селектор алертов по лейблам — описывает, какие именно алерты попадают под политику. Должен быть задан либо matchLabels, либо matchExpressions.-
массив объектовspec.alert.selector.matchExpressionsНабор выражений для фильтрации алертов. Позволяет задать более гибкие условия, чем matchLabels.
-
строкаspec.alert.selector.matchExpressions.keyИмя лейбла алерта, по которому проверяется условие фильтрации.
-
строкаspec.alert.selector.matchExpressions.operatorОператор сравнения (In, NotIn, Exists, DoesNotExist).
Допустимые значения:
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
-
ClusterObservabilityNotificationSilence
Scope: Cluster
Version: v1alpha1
-
объектspec
-
строкаspec.endsAt
Обязательный параметр
Время окончания отключения уведомлений. -
объектspec.selector
Обязательный параметр
Селектор алертов по лейблам — описывает, какие именно алерты попадают под silence. Должен быть задан либо matchLabels, либо matchExpressions.-
массив объектовspec.selector.matchExpressionsНабор выражений для фильтрации алертов. Позволяет задать более гибкие условия, чем matchLabels.
-
строкаspec.selector.matchExpressions.keyИмя лейбла алерта, по которому проверяется условие фильтрации.
-
строкаspec.selector.matchExpressions.operatorОператор сравнения (In, NotIn, Exists, DoesNotExist).
Допустимые значения:
Equal,NotEqual,Regex,NotRegex -
строкаspec.selector.matchExpressions.valueЗначение для сравнения с лейблом алерта.
-
-
объектspec.selector.matchLabelsНабор лейблов для фильтрации алертов. Уведомления по алертам, лейблы которых совпадают с указанными, не будут отправлены в течение действия silence.
-
-
строкаspec.startsAt
Обязательный параметр
Время начала отключения уведомлений.
-
ClusterObservabilityPropagatedDashboard
Scope: Cluster
Version: v1alpha1
Это служебный ресурс Deckhouse, позволяющий один раз описать дашборд и автоматически сделать его доступным во всех областях Deckhouse Console.
После создания ресурса он автоматически доступен как дашборд: на уровне кластера и во всех пространствах имён/проектах.
Поддерживаются аннотации:
metadata.deckhouse.io/category— задаёт папку (категорию) в интерфейсе;metadata.deckhouse.io/title— задаёт отображаемое название дашборда. Если не указано, будет использовано название из JSON-манифеста.
-
объектspec
-
строкаspec.definition
Обязательный параметр
JSON-манифест дашборда. JSON должно быть передано в виде строки, совместимым с форматом Grafana dashboard.
-
ClusterObservabilityPropagatedMetricsRulesGroup
Scope: Cluster
Version: v1alpha1
-
объектspecClusterObservabilityPropagatedMetricsRulesGroupSpec определяет желаемое состояние распространяемой группы правил
-
строка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Имя алерта. Обязательно для правил алертинга, взаимоисключающее с record.
Шаблон:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
объектspec.rules.annotationsАннотации для присоединения к алерту (не действительны для правил записи)
-
строка или числоspec.rules.exprPromQL выражение для вычисления. К распространяемым правилам не будет применяться принудительное ограничение по пространствам имён.
-
строка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.
Шаблон:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
-
объектstatusClusterObservabilityPropagatedMetricsRulesGroupStatus определяет наблюдаемое состояние распространяемой группы правил
-
массив объектов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Время последней успешной синхронизации распространяемой группы правил
-
строкаstatus.prometheusRuleNameИмя ресурса PrometheusRule, созданного для этой распространяемой группы правил
-
ClusterObservabilityPropagatedNotificationChannel
Scope: Cluster
Version: v1alpha1
-
объектspec
-
объектspec.emailПараметры Email канала.
-
строкаspec.email.from
Обязательный параметр
Email адрес отправителя. -
объектspec.email.smtp
Обязательный параметр
SMTP-параметры отправителя.-
строкаspec.email.smtp.address
Обязательный параметр
Email-адрес получателя. -
объектspec.email.smtp.authАвторизационные параметры отправителя.
-
строкаspec.email.smtp.auth.password
Обязательный параметр
Пароль. -
строкаspec.email.smtp.auth.username
Обязательный параметр
Имя пользователя.
-
-
булевыйspec.email.smtp.requireTLSТребуется ли TLS верификация.
-
-
строкаspec.email.templateШаблон письма.
-
-
объектspec.expressMessengerПараметры канала eXpress Messenger.
-
строка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
Обязательный параметр
API URL Slack-а. -
строкаspec.slack.colorЦвет вложения сообщения в Slack.
-
строкаspec.slack.fallbackРезервный текст для сообщения в Slack.
-
строкаНижний колонтитул для сообщения в Slack.
-
строкаspec.slack.iconEmojiЭмодзи иконка для сообщения в Slack.
-
строкаspec.slack.iconUrlURL для изображения иконки.
-
строкаspec.slack.pretextТекст, отображаемый над основным блоком сообщения в Slack (pretext).
-
строкаspec.slack.templateШаблон сообщения Slack.
-
строкаspec.slack.textОсновной текст сообщения в Slack.
-
строкаspec.slack.titleЗаголовок сообщения в Slack.
-
строкаspec.slack.titleLinkURL для ссылки в заголовке.
-
строкаspec.slack.usernameИмя пользователя для сообщения в Slack.
-
-
объектspec.telegramПараметры Telegram канала.
-
строкаspec.telegram.apiToken
Обязательный параметр
API-токен Telegram. -
строкаspec.telegram.apiUrlAPI URL Telegram-а.
По умолчанию:
https://api.telegram.org -
объектspec.telegram.httpConfigПараметры HTTP-клиента для Telegram-получателя Alertmanager (
http_config). ИспользуйтеproxyUrlилиproxyFromEnvironment, если Telegram API доступен только через прокси. ПараметрыbasicAuthиauthorizationне могут использоваться одновременно. Параметрoauth2не может использоваться одновременно сbasicAuthилиauthorization.-
объектspec.telegram.httpConfig.authorizationСтатический HTTP-заголовок
Authorization. Взаимоисключим сbasicAuth.-
строкаspec.telegram.httpConfig.authorization.credentialsЗначение учётных данных, подставляемое в заголовок
Authorization. -
строкаspec.telegram.httpConfig.authorization.credentialsFileПуть к файлу с учётными данными, доступному внутри контейнера Alertmanager.
-
строкаspec.telegram.httpConfig.authorization.typeСхема аутентификации (по умолчанию в Alertmanager используется
Bearer, если не задано).
-
-
объектspec.telegram.httpConfig.basicAuthHTTP Basic-аутентификация для исходящих запросов к Telegram API.
-
строкаspec.telegram.httpConfig.basicAuth.passwordПароль.
-
строкаspec.telegram.httpConfig.basicAuth.passwordFileПуть к файлу с паролем, доступному внутри контейнера Alertmanager.
-
строкаspec.telegram.httpConfig.basicAuth.usernameИмя пользователя.
-
-
булевыйspec.telegram.httpConfig.enableHttp2Включить поддержку HTTP/2 для запросов к Telegram API.
-
булевыйspec.telegram.httpConfig.followRedirectsСледовать ли HTTP-редиректам при отправке запроса к Telegram API.
-
объектspec.telegram.httpConfig.httpHeadersПользовательские HTTP-заголовки, добавляемые к запросам к Telegram API. Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.
-
объектspec.telegram.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— имя параметра (ключ объекта).-
массив строкspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.filesСписок значений заголовка, считываемых из файлов.
-
массив строкspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secretsСписок значений заголовка, считываемых из секретов.
-
массив строкspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.valuesСписок значений заголовка, заданных в открытом виде.
-
-
-
строкаspec.telegram.httpConfig.noProxyСписок хостов через запятую, для которых прокси не применяется.
-
объектspec.telegram.httpConfig.oauth2Учётные данные клиента OAuth2. Взаимоисключим с
basicAuthиauthorization.-
строкаspec.telegram.httpConfig.oauth2.clientId
Обязательный параметр
Идентификатор клиента OAuth2. -
строкаspec.telegram.httpConfig.oauth2.clientSecretСекрет клиента OAuth2.
-
строкаspec.telegram.httpConfig.oauth2.clientSecretFileПуть к файлу с секретом клиента OAuth2.
-
объект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.proxyUrlURL HTTP-прокси, используемого для запроса токена.
-
массив строкspec.telegram.httpConfig.oauth2.scopesСписок запрашиваемых OAuth2-скоупов.
-
объектspec.telegram.httpConfig.oauth2.tlsConfigНастройки TLS для запроса токена OAuth2.
-
строкаspec.telegram.httpConfig.oauth2.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.telegram.httpConfig.oauth2.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.telegram.httpConfig.oauth2.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строка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 для получения токена OAuth2.
-
-
объектspec.telegram.httpConfig.proxyConnectHeaderЗаголовки, добавляемые к
CONNECT-запросам к прокси (имена заголовков сопоставлены со списком значений). -
булевыйspec.telegram.httpConfig.proxyFromEnvironmentИспользовать параметры прокси из переменных окружения (
HTTP_PROXY,HTTPS_PROXY,NO_PROXY). -
строкаspec.telegram.httpConfig.proxyUrlURL HTTP-прокси для запросов к Telegram API.
-
объектspec.telegram.httpConfig.tlsConfigНастройки TLS для HTTP-клиента Telegram-получателя.
-
строкаspec.telegram.httpConfig.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.telegram.httpConfig.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.telegram.httpConfig.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.telegram.httpConfig.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строкаspec.telegram.httpConfig.tlsConfig.maxVersionМаксимальная допустимая версия TLS.
-
строкаspec.telegram.httpConfig.tlsConfig.minVersionМинимальная допустимая версия TLS.
-
строкаspec.telegram.httpConfig.tlsConfig.serverNameИмя сервера для проверки TLS-сертификата (SNI).
-
-
-
строкаspec.telegram.templateШаблон сообщения Telegram.
-
-
строкаspec.type
Обязательный параметр
Тип канала уведомлений.Допустимые значения:
Email,Slack,Telegram,Webhook,ExpressMessenger -
объектspec.webhookПараметры канала Webhook.
-
объектspec.webhook.httpConfigПараметры HTTP-клиента для webhook-получателя Alertmanager (
http_config). ПараметрыbasicAuthиauthorizationне могут использоваться одновременно. Параметрoauth2не может использоваться одновременно сbasicAuthилиauthorization.-
объектspec.webhook.httpConfig.authorizationСтатический HTTP-заголовок
Authorization. Взаимоисключим сbasicAuth.-
строкаspec.webhook.httpConfig.authorization.credentialsЗначение учётных данных, подставляемое в заголовок
Authorization. -
строкаspec.webhook.httpConfig.authorization.credentialsFileПуть к файлу с учётными данными, доступному внутри контейнера Alertmanager.
-
строкаspec.webhook.httpConfig.authorization.typeСхема аутентификации (по умолчанию в Alertmanager используется
Bearer, если не задано).
-
-
объектspec.webhook.httpConfig.basicAuthHTTP Basic-аутентификация для webhook-запросов.
-
строкаspec.webhook.httpConfig.basicAuth.passwordПароль.
-
строкаspec.webhook.httpConfig.basicAuth.passwordFileПуть к файлу с паролем, доступному внутри контейнера Alertmanager.
-
строкаspec.webhook.httpConfig.basicAuth.usernameИмя пользователя.
-
-
булевыйspec.webhook.httpConfig.enableHttp2Включить поддержку HTTP/2 для webhook-запросов.
-
булевыйspec.webhook.httpConfig.followRedirectsСледовать ли HTTP-редиректам при отправке webhook-запроса.
-
объектspec.webhook.httpConfig.httpHeadersПользовательские HTTP-заголовки, добавляемые к webhook-запросам. Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.
-
объектspec.webhook.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— имя параметра (ключ объекта).-
массив строкspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.filesСписок значений заголовка, считываемых из файлов.
-
массив строкspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secretsСписок значений заголовка, считываемых из секретов.
-
массив строкspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.valuesСписок значений заголовка, заданных в открытом виде.
-
-
-
строкаspec.webhook.httpConfig.noProxyСписок хостов через запятую, для которых прокси не применяется.
-
объектspec.webhook.httpConfig.oauth2Учётные данные клиента OAuth2. Взаимоисключим с
basicAuthиauthorization.-
строкаspec.webhook.httpConfig.oauth2.clientId
Обязательный параметр
Идентификатор клиента OAuth2. -
строкаspec.webhook.httpConfig.oauth2.clientSecretСекрет клиента OAuth2.
-
строкаspec.webhook.httpConfig.oauth2.clientSecretFileПуть к файлу с секретом клиента OAuth2.
-
объект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.proxyUrlURL HTTP-прокси, используемого для запроса токена.
-
массив строкspec.webhook.httpConfig.oauth2.scopesСписок запрашиваемых OAuth2-скоупов.
-
объектspec.webhook.httpConfig.oauth2.tlsConfigНастройки TLS для запроса токена OAuth2.
-
строкаspec.webhook.httpConfig.oauth2.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.webhook.httpConfig.oauth2.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.webhook.httpConfig.oauth2.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строка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 для получения токена OAuth2.
-
-
объектspec.webhook.httpConfig.proxyConnectHeaderЗаголовки, добавляемые к
CONNECT-запросам к прокси (имена заголовков сопоставлены со списком значений). -
булевыйspec.webhook.httpConfig.proxyFromEnvironmentИспользовать параметры прокси из переменных окружения (
HTTP_PROXY,HTTPS_PROXY,NO_PROXY). -
строкаspec.webhook.httpConfig.proxyUrlURL HTTP-прокси для webhook-запросов.
-
объектspec.webhook.httpConfig.tlsConfigНастройки TLS для HTTP-клиента webhook.
-
строкаspec.webhook.httpConfig.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.webhook.httpConfig.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.webhook.httpConfig.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.webhook.httpConfig.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строкаspec.webhook.httpConfig.tlsConfig.maxVersionМаксимальная допустимая версия TLS.
-
строкаspec.webhook.httpConfig.tlsConfig.minVersionМинимальная допустимая версия TLS.
-
строкаspec.webhook.httpConfig.tlsConfig.serverNameИмя сервера для проверки TLS-сертификата (SNI).
-
-
-
строкаspec.webhook.url
Обязательный параметр
Адрес Webhook-а.Минимальная длина:
1
-
-
-
объектstatusИнформация о статусе канала уведомлений, включая политики, которые его используют.
-
массив объектовstatus.policiesСписок политик уведомлений, использующих этот канал во всех пространствах имён.
-
строкаstatus.policies.nameИмя политики уведомлений, использующей этот канал.
-
строкаstatus.policies.namespaceПространство имён политики уведомлений. Пустая строка для политик уровня кластера.
-
-
ClusterObservabilityPropagatedNotificationPolicy
Scope: Cluster
Version: v1alpha1
-
объектspec
-
объектspec.alert
Обязательный параметр
Условия фильтрации алертов: по каким алертам будет применяться данная политика уведомлений.-
массив строкspec.alert.groupByLabelsСписок лейблов, по которым алерты группируются в одно уведомление: алерты с одинаковыми значениями указанных лейблов будут объединены и отправлены в канал как одно сообщение.
-
строкаspec.alert.groupByLabels.Элемент массиваИмя лейбла.
-
-
объектspec.alert.selector
Обязательный параметр
Селектор алертов по лейблам — описывает, какие именно алерты попадают под политику. Должен быть задан либо matchLabels, либо matchExpressions.-
массив объектовspec.alert.selector.matchExpressionsНабор выражений для фильтрации алертов. Позволяет задать более гибкие условия, чем matchLabels.
-
строкаspec.alert.selector.matchExpressions.keyИмя лейбла алерта, по которому проверяется условие фильтрации.
-
строкаspec.alert.selector.matchExpressions.operatorОператор сравнения (In, NotIn, Exists, DoesNotExist).
Допустимые значения:
Equal,NotEqual,Regex,NotRegex -
строкаspec.alert.selector.matchExpressions.valueЗначение для сравнения с лейблом алерта.
-
-
объектspec.alert.selector.matchLabelsНабор лейблов для фильтрации алертов. Уведомления будут отправлены только по алертам, лейблы которых совпадают с указанными.
-
-
-
объектspec.notification
Обязательный параметр
Параметры уведомления об алерте-
объектspec.notification.channel
Обязательный параметр
Параметры канала уведомлений — допустимы только ClusterObservabilityPropagatedNotificationChannel.-
строкаspec.notification.channel.kind
Обязательный параметр
Тип объекта канала. Должен быть ClusterObservabilityPropagatedNotificationChannel.По умолчанию:
ClusterObservabilityPropagatedNotificationChannelДопустимые значения:
ClusterObservabilityPropagatedNotificationChannel -
строкаspec.notification.channel.name
Обязательный параметр
Имя propagated-канала уведомлений. -
объектspec.notification.channel.parameters
Обязательный параметр
Параметры канала уведомлений.
-
-
строкаspec.notification.repeatInterval
Обязательный параметр
Интервал повторного уведомления.По умолчанию:
1m
-
-
-
объектstatus
-
строкаstatus.description
-
строкаstatus.state
-
ObservabilityDashboard
Scope: Namespaced
Version: v1alpha1
Определяет дашборд, который отображается в интерфейсе Deckhouse Console.
Ресурс является namespace-ориентированным, что позволяет командам создавать и управлять своими дашбордами независимо в пределах своего пространства имён.
Поддерживаются аннотации:
metadata.deckhouse.io/category— задаёт папку (категорию) в интерфейсе;metadata.deckhouse.io/title— задаёт отображаемое название дашборда; Если не указано, будет использованоtitleиз JSON-манифеста.
-
объектspec
-
строкаspec.definition
Обязательный параметр
JSON-манифест дашборда. JSON должно быть передано в виде строки, совместимым с форматом Grafana dashboard.
-
ObservabilityMetricsRulesGroup
Scope: Namespaced
Version: v1alpha1
-
объектspecObservabilityMetricsRulesGroupSpec определяет желаемое состояние группы правил
-
строка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Имя алерта. Обязательно для правил алертинга, взаимоисключающее с record.
Шаблон:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
объектspec.rules.annotationsАннотации для присоединения к алерту (не действительны для правил записи)
-
строка или числоspec.rules.exprPromQL выражение для вычисления
-
строка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.
Шаблон:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
-
объектstatusObservabilityMetricsRulesGroupStatus определяет наблюдаемое состояние группы правил
-
массив объектов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Время последней успешной синхронизации группы правил
-
строкаstatus.prometheusRuleNameИмя ресурса PrometheusRule, созданного для этой группы правил
-
ObservabilityNotificationChannel
Scope: Namespaced
Version: v1alpha1
-
объектspec
-
объектspec.emailПараметры Email канала
-
строкаspec.email.from
Обязательный параметр
Email адрес отправителя -
объектspec.email.smtp
Обязательный параметр
SMTP-параметры отправителя-
строкаspec.email.smtp.address
Обязательный параметр
Email-адрес получателя -
объектspec.email.smtp.authАвторизационные параметры отправителя
-
строкаspec.email.smtp.auth.password
Обязательный параметр
Пароль -
строкаspec.email.smtp.auth.username
Обязательный параметр
Имя пользователя
-
-
булевыйspec.email.smtp.requireTLSТребуется ли TLS верификация.
-
-
строкаspec.email.templateШаблон письма
-
-
объектspec.expressMessengerПараметры канала eXpress Messenger.
-
строка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
Обязательный параметр
API URL Slack-а -
строкаspec.slack.colorЦвет вложения сообщения в Slack
-
строкаspec.slack.fallbackРезервный текст для сообщения в Slack
-
строкаНижний колонтитул для сообщения в Slack
-
строкаspec.slack.iconEmojiЭмодзи иконка для сообщения в Slack
-
строкаspec.slack.iconUrlURL для изображения иконки
-
строкаspec.slack.pretextТекст, отображаемый над основным блоком сообщения в Slack (pretext).
-
строкаspec.slack.templateШаблон сообщения
-
строкаspec.slack.textОсновной текст сообщения в Slack
-
строкаspec.slack.titleЗаголовок сообщения в Slack
-
строкаspec.slack.titleLinkURL для ссылки в заголовке
-
строкаspec.slack.usernameИмя пользователя для сообщения в Slack
-
-
объектspec.telegramПараметры Telegram канала
-
строкаspec.telegram.apiToken
Обязательный параметр
API-токен Telegram -
строкаspec.telegram.apiUrlAPI URL Telegram-а
По умолчанию:
https://api.telegram.org -
объектspec.telegram.httpConfigПараметры HTTP-клиента для Telegram-получателя Alertmanager (
http_config). ИспользуйтеproxyUrlилиproxyFromEnvironment, если Telegram API доступен только через прокси. ПараметрыbasicAuthиauthorizationне могут использоваться одновременно. Параметрoauth2не может использоваться одновременно сbasicAuthилиauthorization.-
объектspec.telegram.httpConfig.authorizationСтатический HTTP-заголовок
Authorization. Взаимоисключим сbasicAuth.-
строкаspec.telegram.httpConfig.authorization.credentialsЗначение учётных данных, подставляемое в заголовок
Authorization. -
строкаspec.telegram.httpConfig.authorization.credentialsFileПуть к файлу с учётными данными, доступному внутри контейнера Alertmanager.
-
строкаspec.telegram.httpConfig.authorization.typeСхема аутентификации (по умолчанию в Alertmanager используется
Bearer, если не задано).
-
-
объектspec.telegram.httpConfig.basicAuthHTTP Basic-аутентификация для исходящих запросов к Telegram API.
-
строкаspec.telegram.httpConfig.basicAuth.passwordПароль.
-
строкаspec.telegram.httpConfig.basicAuth.passwordFileПуть к файлу с паролем, доступному внутри контейнера Alertmanager.
-
строкаspec.telegram.httpConfig.basicAuth.usernameИмя пользователя.
-
-
булевыйspec.telegram.httpConfig.enableHttp2Включить поддержку HTTP/2 для запросов к Telegram API.
-
булевыйspec.telegram.httpConfig.followRedirectsСледовать ли HTTP-редиректам при отправке запроса к Telegram API.
-
объектspec.telegram.httpConfig.httpHeadersПользовательские HTTP-заголовки, добавляемые к запросам к Telegram API. Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.
-
объектspec.telegram.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— имя параметра (ключ объекта).-
массив строкspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.filesСписок значений заголовка, считываемых из файлов.
-
массив строкspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secretsСписок значений заголовка, считываемых из секретов.
-
массив строкspec.telegram.httpConfig.httpHeaders.<KEY_NAME>.valuesСписок значений заголовка, заданных в открытом виде.
-
-
-
строкаspec.telegram.httpConfig.noProxyСписок хостов через запятую, для которых прокси не применяется.
-
объектspec.telegram.httpConfig.oauth2Учётные данные клиента OAuth2. Взаимоисключим с
basicAuthиauthorization.-
строкаspec.telegram.httpConfig.oauth2.clientId
Обязательный параметр
Идентификатор клиента OAuth2. -
строкаspec.telegram.httpConfig.oauth2.clientSecretСекрет клиента OAuth2.
-
строкаspec.telegram.httpConfig.oauth2.clientSecretFileПуть к файлу с секретом клиента OAuth2.
-
объект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.proxyUrlURL HTTP-прокси, используемого для запроса токена.
-
массив строкspec.telegram.httpConfig.oauth2.scopesСписок запрашиваемых OAuth2-скоупов.
-
объектspec.telegram.httpConfig.oauth2.tlsConfigНастройки TLS для запроса токена OAuth2.
-
строкаspec.telegram.httpConfig.oauth2.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.telegram.httpConfig.oauth2.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.telegram.httpConfig.oauth2.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строка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 для получения токена OAuth2.
-
-
объектspec.telegram.httpConfig.proxyConnectHeaderЗаголовки, добавляемые к
CONNECT-запросам к прокси (имена заголовков сопоставлены со списком значений). -
булевыйspec.telegram.httpConfig.proxyFromEnvironmentИспользовать параметры прокси из переменных окружения (
HTTP_PROXY,HTTPS_PROXY,NO_PROXY). -
строкаspec.telegram.httpConfig.proxyUrlURL HTTP-прокси для запросов к Telegram API.
-
объектspec.telegram.httpConfig.tlsConfigНастройки TLS для HTTP-клиента Telegram-получателя.
-
строкаspec.telegram.httpConfig.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.telegram.httpConfig.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.telegram.httpConfig.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.telegram.httpConfig.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строка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 -
объектspec.webhookПараметры канала Webhook
-
объектspec.webhook.httpConfigПараметры HTTP-клиента для webhook-получателя Alertmanager (
http_config). ПараметрыbasicAuthиauthorizationне могут использоваться одновременно. Параметрoauth2не может использоваться одновременно сbasicAuthилиauthorization.-
объектspec.webhook.httpConfig.authorizationСтатический HTTP-заголовок
Authorization. Взаимоисключим сbasicAuth.-
строкаspec.webhook.httpConfig.authorization.credentialsЗначение учётных данных, подставляемое в заголовок
Authorization. -
строкаspec.webhook.httpConfig.authorization.credentialsFileПуть к файлу с учётными данными, доступному внутри контейнера Alertmanager.
-
строкаspec.webhook.httpConfig.authorization.typeСхема аутентификации (по умолчанию в Alertmanager используется
Bearer, если не задано).
-
-
объектspec.webhook.httpConfig.basicAuthHTTP Basic-аутентификация для webhook-запросов.
-
строкаspec.webhook.httpConfig.basicAuth.passwordПароль.
-
строкаspec.webhook.httpConfig.basicAuth.passwordFileПуть к файлу с паролем, доступному внутри контейнера Alertmanager.
-
строкаspec.webhook.httpConfig.basicAuth.usernameИмя пользователя.
-
-
булевыйspec.webhook.httpConfig.enableHttp2Включить поддержку HTTP/2 для webhook-запросов.
-
булевыйspec.webhook.httpConfig.followRedirectsСледовать ли HTTP-редиректам при отправке webhook-запроса.
-
объектspec.webhook.httpConfig.httpHeadersПользовательские HTTP-заголовки, добавляемые к webhook-запросам. Ключ объекта — имя заголовка, значение — объект со списком значений и/или ссылок на секреты и файлы.
-
объектspec.webhook.httpConfig.httpHeaders.<KEY_NAME>
<KEY_NAME>— имя параметра (ключ объекта).-
массив строкspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.filesСписок значений заголовка, считываемых из файлов.
-
массив строкspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secretsСписок значений заголовка, считываемых из секретов.
-
массив строкspec.webhook.httpConfig.httpHeaders.<KEY_NAME>.valuesСписок значений заголовка, заданных в открытом виде.
-
-
-
строкаspec.webhook.httpConfig.noProxyСписок хостов через запятую, для которых прокси не применяется.
-
объектspec.webhook.httpConfig.oauth2Учётные данные клиента OAuth2. Взаимоисключим с
basicAuthиauthorization.-
строкаspec.webhook.httpConfig.oauth2.clientId
Обязательный параметр
Идентификатор клиента OAuth2. -
строкаspec.webhook.httpConfig.oauth2.clientSecretСекрет клиента OAuth2.
-
строкаspec.webhook.httpConfig.oauth2.clientSecretFileПуть к файлу с секретом клиента OAuth2.
-
объект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.proxyUrlURL HTTP-прокси, используемого для запроса токена.
-
массив строкspec.webhook.httpConfig.oauth2.scopesСписок запрашиваемых OAuth2-скоупов.
-
объектspec.webhook.httpConfig.oauth2.tlsConfigНастройки TLS для запроса токена OAuth2.
-
строкаspec.webhook.httpConfig.oauth2.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.webhook.httpConfig.oauth2.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.webhook.httpConfig.oauth2.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строка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 для получения токена OAuth2.
-
-
объектspec.webhook.httpConfig.proxyConnectHeaderЗаголовки, добавляемые к
CONNECT-запросам к прокси (имена заголовков сопоставлены со списком значений). -
булевыйspec.webhook.httpConfig.proxyFromEnvironmentИспользовать параметры прокси из переменных окружения (
HTTP_PROXY,HTTPS_PROXY,NO_PROXY). -
строкаspec.webhook.httpConfig.proxyUrlURL HTTP-прокси для webhook-запросов.
-
объектspec.webhook.httpConfig.tlsConfigНастройки TLS для HTTP-клиента webhook.
-
строкаspec.webhook.httpConfig.tlsConfig.caFileПуть к файлу с CA-сертификатом.
-
строкаspec.webhook.httpConfig.tlsConfig.certFileПуть к файлу с клиентским сертификатом.
-
булевыйspec.webhook.httpConfig.tlsConfig.insecureSkipVerifyОтключить проверку TLS-сертификата сервера.
-
строкаspec.webhook.httpConfig.tlsConfig.keyFileПуть к файлу с приватным ключом клиента.
-
строкаspec.webhook.httpConfig.tlsConfig.maxVersionМаксимальная допустимая версия TLS.
-
строкаspec.webhook.httpConfig.tlsConfig.minVersionМинимальная допустимая версия TLS.
-
строкаspec.webhook.httpConfig.tlsConfig.serverNameИмя сервера для проверки TLS-сертификата (SNI).
-
-
-
строкаspec.webhook.url
Обязательный параметр
Адрес Webhook-а.Минимальная длина:
1
-
-
-
объектstatusStatus information about the notification channel, including which policies are using it.
-
массив строкstatus.policiesList of notification policies that are using this channel.
-
строкаstatus.policies.Элемент массиваName of the notification policy using this channel.
-
-
ObservabilityNotificationPolicy
Scope: Namespaced
Version: v1alpha1
-
объектspec
-
объектspec.alert
Обязательный параметр
Условия фильтрации алертов: по каким алертам будет применяться данная политика уведомлений.-
массив строкspec.alert.groupByLabelsСписок лейблов, по которым алерты группируются в одно уведомление: алерты с одинаковыми значениями указанных лейблов будут объединены и отправлены в канал как одно сообщение.
-
строкаspec.alert.groupByLabels.Элемент массиваИмя лейбла.
-
-
объектspec.alert.selector
Обязательный параметр
Селектор алертов по лейблам — описывает, какие именно алерты попадают под политику. Должен быть задан либо matchLabels, либо matchExpressions.-
массив объектовspec.alert.selector.matchExpressionsНабор выражений для фильтрации алертов. Позволяет задать более гибкие условия, чем matchLabels.
-
строкаspec.alert.selector.matchExpressions.keyИмя лейбла алерта, по которому проверяется условие фильтрации.
-
строкаspec.alert.selector.matchExpressions.operatorОператор сравнения (In, NotIn, Exists, DoesNotExist).
Допустимые значения:
Equal,NotEqual,Regex,NotRegex -
строкаspec.alert.selector.matchExpressions.valueЗначение для сравнения с лейблом алерта.
-
-
объектspec.alert.selector.matchLabelsНабор лейблов для фильтрации алертов. Уведомления будут отправлены только по алертам, лейблы которых совпадают с указанными.
-
-
-
объектspec.notification
Обязательный параметр
Параметры уведомления об алерте-
объектspec.notification.channel
Обязательный параметр
Параметры канала уведомлений-
строкаspec.notification.channel.kind
Обязательный параметр
Тип канала уведомлений (в данный момент поддерживается только ObservabilityNotificationChannel).По умолчанию:
ObservabilityNotificationChannelДопустимые значения:
ClusterObservabilityPropagatedNotificationChannel,ObservabilityNotificationChannel -
строкаspec.notification.channel.name
Обязательный параметр
Имя канала уведомлений. -
объектspec.notification.channel.parameters
Обязательный параметр
Параметры канала уведомлений
-
-
строкаspec.notification.repeatInterval
Обязательный параметр
Интервал повторного уведомления.По умолчанию:
1m
-
-
-
объектstatus
-
строкаstatus.description
-
строкаstatus.state
-
ObservabilityNotificationSilence
Scope: Namespaced
Version: v1alpha1
-
объектspec
-
строкаspec.endsAt
Обязательный параметр
Время окончания отключения уведомлений. -
объектspec.selector
Обязательный параметр
Селектор алертов по лейблам — описывает, какие именно алерты попадают под silence. Должен быть задан либо matchLabels, либо matchExpressions.-
массив объектовspec.selector.matchExpressionsНабор выражений для фильтрации алертов. Позволяет задать более гибкие условия, чем matchLabels.
-
строкаspec.selector.matchExpressions.keyИмя лейбла алерта, по которому проверяется условие фильтрации.
-
строкаspec.selector.matchExpressions.operatorОператор сравнения (In, NotIn, Exists, DoesNotExist).
Допустимые значения:
Equal,NotEqual,Regex,NotRegex -
строкаspec.selector.matchExpressions.valueЗначение для сравнения с лейблом алерта.
-
-
объектspec.selector.matchLabelsНабор лейблов для фильтрации алертов. Уведомления по алертам, лейблы которых совпадают с указанными, не будут отправлены в течение действия silence.
-
-
строкаspec.startsAt
Обязательный параметр
Время начала отключения уведомлений.
-