Preliminary version. The functionality may change, but the basic features will be preserved. Compatibility with future versions is ensured, but may require additional migration actions.

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

Defines a cluster-level dashboard that is displayed in the Deckhouse Console. This resource is not bound to any specific namespace. 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.
  • spec
    object
    • spec.definition
      string

      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

The resource for storing and managing observability platform recording rule.
  • spec
    object
    • spec.expression
      string

      Required value

      Source metric query (PromQL).
    • spec.targetMetric
      object

      Required value

      Target metric properties.
      • spec.targetMetric.additionalLabels
        object
        Target metric additional labels.
      • spec.targetMetric.name
        string

        Required value

        Target metric name.

ClusterObservabilityMetricsRulesGroup

Scope: Cluster
Version: v1alpha1

The resource for storing and managing cluster-level observability platform metrics rules groups. This resource allows platform administrators to manage monitoring rules and alerts that apply to infrastructure and system namespaces (kube-, d8-, and empty namespace).
  • spec
    object
    ClusterObservabilityMetricsRulesGroupSpec defines the desired state of the cluster rules group
    • spec.interval
      string
      Interval for rule evaluation, e.g. ’30s’. If not specified, default interval will be used.

      Default: 1m

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

    • spec.rules
      array of objects

      Required value

      List of alerting and recording rules for cluster-level monitoring
      • spec.rules.alert
        string
        Name of the alert. Required for alerting rules, mutually exclusive with record.

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

      • spec.rules.annotations
        object
        Annotations to attach to the alert (not valid for recording rules)
      • spec.rules.expr
        integer or string
        PromQL expression to evaluate. Will be automatically scoped to infrastructure namespaces (kube-, d8-, empty).
      • spec.rules.for
        string
        Duration 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)?)$

      • spec.rules.keep_firing_for
        string
        Duration 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)?)$

      • spec.rules.labels
        object
        Additional labels to attach to the alert or recorded metric
      • spec.rules.record
        string
        Name 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

The resource for storing and managing observability platform notification channels.
  • spec
    object
    • spec.email
      object
      Email channel parameters.
      • spec.email.from
        string

        Required value

        Sender email address.
      • spec.email.smtp
        object

        Required value

        SMTP sender parameters.
        • spec.email.smtp.address
          string

          Required value

          Receiver email address.
        • spec.email.smtp.auth
          object
          Sender auth parameters.
          • spec.email.smtp.auth.password
            string

            Required value

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

            Required value

            Username.
        • spec.email.smtp.requireTLS
          boolean
          Require TLS verification.
      • spec.email.template
        string
        Email body template.
    • spec.slack
      object
      Slack channel parameters.
      • spec.slack.apiUrl
        string

        Required value

        Slack API URL.
      • spec.slack.color
        string
        Color of the Slack message attachment.
      • spec.slack.fallback
        string
        Fallback text for the Slack message.
      • spec.slack.footer
        string
        Footer text for the Slack message.
      • spec.slack.iconEmoji
        string
        Emoji icon for the Slack message.
      • spec.slack.iconUrl
        string
        URL for the icon image.
      • spec.slack.pretext
        string
        Pretext for the Slack message.
      • spec.slack.template
        string
        Slack message template.
      • spec.slack.text
        string
        Main text content of the Slack message.
      • spec.slack.title
        string
        Title of the Slack message.
      • spec.slack.titleLink
        string
        URL for the title link.
      • spec.slack.username
        string
        Username for the Slack message.
    • spec.telegram
      object
      Telegram channel parameters.
      • spec.telegram.apiToken
        string

        Required value

        Telegram API Token.
      • spec.telegram.apiUrl
        string
        Telegram API URL.

        Default: https://api.telegram.org

      • spec.telegram.template
        string
        Telegram message template.
    • spec.type
      string

      Required value

      Notification channel type.

      Allowed values: Email, Slack, Telegram, Webhook

    • spec.webhook
      object
      Webhook channel parameters.
      • spec.webhook.url
        string

        Required value

        Webhook URL.

ClusterObservabilityNotificationPolicy

Scope: Cluster
Version: v1alpha1

