The module lifecycle stage: Preview
The Deckhouse Kubernetes Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.
ClusterMetric
Scope: Cluster
Version: v1alpha1
ClusterObservabilityDashboard
Scope: Cluster
Version: v1alpha1
metadata.deckhouse.io/category — sets the folder/category in the UI. - metadata.deckhouse.io/title — sets the visible dashboard title.
If not set, the title from the dashboard JSON is used.-
objectspec
-
stringspec.definition
Required value
The dashboard JSON manifest. The JSON definition should be provided as a raw JSON string compatible with the Grafana dashboard format.
-
ClusterObservabilityMetricsRecordingRule
Scope: Cluster
Version: v1alpha1
-
objectspec
-
stringspec.expression
Required value
Source metric query (PromQL). -
objectspec.targetMetric
Required value
Target metric properties.-
objectspec.targetMetric.additionalLabelsTarget metric additional labels.
-
stringspec.targetMetric.name
Required value
Target metric name.
-
-
ClusterObservabilityMetricsRulesGroup
Scope: Cluster
Version: v1alpha1
-
objectspecClusterObservabilityMetricsRulesGroupSpec defines the desired state of the cluster rules group
-
stringspec.intervalInterval for rule evaluation, e.g. ’30s’. If not specified, default interval will be used.
Default:
1mPattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of alerting and recording rules for cluster-level monitoring-
stringspec.rules.alertName of the alert. Required for alerting rules, mutually exclusive with record.
Pattern:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
objectspec.rules.annotationsAnnotations to attach to the alert (not valid for recording rules)
-
integer or stringspec.rules.exprPromQL expression to evaluate. Will be automatically scoped to infrastructure namespaces (kube-, d8-, empty).
-
stringspec.rules.forDuration for which the condition must be true before the alert fires
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
stringspec.rules.keep_firing_forDuration for which the alert continues firing after the condition becomes false
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
objectspec.rules.labelsAdditional labels to attach to the alert or recorded metric
-
stringspec.rules.recordName of the recorded metric. Required for recording rules, mutually exclusive with alert.
Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
ClusterObservabilityNotificationChannel
Scope: Cluster
Version: v1alpha1
-
objectspec
-
objectspec.emailEmail channel parameters.
-
stringspec.email.from
Required value
Sender email address. -
objectspec.email.smtp
Required value
SMTP sender parameters.-
stringspec.email.smtp.address
Required value
Receiver email address. -
objectspec.email.smtp.authSender auth parameters.
-
stringspec.email.smtp.auth.password
Required value
Password. -
stringspec.email.smtp.auth.username
Required value
Username.
-
-
booleanspec.email.smtp.requireTLSRequire TLS verification.
-
-
stringspec.email.templateEmail body template.
-
-
objectspec.slackSlack channel parameters.
-
stringspec.slack.apiUrl
Required value
Slack API URL. -
stringspec.slack.colorColor of the Slack message attachment.
-
stringspec.slack.fallbackFallback text for the Slack message.
-
stringFooter text for the Slack message.
-
stringspec.slack.iconEmojiEmoji icon for the Slack message.
-
stringspec.slack.iconUrlURL for the icon image.
-
stringspec.slack.pretextPretext for the Slack message.
-
stringspec.slack.templateSlack message template.
-
stringspec.slack.textMain text content of the Slack message.
-
stringspec.slack.titleTitle of the Slack message.
-
stringspec.slack.titleLinkURL for the title link.
-
stringspec.slack.usernameUsername for the Slack message.
-
-
objectspec.telegramTelegram channel parameters.
-
stringspec.telegram.apiToken
Required value
Telegram API Token. -
stringspec.telegram.apiUrlTelegram API URL.
Default:
https://api.telegram.org -
stringspec.telegram.templateTelegram message template.
-
-
stringspec.type
Required value
Notification channel type.Allowed values:
Email,Slack,Telegram,Webhook -
objectspec.webhookWebhook channel parameters.
-
stringspec.webhook.url
Required value
Webhook URL.
-
-
ClusterObservabilityNotificationPolicy
Scope: Cluster
Version: v1alpha1
-
objectspec
-
objectspec.alert
Required value
Alert matching parameters.-
array of stringsspec.alert.groupByLabelsGrouping by label
-
stringspec.alert.groupByLabels.Element of the arrayLabel name.
-
-
objectspec.alert.selector
Required value
Alert selector.-
array of objectsspec.alert.selector.matchExpressionsMatch expressions.
-
stringspec.alert.selector.matchExpressions.keyMatching key.
-
stringspec.alert.selector.matchExpressions.operatorMatching operator.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.alert.selector.matchExpressions.valueTarget value.
-
-
objectspec.alert.selector.matchLabelsLabel selector.
-
-
-
objectspec.notification
Required value
Alert notification parameters-
objectspec.notification.channel
Required value
Notification channel parameters.-
stringspec.notification.channel.kind
Required value
Channel object kind.Default:
ClusterObservabilityNotificationChannelAllowed values:
ClusterObservabilityNotificationChannel -
stringspec.notification.channel.name
Required value
Name of notification channel. -
objectspec.notification.channel.parameters
Required value
Notification channel parameters.
-
-
stringspec.notification.repeatInterval
Required value
Notification repeat interval.Default:
1m
-
-
ClusterObservabilityNotificationSilence
Scope: Cluster
Version: v1alpha1
-
objectspec
-
stringspec.endsAt
Required value
Notification silence end time. -
objectspec.selector
Required value
Alert selector.-
array of objectsspec.selector.matchExpressionsMatch expressions.
-
stringspec.selector.matchExpressions.keyMatching key.
-
stringspec.selector.matchExpressions.operatorMatching operator.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.selector.matchExpressions.valueTarget value.
-
-
objectspec.selector.matchLabelsLabel selector.
-
-
stringspec.startsAt
Required value
Notification silence start time.
-
ClusterObservabilityPropagatedDashboard
Scope: Cluster
Version: v1alpha1
Deckhouse internal system resource that lets you define a dashboard once and automatically make it available everywhere in the Deckhouse Console.
A dashboard defined as a ClusterObservabilityPropagatedDashboard is automatically visible: at the cluster level and in every namespace/project.
Supported annotations:
metadata.deckhouse.io/category— sets the folder/category in the UI.metadata.deckhouse.io/title— sets the visible dashboard title. If not set, the title from the dashboard JSON is used.
-
objectspec
-
stringspec.definition
Required value
The dashboard JSON manifest. The JSON definition should be provided as a raw JSON string compatible with the Grafana dashboard format.
-
ClusterObservabilityPropagatedMetricsRulesGroup
Scope: Cluster
Version: v1alpha1
-
objectspecClusterObservabilityPropagatedMetricsRulesGroupSpec defines the desired state of the propagated rules group
-
stringspec.intervalInterval for rule evaluation, e.g. ’30s’. If not specified, default interval will be used.
Default:
1mPattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of alerting and recording rules delivered by platform developers-
stringspec.rules.alertName of the alert. Required for alerting rules, mutually exclusive with record.
Pattern:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
objectspec.rules.annotationsAnnotations to attach to the alert (not valid for recording rules)
-
integer or stringspec.rules.exprPromQL expression to evaluate. No namespace enforcement will be applied to propagated rules.
-
stringspec.rules.forDuration for which the condition must be true before the alert fires
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
stringspec.rules.keep_firing_forDuration for which the alert continues firing after the condition becomes false
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
objectspec.rules.labelsAdditional labels to attach to the alert or recorded metric
-
stringspec.rules.recordName of the recorded metric. Required for recording rules, mutually exclusive with alert.
Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
ClusterObservabilityPropagatedNotificationChannel
Scope: Cluster
Version: v1alpha1
-
objectspec
-
objectspec.emailEmail channel parameters.
-
stringspec.email.from
Required value
Sender email address. -
objectspec.email.smtp
Required value
SMTP sender parameters.-
stringspec.email.smtp.address
Required value
Receiver email address. -
objectspec.email.smtp.authSender auth parameters.
-
stringspec.email.smtp.auth.password
Required value
Password. -
stringspec.email.smtp.auth.username
Required value
Username.
-
-
booleanspec.email.smtp.requireTLSRequire TLS verification.
-
-
stringspec.email.templateEmail body template.
-
-
objectspec.slackSlack channel parameters.
-
stringspec.slack.apiUrl
Required value
Slack API URL. -
stringspec.slack.colorColor of the Slack message attachment.
-
stringspec.slack.fallbackFallback text for the Slack message.
-
stringFooter text for the Slack message.
-
stringspec.slack.iconEmojiEmoji icon for the Slack message.
-
stringspec.slack.iconUrlURL for the icon image.
-
stringspec.slack.pretextPretext for the Slack message.
-
stringspec.slack.templateSlack message template.
-
stringspec.slack.textMain text content of the Slack message.
-
stringspec.slack.titleTitle of the Slack message.
-
stringspec.slack.titleLinkURL for the title link.
-
stringspec.slack.usernameUsername for the Slack message.
-
-
objectspec.telegramTelegram channel parameters.
-
stringspec.telegram.apiToken
Required value
Telegram API Token. -
stringspec.telegram.apiUrlTelegram API URL.
Default:
https://api.telegram.org -
stringspec.telegram.templateTelegram message template.
-
-
stringspec.type
Required value
Notification channel type.Allowed values:
Email,Slack,Telegram,Webhook -
objectspec.webhookWebhook channel parameters.
-
stringspec.webhook.url
Required value
Webhook URL.
-
-
ObservabilityDashboard
Scope: Namespaced
Version: v1alpha1
metadata.deckhouse.io/category — sets the folder/category in the UI. - metadata.deckhouse.io/title — sets the visible dashboard title.
If not set, the title from the dashboard JSON is used.-
objectspec
-
stringspec.definition
Required value
The dashboard’s JSON manifest. The JSON definition should be provided as a raw JSON string compatible with the Grafana dashboard format.
-
ObservabilityDatasource
Scope: Namespaced
Version: v1alpha1
-
objectspec
-
booleanspec.basicAuthEnable/disable basic auth.
-
stringspec.basicAuthUserBasic auth username.
-
stringspec.databaseDatabase name (if used).
-
objectspec.jsonDataFields to be converted to JSON and stored in jsonData.
-
objectspec.secureJsonDataJSON-data object to be saved encrypted.
-
stringspec.type
Required value
Datasource type. -
stringspec.urlDatasource URL.
-
stringspec.userDatabase username.
-
ObservabilityMetricsAlertingRule
Scope: Namespaced
Version: v1alpha1
-
objectspec
-
objectspec.alertMetadata
Required value
Alert metadata.-
objectspec.alertMetadata.additionalLabelsAdditional alert labels.
-
objectspec.alertMetadata.annotations
Required value
Additional alert annotations.
-
-
objectspec.delaysAlert firing delays.
-
stringspec.delays.firing
Required value
Time delay before firing an alert.Default:
1m -
stringspec.delays.resolving
Required value
Time delay before resolving an alert.Default:
1m
-
-
stringspec.expression
Required value
Alert expression (PromQL). -
array of objectsspec.thresholds
Required value
Alert thresholds.-
stringspec.thresholds.operatorComparison operator.
Allowed values:
Equal,NotEqual,GreaterThan,GreaterThanOrEqual,LessThan,LessThanOrEqual -
stringspec.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
Allowed values:
S1,S2,S3,S4,S5,S6,S7,S8,S9 -
stringspec.thresholds.valueExpressionMetric value or expression (PromQL).
-
-
ObservabilityMetricsAlertingRuleOverride
Scope: Namespaced
Version: v1alpha1
-
objectspec
-
objectspec.alertMetadata
Required value
Alert metadata.-
objectspec.alertMetadata.additionalLabelsAdditional alert labels.
-
objectspec.alertMetadata.annotations
Required value
Additional alert annotations.
-
-
stringspec.alertName
Required value
Name of alert that will be override -
objectspec.delaysAlert firing delays.
-
stringspec.delays.firing
Required value
Time delay before firing an alert. -
stringspec.delays.resolving
Required value
Time delay before resolving an alert.
-
-
booleanspec.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.
Default:
false -
stringspec.expression
Required value
Alert expression (PromQL). -
array of objectsspec.thresholds
Required value
Alert thresholds.-
stringspec.thresholds.operatorComparison operator.
Allowed values:
Equal,NotEqual,GreaterThan,GreaterThanOrEqual,LessThan,LessThanOrEqual -
stringspec.thresholds.severityAlert severity level.
Allowed values:
Critical,Warning,Info,Setup -
stringspec.thresholds.valueExpressionMetric value or expression (PromQL).
-
-
ObservabilityMetricsRecordingRule
Scope: Namespaced
Version: v1alpha1
-
objectspec
-
stringspec.expression
Required value
Source metric query (PromQL). -
objectspec.targetMetric
Required value
Target metric properties.-
objectspec.targetMetric.additionalLabelsTarget metric additional labels.
-
stringspec.targetMetric.name
Required value
Target metric name.
-
-
ObservabilityMetricsRulesGroup
Scope: Namespaced
Version: v1alpha1
-
objectspecObservabilityMetricsRulesGroupSpec defines the desired state of the rules group
-
stringspec.intervalInterval for rule evaluation, e.g. ’30s’. If not specified, default interval will be used.
Default:
1mPattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
array of objectsspec.rules
Required value
List of alerting and recording rules-
stringspec.rules.alertName of the alert. Required for alerting rules, mutually exclusive with record.
Pattern:
^[a-zA-Z-:][a-zA-Z0-9-:]*$ -
objectspec.rules.annotationsAnnotations to attach to the alert (not valid for recording rules)
-
integer or stringspec.rules.exprPromQL expression to evaluate
-
stringspec.rules.forDuration for which the condition must be true before the alert fires
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
stringspec.rules.keep_firing_forDuration for which the alert continues firing after the condition becomes false
Pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ -
objectspec.rules.labelsAdditional labels to attach to the alert or recorded metric
-
stringspec.rules.recordName of the recorded metric. Required for recording rules, mutually exclusive with alert.
Pattern:
^[a-zA-Z_:][a-zA-Z0-9_:]*$
-
-
ObservabilityNotificationChannel
Scope: Namespaced
Version: v1alpha1
-
objectspec
-
objectspec.emailEmail channel parameters.
-
stringspec.email.from
Required value
Sender email address. -
objectspec.email.smtp
Required value
SMTP sender parameters.-
stringspec.email.smtp.address
Required value
Receiver email address. -
objectspec.email.smtp.authSender auth parameters.
-
stringspec.email.smtp.auth.password
Required value
Password. -
stringspec.email.smtp.auth.username
Required value
Username.
-
-
booleanspec.email.smtp.requireTLSRequire TLS verification.
-
-
stringspec.email.templateEmail body template.
-
-
objectspec.slackSlack channel parameters.
-
stringspec.slack.apiUrl
Required value
Slack API URL. -
stringspec.slack.colorColor of the Slack message attachment.
-
stringspec.slack.fallbackFallback text for the Slack message.
-
stringFooter text for the Slack message.
-
stringspec.slack.iconEmojiEmoji icon for the Slack message.
-
stringspec.slack.iconUrlURL for the icon image.
-
stringspec.slack.pretextPretext for the Slack message.
-
stringspec.slack.templateSlack message template.
-
stringspec.slack.textMain text content of the Slack message.
-
stringspec.slack.titleTitle of the Slack message.
-
stringspec.slack.titleLinkURL for the title link.
-
stringspec.slack.usernameUsername for the Slack message.
-
-
objectspec.telegramTelegram channel parameters.
-
stringspec.telegram.apiToken
Required value
Telegram API Token. -
stringspec.telegram.apiUrlTelegram API URL.
Default:
https://api.telegram.org -
stringspec.telegram.templateTelegram message template.
-
-
stringspec.type
Required value
Notification channel type.Allowed values:
Email,Slack,Telegram,Webhook -
objectspec.webhookWebhook channel parameters.
-
stringspec.webhook.url
Required value
Webhook URL.
-
-
ObservabilityNotificationPolicy
Scope: Namespaced
Version: v1alpha1
-
objectspec
-
objectspec.alert
Required value
Alert matching parameters.-
array of stringsspec.alert.groupByLabelsGrouping by label
-
stringspec.alert.groupByLabels.Element of the arrayLabel name.
-
-
objectspec.alert.selector
Required value
Alert selector.-
array of objectsspec.alert.selector.matchExpressionsMatch expressions.
-
stringspec.alert.selector.matchExpressions.keyMatching key.
-
stringspec.alert.selector.matchExpressions.operatorMatching operator.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.alert.selector.matchExpressions.valueTarget value.
-
-
objectspec.alert.selector.matchLabelsLabel selector.
-
-
-
objectspec.notification
Required value
Alert notification parameters-
objectspec.notification.channel
Required value
Notification channel parameters.-
stringspec.notification.channel.kind
Required value
Channel object kind.Default:
ObservabilityNotificationChannelAllowed values:
ClusterObservabilityPropagatedNotificationChannel,ObservabilityNotificationChannel -
stringspec.notification.channel.name
Required value
Name of notification channel. -
objectspec.notification.channel.parameters
Required value
Notification channel parameters.
-
-
stringspec.notification.repeatInterval
Required value
Notification repeat interval.Default:
1m
-
-
ObservabilityNotificationSilence
Scope: Namespaced
Version: v1alpha1
-
objectspec
-
stringspec.endsAt
Required value
Notification silence end time. -
objectspec.selector
Required value
Alert selector.-
array of objectsspec.selector.matchExpressionsMatch expressions.
-
stringspec.selector.matchExpressions.keyMatching key.
-
stringspec.selector.matchExpressions.operatorMatching operator.
Allowed values:
Equal,NotEqual,Regex,NotRegex -
stringspec.selector.matchExpressions.valueTarget value.
-
-
objectspec.selector.matchLabelsLabel selector.
-
-
stringspec.startsAt
Required value
Notification silence start time.
-