Стадия жизненного цикла модуля: Preview
Deckhouse Kubernetes Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.
ClusterMetric
Scope: Cluster
Version: v1alpha1
ClusterObservabilityDashboard
Scope: Cluster
Version: v1alpha1
Определяет дашборд кластерного уровня, отображаемый в интерфейсе Deckhouse Console.
Этот ресурс не привязан к какому-либо пространству имён.
Поддерживаются аннотации:
metadata.deckhouse.io/category— задаёт папку (категорию) в интерфейсе;metadata.deckhouse.io/title— задаёт отображаемое название дашборда. Если не указано, будет использовано название из JSON-манифеста.
-
объектspec
-
строкаspec.definition
Обязательный параметр
JSON-манифест дашборда. JSON должен быть передан в виде строки, совместимой с форматом Grafana dashboard.
-
ClusterObservabilityMetricsRecordingRule
Scope: Cluster
Version: v1alpha1
-
объектspec
-
строкаspec.expression
Обязательный параметр
Source metric query (PromQL). -
объектspec.targetMetric
Обязательный параметр
Target metric properties.-
объектspec.targetMetric.additionalLabelsTarget metric additional labels.
-
строкаspec.targetMetric.name
Обязательный параметр
Target metric name.
-
-
ClusterObservabilityMetricsRulesGroup
Scope: Cluster
Version: v1alpha1
-
объектspecClusterObservabilityMetricsRulesGroupSpec defines the desired state of the cluster rules group
-
строкаspec.intervalInterval for rule evaluation, e.g. ’30s’. If not specified, default interval will be used.
По умолчанию:
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
Обязательный параметр
List of alerting and recording rules for cluster-level monitoring-
строкаspec.rules.alertName of the alert. Required for alerting rules, mutually exclusive with record.
Шаблон:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
объектspec.rules.annotationsAnnotations to attach to the alert (not valid for recording rules)
-
строка или числоspec.rules.exprPromQL expression to evaluate. Will be automatically scoped to infrastructure namespaces (kube-, d8-, empty).
-
строкаspec.rules.forDuration for which the condition must be true before the alert fires
Шаблон:
^(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_forDuration for which the alert continues firing after the condition becomes false
Шаблон:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
объектspec.rules.labelsAdditional labels to attach to the alert or recorded metric
-
строкаspec.rules.recordName of the recorded metric. Required for recording rules, mutually exclusive with alert.
Шаблон:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
ClusterObservabilityNotificationChannel
Scope: Cluster
Version: v1alpha1
-
объектspec
-
объектspec.emailEmail channel parameters.
-
строкаspec.email.from
Обязательный параметр
Sender email address. -
объектspec.email.smtp
Обязательный параметр
SMTP sender parameters.-
строкаspec.email.smtp.address
Обязательный параметр
Receiver email address. -
объектspec.email.smtp.authSender auth parameters.
-
строкаspec.email.smtp.auth.password
Обязательный параметр
Password. -
строкаspec.email.smtp.auth.username
Обязательный параметр
Username.
-
-
булевыйspec.email.smtp.requireTLSRequire TLS verification.
-
-
строкаspec.email.templateEmail body template.
-
-
объектspec.slackSlack channel parameters.
-
строкаspec.slack.apiUrl
Обязательный параметр
Slack API URL. -
строкаspec.slack.colorColor of the Slack message attachment.
-
строкаspec.slack.fallbackFallback text for the Slack message.
-
строкаFooter text for the Slack message.
-
строкаspec.slack.iconEmojiEmoji icon for the Slack message.
-
строкаspec.slack.iconUrlURL for the icon image.
-
строкаspec.slack.pretextPretext for the Slack message.
-
строкаspec.slack.templateSlack message template.
-
строкаspec.slack.textMain text content of the Slack message.
-
строкаspec.slack.titleTitle of the Slack message.
-
строкаspec.slack.titleLinkURL for the title link.
-
строкаspec.slack.usernameUsername for the Slack message.
-
-
объектspec.telegramTelegram channel parameters.
-
строкаspec.telegram.apiToken
Обязательный параметр
Telegram API Token. -
строкаspec.telegram.apiUrlTelegram API URL.
По умолчанию:
https://api.telegram.org -
строкаspec.telegram.templateTelegram message template.
-
-
строкаspec.type
Обязательный параметр
Notification channel type.Допустимые значения:
Email,Slack,Telegram,Webhook -
объектspec.webhookWebhook channel parameters.
-
строкаspec.webhook.url
Обязательный параметр
Webhook URL.
-
-
ClusterObservabilityNotificationPolicy
Scope: Cluster
Version: v1alpha1
-
объектspec
-
объектspec.alert
Обязательный параметр
Alert matching parameters.-
массив строкspec.alert.groupByLabelsGrouping by label
-
строкаspec.alert.groupByLabels.Элемент массиваLabel name.
-
-
объектspec.alert.selector
Обязательный параметр
Alert selector.-
массив объектовspec.alert.selector.matchExpressionsMatch expressions.
-
строкаspec.alert.selector.matchExpressions.keyMatching key.
-
строкаspec.alert.selector.matchExpressions.operatorMatching operator.
Допустимые значения:
Equal,NotEqual,Regex,NotRegex -
строкаspec.alert.selector.matchExpressions.valueTarget value.
-
-
объектspec.alert.selector.matchLabelsLabel selector.
-
-
-
объектspec.notification
Обязательный параметр
Alert notification parameters-
объектspec.notification.channel
Обязательный параметр
Notification channel parameters.-
строкаspec.notification.channel.kind
Обязательный параметр
Channel object kind.По умолчанию:
ClusterObservabilityNotificationChannelДопустимые значения:
ClusterObservabilityNotificationChannel -
строкаspec.notification.channel.name
Обязательный параметр
Name of notification channel. -
объектspec.notification.channel.parameters
Обязательный параметр
Notification channel parameters.
-
-
строкаspec.notification.repeatInterval
Обязательный параметр
Notification repeat interval.По умолчанию:
1m
-
-
ClusterObservabilityNotificationSilence
Scope: Cluster
Version: v1alpha1
-
объектspec
-
строкаspec.endsAt
Обязательный параметр
Notification silence end time. -
объектspec.selector
Обязательный параметр
Alert selector.-
массив объектовspec.selector.matchExpressionsMatch expressions.
-
строкаspec.selector.matchExpressions.keyMatching key.
-
строкаspec.selector.matchExpressions.operatorMatching operator.
Допустимые значения:
Equal,NotEqual,Regex,NotRegex -
строкаspec.selector.matchExpressions.valueTarget value.
-
-
объектspec.selector.matchLabelsLabel selector.
-
-
строкаspec.startsAt
Обязательный параметр
Notification silence start time.
-
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 defines the desired state of the propagated rules group
-
строкаspec.intervalInterval for rule evaluation, e.g. ’30s’. If not specified, default interval will be used.
По умолчанию:
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
Обязательный параметр
List of alerting and recording rules delivered by platform developers-
строкаspec.rules.alertName of the alert. Required for alerting rules, mutually exclusive with record.
Шаблон:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
объектspec.rules.annotationsAnnotations to attach to the alert (not valid for recording rules)
-
строка или числоspec.rules.exprPromQL expression to evaluate. No namespace enforcement will be applied to propagated rules.
-
строкаspec.rules.forDuration for which the condition must be true before the alert fires
Шаблон:
^(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_forDuration for which the alert continues firing after the condition becomes false
Шаблон:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
объектspec.rules.labelsAdditional labels to attach to the alert or recorded metric
-
строкаspec.rules.recordName of the recorded metric. Required for recording rules, mutually exclusive with alert.
Шаблон:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
ClusterObservabilityPropagatedNotificationChannel
Scope: Cluster
Version: v1alpha1
-
объектspec
-
объектspec.emailEmail channel parameters.
-
строкаspec.email.from
Обязательный параметр
Sender email address. -
объектspec.email.smtp
Обязательный параметр
SMTP sender parameters.-
строкаspec.email.smtp.address
Обязательный параметр
Receiver email address. -
объектspec.email.smtp.authSender auth parameters.
-
строкаspec.email.smtp.auth.password
Обязательный параметр
Password. -
строкаspec.email.smtp.auth.username
Обязательный параметр
Username.
-
-
булевыйspec.email.smtp.requireTLSRequire TLS verification.
-
-
строкаspec.email.templateEmail body template.
-
-
объектspec.slackSlack channel parameters.
-
строкаspec.slack.apiUrl
Обязательный параметр
Slack API URL. -
строкаspec.slack.colorColor of the Slack message attachment.
-
строкаspec.slack.fallbackFallback text for the Slack message.
-
строкаFooter text for the Slack message.
-
строкаspec.slack.iconEmojiEmoji icon for the Slack message.
-
строкаspec.slack.iconUrlURL for the icon image.
-
строкаspec.slack.pretextPretext for the Slack message.
-
строкаspec.slack.templateSlack message template.
-
строкаspec.slack.textMain text content of the Slack message.
-
строкаspec.slack.titleTitle of the Slack message.
-
строкаspec.slack.titleLinkURL for the title link.
-
строкаspec.slack.usernameUsername for the Slack message.
-
-
объектspec.telegramTelegram channel parameters.
-
строкаspec.telegram.apiToken
Обязательный параметр
Telegram API Token. -
строкаspec.telegram.apiUrlTelegram API URL.
По умолчанию:
https://api.telegram.org -
строкаspec.telegram.templateTelegram message template.
-
-
строкаspec.type
Обязательный параметр
Notification channel type.Допустимые значения:
Email,Slack,Telegram,Webhook -
объектspec.webhookWebhook channel parameters.
-
строкаspec.webhook.url
Обязательный параметр
Webhook URL.
-
-
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.
-
ObservabilityDatasource
Scope: Namespaced
Version: v1alpha1
-
объектspec
-
булевыйspec.basicAuthEnable/disable basic auth.
-
строкаspec.basicAuthUserBasic auth username.
-
строкаspec.databaseDatabase name (if used).
-
объектspec.jsonDataFields to be converted to JSON and stored in jsonData.
-
объектspec.secureJsonDataJSON-data object to be saved encrypted.
-
строкаspec.type
Обязательный параметр
Datasource type. -
строкаspec.urlDatasource URL.
-
строкаspec.userDatabase username.
-
ObservabilityMetricsAlertingRule
Scope: Namespaced
Version: v1alpha1
-
объектspec
-
объектspec.alertMetadata
Обязательный параметр
Alert metadata.-
объектspec.alertMetadata.additionalLabelsAdditional alert labels.
-
объектspec.alertMetadata.annotations
Обязательный параметр
Additional alert annotations.
-
-
объектspec.delaysAlert firing delays.
-
строкаspec.delays.firing
Обязательный параметр
Time delay before firing an alert.По умолчанию:
1m -
строкаspec.delays.resolving
Обязательный параметр
Time delay before resolving an alert.По умолчанию:
1m
-
-
строкаspec.expression
Обязательный параметр
Alert expression (PromQL). -
массив объектовspec.thresholds
Обязательный параметр
Alert thresholds.-
строкаspec.thresholds.operatorComparison operator.
Допустимые значения:
Equal,NotEqual,GreaterThan,GreaterThanOrEqual,LessThan,LessThanOrEqual -
строкаspec.thresholds.severityAlert severity level. S1 - Critical, Major outage S2 - Critical, Severe incident S3 - Critical, Significant disruption S4 - Warning, Unstable performance S5 - Warning, Performance degradation S6 - Warning, Potential issue S7 - Info, Minor issue S8 - Info, Status update S9 - Info, Debugging info
Допустимые значения:
S1,S2,S3,S4,S5,S6,S7,S8,S9 -
строкаspec.thresholds.valueExpressionMetric value or expression (PromQL).
-
-
ObservabilityMetricsAlertingRuleOverride
Scope: Namespaced
Version: v1alpha1
-
объектspec
-
объектspec.alertMetadata
Обязательный параметр
Alert metadata.-
объектspec.alertMetadata.additionalLabelsAdditional alert labels.
-
объектspec.alertMetadata.annotations
Обязательный параметр
Additional alert annotations.
-
-
строкаspec.alertName
Обязательный параметр
Name of alert that will be override -
объектspec.delaysAlert firing delays.
-
строкаspec.delays.firing
Обязательный параметр
Time delay before firing an alert. -
строкаspec.delays.resolving
Обязательный параметр
Time delay before resolving an alert.
-
-
булевыйspec.disableIndicates whether global alerts should be disabled for a specific namespace. If set to true, global alerts will not be triggered for this namespace. Default: false.
По умолчанию:
false -
строкаspec.expression
Обязательный параметр
Alert expression (PromQL). -
массив объектовspec.thresholds
Обязательный параметр
Alert thresholds.-
строкаspec.thresholds.operatorComparison operator.
Допустимые значения:
Equal,NotEqual,GreaterThan,GreaterThanOrEqual,LessThan,LessThanOrEqual -
строкаspec.thresholds.severityAlert severity level.
Допустимые значения:
Critical,Warning,Info,Setup -
строкаspec.thresholds.valueExpressionMetric value or expression (PromQL).
-
-
ObservabilityMetricsRecordingRule
Scope: Namespaced
Version: v1alpha1
-
объектspec
-
строкаspec.expression
Обязательный параметр
Source metric query (PromQL). -
объектspec.targetMetric
Обязательный параметр
Target metric properties.-
объектspec.targetMetric.additionalLabelsTarget metric additional labels.
-
строкаspec.targetMetric.name
Обязательный параметр
Target metric name.
-
-
ObservabilityMetricsRulesGroup
Scope: Namespaced
Version: v1alpha1
-
объектspecObservabilityMetricsRulesGroupSpec defines the desired state of the rules group
-
строкаspec.intervalInterval for rule evaluation, e.g. ’30s’. If not specified, default interval will be used.
По умолчанию:
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
Обязательный параметр
List of alerting and recording rules-
строкаspec.rules.alertName of the alert. Required for alerting rules, mutually exclusive with record.
Шаблон:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
объектspec.rules.annotationsAnnotations to attach to the alert (not valid for recording rules)
-
строка или числоspec.rules.exprPromQL expression to evaluate
-
строкаspec.rules.forDuration for which the condition must be true before the alert fires
Шаблон:
^(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_forDuration for which the alert continues firing after the condition becomes false
Шаблон:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
объектspec.rules.labelsAdditional labels to attach to the alert or recorded metric
-
строкаspec.rules.recordName of the recorded metric. Required for recording rules, mutually exclusive with alert.
Шаблон:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
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.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
-
строка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.templateШаблон сообщения
-
-
строкаspec.type
Обязательный параметр
Notification channel type.Допустимые значения:
Email,Slack,Telegram,Webhook -
объектspec.webhookПараметры канала Webhook
-
строкаspec.webhook.url
Обязательный параметр
Адрес Webhook-а.
-
-
ObservabilityNotificationPolicy
Scope: Namespaced
Version: v1alpha1
-
объектspec
-
объектspec.alert
Обязательный параметр
Параметры выбора алетров.-
массив строкspec.alert.groupByLabelsГруппировка по лейбла
-
строкаspec.alert.groupByLabels.Элемент массиваИмя лейбла
-
-
объектspec.alert.selector
Обязательный параметр
Селектор алерта.-
массив объектовspec.alert.selector.matchExpressionsСелектор по выражениям.
-
строкаspec.alert.selector.matchExpressions.keyКлюч соответствия
-
строкаspec.alert.selector.matchExpressions.operatorОператор соответствия.
Допустимые значения:
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
-
-
ObservabilityNotificationSilence
Scope: Namespaced
Version: v1alpha1
-
объектspec
-
строкаspec.endsAt
Обязательный параметр
Notification silence end time. -
объектspec.selector
Обязательный параметр
Alert selector.-
массив объектовspec.selector.matchExpressionsMatch expressions.
-
строкаspec.selector.matchExpressions.keyMatching key.
-
строкаspec.selector.matchExpressions.operatorMatching operator.
Допустимые значения:
Equal,NotEqual,Regex,NotRegex -
строкаspec.selector.matchExpressions.valueTarget value.
-
-
объектspec.selector.matchLabelsLabel selector.
-
-
строкаspec.startsAt
Обязательный параметр
Notification silence start time.
-