The resource for storing and managing observability platform notification policies.
  • spec
    object
    • spec.alert
      object

      Required value

      Alert matching parameters.
      • spec.alert.groupByLabels
        array of strings
        Grouping by label
        • spec.alert.groupByLabels.Element of the array
          string
          Label name.
      • spec.alert.selector
        object

        Required value

        Alert selector.
        • spec.alert.selector.matchExpressions
          array of objects
          Match expressions.
          • spec.alert.selector.matchExpressions.key
            string
            Matching key.
          • spec.alert.selector.matchExpressions.operator
            string
            Matching operator.

            Allowed values: Equal, NotEqual, Regex, NotRegex

          • spec.alert.selector.matchExpressions.value
            string
            Target value.
        • spec.alert.selector.matchLabels
          object
          Label selector.
    • spec.notification
      object

      Required value

      Alert notification parameters
      • spec.notification.channel
        object

        Required value

        Notification channel parameters.
        • spec.notification.channel.kind
          string

          Required value

          Channel object kind.

          Default: ClusterObservabilityNotificationChannel

          Allowed values: ClusterObservabilityNotificationChannel

        • spec.notification.channel.name
          string

          Required value

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

          Required value

          Notification channel parameters.
      • spec.notification.repeatInterval
        string

        Required value

        Notification repeat interval.

        Default: 1m

ClusterObservabilityNotificationSilence

Scope: Cluster
Version: v1alpha1

The resource for storing and managing observability platform notification silence.
  • spec
    object
    • spec.endsAt
      string

      Required value

      Notification silence end time.
    • spec.selector
      object

      Required value

      Alert selector.
      • spec.selector.matchExpressions
        array of objects
        Match expressions.
        • spec.selector.matchExpressions.key
          string
          Matching key.
        • spec.selector.matchExpressions.operator
          string
          Matching operator.

          Allowed values: Equal, NotEqual, Regex, NotRegex

        • spec.selector.matchExpressions.value
          string
          Target value.
      • spec.selector.matchLabels
        object
        Label selector.
    • spec.startsAt
      string

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

      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

The resource for storing and managing platform-propagated observability metrics rules groups. This resource allows platform developers to deliver standard monitoring rules and alerts that are available across all namespaces without namespace enforcement. Resources with heritage=deckhouse can only be managed by Deckhouse ServiceAccount.
  • spec
    object
    ClusterObservabilityPropagatedMetricsRulesGroupSpec defines the desired state of the propagated rules group
    • spec.interval
      string
      Interval for rule evaluation, e.g. ’30s’. If not specified, default interval will be used.

      Default: 1m

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

    • spec.rules
      array of objects

      Required value

      List of alerting and recording rules delivered by platform developers
      • spec.rules.alert
        string
        Name of the alert. Required for alerting rules, mutually exclusive with record.

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

      • spec.rules.annotations
        object
        Annotations to attach to the alert (not valid for recording rules)
      • spec.rules.expr
        integer or string
        PromQL expression to evaluate. No namespace enforcement will be applied to propagated rules.
      • spec.rules.for
        string
        Duration 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)?)$

      • spec.rules.keep_firing_for
        string
        Duration 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)?)$

      • spec.rules.labels
        object
        Additional labels to attach to the alert or recorded metric
      • spec.rules.record
        string
        Name 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

The resource for storing and managing observability platform notification channels.
  • spec
    object
    • spec.email
      object
      Email channel parameters.
      • spec.email.from
        string

        Required value

        Sender email address.
      • spec.email.smtp
        object

        Required value

        SMTP sender parameters.
        • spec.email.smtp.address
          string

          Required value

          Receiver email address.
        • spec.email.smtp.auth
          object
          Sender auth parameters.
          • spec.email.smtp.auth.password
            string

            Required value

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

            Required value

            Username.
        • spec.email.smtp.requireTLS
          boolean
          Require TLS verification.
      • spec.email.template
        string
        Email body template.
    • spec.slack
      object
      Slack channel parameters.
      • spec.slack.apiUrl
        string

        Required value

        Slack API URL.
      • spec.slack.color
        string
        Color of the Slack message attachment.
      • spec.slack.fallback
        string
        Fallback text for the Slack message.
      • spec.slack.footer
        string
        Footer text for the Slack message.
      • spec.slack.iconEmoji
        string
        Emoji icon for the Slack message.
      • spec.slack.iconUrl
        string
        URL for the icon image.
      • spec.slack.pretext
        string
        Pretext for the Slack message.
      • spec.slack.template
        string
        Slack message template.
      • spec.slack.text
        string
        Main text content of the Slack message.
      • spec.slack.title
        string
        Title of the Slack message.
      • spec.slack.titleLink
        string
        URL for the title link.
      • spec.slack.username
        string
        Username for the Slack message.
    • spec.telegram
      object
      Telegram channel parameters.
      • spec.telegram.apiToken
        string

        Required value

        Telegram API Token.
      • spec.telegram.apiUrl
        string
        Telegram API URL.

        Default: https://api.telegram.org

      • spec.telegram.template
        string
        Telegram message template.
    • spec.type
      string

      Required value

      Notification channel type.

      Allowed values: Email, Slack, Telegram, Webhook

    • spec.webhook
      object
      Webhook channel parameters.
      • spec.webhook.url
        string

        Required value

        Webhook URL.

ObservabilityDashboard

Scope: Namespaced
Version: v1alpha1

Defines a dashboard that will be displayed in the Deckhouse Console. This resource is namespaced, allowing teams to create and manage their own dashboards independently within their namespaces. The following annotations are supported: - 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.
  • spec
    object
    • spec.definition
      string

      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

The resource for storing and managing observability datasources.
  • spec
    object
    • spec.basicAuth
      boolean
      Enable/disable basic auth.
    • spec.basicAuthUser
      string
      Basic auth username.
    • spec.database
      string
      Database name (if used).
    • spec.jsonData
      object
      Fields to be converted to JSON and stored in jsonData.
    • spec.secureJsonData
      object
      JSON-data object to be saved encrypted.
    • spec.type
      string

      Required value

      Datasource type.
    • spec.url
      string
      Datasource URL.
    • spec.user
      string
      Database username.
    • spec.withCredentials
      boolean
      Enable/disable with credentials headers (details…).

ObservabilityMetricsAlertingRule

Scope: Namespaced
Version: v1alpha1

The resource for storing and managing observability platform alerting rule.
  • spec
    object
    • spec.alertMetadata
      object

      Required value

      Alert metadata.
      • spec.alertMetadata.additionalLabels
        object
        Additional alert labels.
      • spec.alertMetadata.annotations
        object

        Required value

        Additional alert annotations.
    • spec.delays
      object
      Alert firing delays.
      • spec.delays.firing
        string

        Required value

        Time delay before firing an alert.

        Default: 1m

      • spec.delays.resolving
        string

        Required value

        Time delay before resolving an alert.

        Default: 1m

    • spec.expression
      string

      Required value

      Alert expression (PromQL).
    • spec.thresholds
      array of objects

      Required value

      Alert thresholds.
      • spec.thresholds.operator
        string
        Comparison operator.

        Allowed values: Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual

      • spec.thresholds.severity
        string
        Alert 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

      • spec.thresholds.valueExpression
        string
        Metric value or expression (PromQL).

ObservabilityMetricsAlertingRuleOverride

Scope: Namespaced
Version: v1alpha1

The resource for storing and managing observability platform alerting rule overrides.
  • spec
    object
    • spec.alertMetadata
      object

      Required value

      Alert metadata.
      • spec.alertMetadata.additionalLabels
        object
        Additional alert labels.
      • spec.alertMetadata.annotations
        object

        Required value

        Additional alert annotations.
    • spec.alertName
      string

      Required value

      Name of alert that will be override
    • spec.delays
      object
      Alert firing delays.
      • spec.delays.firing
        string

        Required value

        Time delay before firing an alert.
      • spec.delays.resolving
        string

        Required value

        Time delay before resolving an alert.
    • spec.disable
      boolean
      Indicates 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

    • spec.expression
      string

      Required value

      Alert expression (PromQL).
    • spec.thresholds
      array of objects

      Required value

      Alert thresholds.
      • spec.thresholds.operator
        string
        Comparison operator.

        Allowed values: Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual

      • spec.thresholds.severity
        string
        Alert severity level.

        Allowed values: Critical, Warning, Info, Setup

      • spec.thresholds.valueExpression
        string
        Metric value or expression (PromQL).

ObservabilityMetricsRecordingRule

Scope: Namespaced
Version: v1alpha1

The resource for storing and managing observability platform recording rule.
  • spec
    object
    • spec.expression
      string

      Required value

      Source metric query (PromQL).
    • spec.targetMetric
      object

      Required value

      Target metric properties.
      • spec.targetMetric.additionalLabels
        object
        Target metric additional labels.
      • spec.targetMetric.name
        string

        Required value

        Target metric name.

ObservabilityMetricsRulesGroup

Scope: Namespaced
Version: v1alpha1

The resource for storing and managing observability platform metrics rules groups. This resource allows project administrators to manage their monitoring rules and alerts within their namespace scope.
  • spec
    object
    ObservabilityMetricsRulesGroupSpec defines the desired state of the rules group
    • spec.interval
      string
      Interval for rule evaluation, e.g. ’30s’. If not specified, default interval will be used.

      Default: 1m

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

    • spec.rules
      array of objects

      Required value

      List of alerting and recording rules
      • spec.rules.alert
        string
        Name of the alert. Required for alerting rules, mutually exclusive with record.

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

      • spec.rules.annotations
        object
        Annotations to attach to the alert (not valid for recording rules)
      • spec.rules.expr
        integer or string
        PromQL expression to evaluate
      • spec.rules.for
        string
        Duration 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)?)$

      • spec.rules.keep_firing_for
        string
        Duration 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)?)$

      • spec.rules.labels
        object
        Additional labels to attach to the alert or recorded metric
      • spec.rules.record
        string
        Name 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

The resource for storing and managing observability platform notification channels.
  • spec
    object
    • spec.email
      object
      Email channel parameters.
      • spec.email.from
        string

        Required value

        Sender email address.
      • spec.email.smtp
        object

        Required value

        SMTP sender parameters.
        • spec.email.smtp.address
          string

          Required value

          Receiver email address.
        • spec.email.smtp.auth
          object
          Sender auth parameters.
          • spec.email.smtp.auth.password
            string

            Required value

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

            Required value

            Username.
        • spec.email.smtp.requireTLS
          boolean
          Require TLS verification.
      • spec.email.template
        string
        Email body template.
    • spec.slack
      object
      Slack channel parameters.
      • spec.slack.apiUrl
        string

        Required value

        Slack API URL.
      • spec.slack.color
        string
        Color of the Slack message attachment.
      • spec.slack.fallback
        string
        Fallback text for the Slack message.
      • spec.slack.footer
        string
        Footer text for the Slack message.
      • spec.slack.iconEmoji
        string
        Emoji icon for the Slack message.
      • spec.slack.iconUrl
        string
        URL for the icon image.
      • spec.slack.pretext
        string
        Pretext for the Slack message.
      • spec.slack.template
        string
        Slack message template.
      • spec.slack.text
        string
        Main text content of the Slack message.
      • spec.slack.title
        string
        Title of the Slack message.
      • spec.slack.titleLink
        string
        URL for the title link.
      • spec.slack.username
        string
        Username for the Slack message.
    • spec.telegram
      object
      Telegram channel parameters.
      • spec.telegram.apiToken
        string

        Required value

        Telegram API Token.
      • spec.telegram.apiUrl
        string
        Telegram API URL.

        Default: https://api.telegram.org

      • spec.telegram.template
        string
        Telegram message template.
    • spec.type
      string

      Required value

      Notification channel type.

      Allowed values: Email, Slack, Telegram, Webhook

    • spec.webhook
      object
      Webhook channel parameters.
      • spec.webhook.url
        string

        Required value

        Webhook URL.

ObservabilityNotificationPolicy

Scope: Namespaced
Version: v1alpha1

The resource for storing and managing observability platform notification policies.
  • spec
    object
    • spec.alert
      object

      Required value

      Alert matching parameters.
      • spec.alert.groupByLabels
        array of strings
        Grouping by label
        • spec.alert.groupByLabels.Element of the array
          string
          Label name.
      • spec.alert.selector
        object

        Required value

        Alert selector.
        • spec.alert.selector.matchExpressions
          array of objects
          Match expressions.
          • spec.alert.selector.matchExpressions.key
            string
            Matching key.
          • spec.alert.selector.matchExpressions.operator
            string
            Matching operator.

            Allowed values: Equal, NotEqual, Regex, NotRegex

          • spec.alert.selector.matchExpressions.value
            string
            Target value.
        • spec.alert.selector.matchLabels
          object
          Label selector.
    • spec.notification
      object

      Required value

      Alert notification parameters
      • spec.notification.channel
        object

        Required value

        Notification channel parameters.
        • spec.notification.channel.kind
          string

          Required value

          Channel object kind.

          Default: ObservabilityNotificationChannel

          Allowed values: ClusterObservabilityPropagatedNotificationChannel, ObservabilityNotificationChannel

        • spec.notification.channel.name
          string

          Required value

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

          Required value

          Notification channel parameters.
      • spec.notification.repeatInterval
        string

        Required value

        Notification repeat interval.

        Default: 1m

ObservabilityNotificationSilence

Scope: Namespaced
Version: v1alpha1

The resource for storing and managing observability platform notification silence.
  • spec
    object
    • spec.endsAt
      string

      Required value

      Notification silence end time.
    • spec.selector
      object

      Required value

      Alert selector.
      • spec.selector.matchExpressions
        array of objects
        Match expressions.
        • spec.selector.matchExpressions.key
          string
          Matching key.
        • spec.selector.matchExpressions.operator
          string
          Matching operator.

          Allowed values: Equal, NotEqual, Regex, NotRegex

        • spec.selector.matchExpressions.value
          string
          Target value.
      • spec.selector.matchLabels
        object
        Label selector.
    • spec.startsAt
      string

      Required value

      Notification silence start time.