The module lifecycle stage: General Availability
The module has requirements for installation

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.

ClusterLog

Scope: Cluster
Version: v1alpha1

ClusterObservabilityAlertAdditionalLabels

Scope: Cluster
Version: v1alpha1

Defines additional labels to add to alert notifications shipped with DKP.

If an alert already contains a label with the same key, its value is preserved.

Warning. Additional labels are applied only to alerts created using the resources labeled with heritage: deckhouse.

  • spec
    object
    • spec.additionalLabels
      object

      Required value

      Additional labels to add to each matching alert.

      If an alert already contains a label with the same key, its value is preserved.

    • spec.alertSelector
      object

      Required value

      Defines the alerts that will receive the additional labels.

      Matching is performed against alert labels and the alert name. The alertname label corresponds to the alert name.

      Warning. This field is required and must not be empty.

      • spec.alertSelector.matchExpressions
        array of objects

        Required value

        List of label selector requirements.

        All requirements must be satisfied.

        • spec.alertSelector.matchExpressions.key
          string
          Name of the label whose value is evaluated.
        • spec.alertSelector.matchExpressions.operator
          string

          Comparison operator:

          • In: Label must exist and its value must be included in the values list.
          • NotIn: Label must not exist or its value must not be included in the values list.
          • Exists: Label must exist regardless of its value.
          • DoesNotExist: Label must not exist.

          Allowed values: In, NotIn, Exists, DoesNotExist

        • spec.alertSelector.matchExpressions.values
          array of strings
          List of values for the In and NotIn operators.
      • spec.alertSelector.matchLabels
        object
        Exact key-value pairs that must be present on the alert.

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.

ClusterObservabilityMetricsRulesGroup

Scope: Cluster
Version: v1alpha1

Group of cluster-wide alerting or recording rules.

This resource lets platform administrators manage monitoring rules and alerts that apply to infrastructure and system namespaces (kube-*, d8-*, and an empty namespace).

  • spec
    object
    Defines the desired state of the cluster rules group.
    • spec.interval
      string

      Rule evaluation interval.

      For example, 30s.

      If not specified, the default interval is used.

      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

      Group of cluster-wide alerting or recording rules.
      • spec.rules.alert
        string

        Name of the alerting rule.

        Only one of the fields can be specified at the same time: alert or record.

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

      • spec.rules.annotations
        object

        Annotations to attach to the alert.

        Not applicable to recording rules.

      • spec.rules.expr
        integer or string

        PromQL expression to evaluate the rule.

        Automatically scoped to infrastructure and system namespaces (kube-*, d8-*, and an empty namespace).

      • spec.rules.for
        string

        Delay before the alert is triggered.

        Defines how long the condition must continuously be true before the alert transitions to the firing state.

        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

        Delay before the alert is resolved.

        Defines how long the alert remains in the firing state 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 recording rule.
      • spec.rules.record
        string

        Name of the recording rule.

        Only one of the fields can be specified at the same time: alert or record.

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

  • status
    object
    Defines the observed state of the cluster rules group.
    • status.conditions
      array of objects
      The latest available observations of the cluster rules group state.
      • status.conditions.lastTransitionTime
        string
        Last time the condition transitioned from one status to another.
      • status.conditions.message
        string
        Human-readable message indicating details about last transition.
      • status.conditions.reason
        string

        Reason for the condition’s last transition.

        Specified in one word in CamelCase format.

      • status.conditions.status
        string

        Current status of the condition:

        • True: Condition is satisfied.
        • False: Condition is not satisfied.
        • Unknown: Condition could not be determined.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string

        Type of the rules group condition:

        • Created: Resource is created.
        • Failed: Syncing failed.
        • Ready: Rules group is applied and active.

        Allowed values: Created, Failed, Ready

    • status.lastSyncTime
      string
      Last time the cluster rules group was successfully synced.
    • status.prometheusRuleName
      string
      Name of the PrometheusRule resource created for this cluster rules group.

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.expressMessenger
      object
      eXpress messenger channel parameters.
      • spec.expressMessenger.apiUrl
        string

        Required value

        eXpress CTS server URL.
      • spec.expressMessenger.botId
        string

        Required value

        eXpress bot ID (UUID).

        Pattern: ^[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
        string

        Required value

        eXpress bot secret key for JWT signing.
      • spec.expressMessenger.template
        string
        eXpress message 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.httpConfig
        object
        HTTP client options for the Alertmanager telegram receiver (http_config). Use proxyUrl or proxyFromEnvironment when the Telegram API is only reachable via a proxy. basicAuth and authorization must not be used together. oauth2 cannot be used together with basicAuth or authorization.
        • spec.telegram.httpConfig.authorization
          object
          Static Authorization header; mutually exclusive with basicAuth.
          • spec.telegram.httpConfig.authorization.credentials
            string
          • spec.telegram.httpConfig.authorization.credentialsFile
            string
            Path to a credentials file available inside the alertmanager container.
          • spec.telegram.httpConfig.authorization.type
            string
            Authentication scheme (Alertmanager default is Bearer when unset).
        • spec.telegram.httpConfig.basicAuth
          object
          HTTP basic authentication for outbound Telegram API requests.
          • spec.telegram.httpConfig.basicAuth.password
            string
          • spec.telegram.httpConfig.basicAuth.passwordFile
            string
            Path to a password file available inside the alertmanager container.
          • spec.telegram.httpConfig.basicAuth.username
            string
        • spec.telegram.httpConfig.enableHttp2
          boolean
        • spec.telegram.httpConfig.followRedirects
          boolean
        • spec.telegram.httpConfig.httpHeaders
          object
          Custom HTTP headers for Telegram API requests.
          • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
        • spec.telegram.httpConfig.noProxy
          string
        • spec.telegram.httpConfig.oauth2
          object
          OAuth2 client credentials; mutually exclusive with basicAuth and authorization.
          • spec.telegram.httpConfig.oauth2.clientId
            string

            Required value

          • spec.telegram.httpConfig.oauth2.clientSecret
            string
          • spec.telegram.httpConfig.oauth2.clientSecretFile
            string
          • spec.telegram.httpConfig.oauth2.endpointParams
            object
          • spec.telegram.httpConfig.oauth2.noProxy
            string
          • spec.telegram.httpConfig.oauth2.proxyFromEnvironment
            boolean
          • spec.telegram.httpConfig.oauth2.proxyUrl
            string
          • spec.telegram.httpConfig.oauth2.scopes
            array of strings
          • spec.telegram.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.telegram.httpConfig.oauth2.tlsConfig.caFile
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.certFile
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
            • spec.telegram.httpConfig.oauth2.tlsConfig.keyFile
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.maxVersion
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.minVersion
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.serverName
              string
          • spec.telegram.httpConfig.oauth2.tokenUrl
            string

            Required value

        • spec.telegram.httpConfig.proxyConnectHeader
          object
          Header names mapped to header values for CONNECT requests to proxies.
        • spec.telegram.httpConfig.proxyFromEnvironment
          boolean
        • spec.telegram.httpConfig.proxyUrl
          string
        • spec.telegram.httpConfig.tlsConfig
          object
          TLS settings for the Telegram notifier HTTP client.
          • spec.telegram.httpConfig.tlsConfig.caFile
            string
          • spec.telegram.httpConfig.tlsConfig.certFile
            string
          • spec.telegram.httpConfig.tlsConfig.insecureSkipVerify
            boolean
          • spec.telegram.httpConfig.tlsConfig.keyFile
            string
          • spec.telegram.httpConfig.tlsConfig.maxVersion
            string
          • spec.telegram.httpConfig.tlsConfig.minVersion
            string
          • spec.telegram.httpConfig.tlsConfig.serverName
            string
      • spec.telegram.template
        string
        Telegram message template.
    • spec.type
      string

      Required value

      Notification channel type.

      Allowed values: Email, Slack, Telegram, Webhook, ExpressMessenger

    • spec.webhook
      object
      Webhook channel parameters.
      • spec.webhook.httpConfig
        object
        HTTP client options for the Alertmanager webhook receiver (http_config). basicAuth and authorization must not be used together. oauth2 cannot be used together with basicAuth or authorization.
        • spec.webhook.httpConfig.authorization
          object
          Static Authorization header; mutually exclusive with basicAuth.
          • spec.webhook.httpConfig.authorization.credentials
            string
          • spec.webhook.httpConfig.authorization.credentialsFile
            string
            Path to a credentials file available inside the alertmanager container.
          • spec.webhook.httpConfig.authorization.type
            string
            Authentication scheme (Alertmanager default is Bearer when unset).
        • spec.webhook.httpConfig.basicAuth
          object
          HTTP basic authentication for webhook requests.
          • spec.webhook.httpConfig.basicAuth.password
            string
          • spec.webhook.httpConfig.basicAuth.passwordFile
            string
            Path to a password file available inside the alertmanager container.
          • spec.webhook.httpConfig.basicAuth.username
            string
        • spec.webhook.httpConfig.enableHttp2
          boolean
        • spec.webhook.httpConfig.followRedirects
          boolean
        • spec.webhook.httpConfig.httpHeaders
          object
          Custom HTTP headers appended to webhook requests.
          • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
        • spec.webhook.httpConfig.noProxy
          string
        • spec.webhook.httpConfig.oauth2
          object
          OAuth2 client credentials; mutually exclusive with basicAuth and authorization.
          • spec.webhook.httpConfig.oauth2.clientId
            string

            Required value

          • spec.webhook.httpConfig.oauth2.clientSecret
            string
          • spec.webhook.httpConfig.oauth2.clientSecretFile
            string
          • spec.webhook.httpConfig.oauth2.endpointParams
            object
          • spec.webhook.httpConfig.oauth2.noProxy
            string
          • spec.webhook.httpConfig.oauth2.proxyFromEnvironment
            boolean
          • spec.webhook.httpConfig.oauth2.proxyUrl
            string
          • spec.webhook.httpConfig.oauth2.scopes
            array of strings
          • spec.webhook.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.webhook.httpConfig.oauth2.tlsConfig.caFile
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.certFile
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
            • spec.webhook.httpConfig.oauth2.tlsConfig.keyFile
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.maxVersion
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.minVersion
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.serverName
              string
          • spec.webhook.httpConfig.oauth2.tokenUrl
            string

            Required value

        • spec.webhook.httpConfig.proxyConnectHeader
          object
          Header names mapped to header values for CONNECT requests to proxies.
        • spec.webhook.httpConfig.proxyFromEnvironment
          boolean
        • spec.webhook.httpConfig.proxyUrl
          string
        • spec.webhook.httpConfig.tlsConfig
          object
          TLS settings for the webhook HTTP client.
          • spec.webhook.httpConfig.tlsConfig.caFile
            string
          • spec.webhook.httpConfig.tlsConfig.certFile
            string
          • spec.webhook.httpConfig.tlsConfig.insecureSkipVerify
            boolean
          • spec.webhook.httpConfig.tlsConfig.keyFile
            string
          • spec.webhook.httpConfig.tlsConfig.maxVersion
            string
          • spec.webhook.httpConfig.tlsConfig.minVersion
            string
          • spec.webhook.httpConfig.tlsConfig.serverName
            string
      • spec.webhook.url
        string

        Required value

        Webhook URL.

        Minimal length: 1

  • status
    object
    Status information about the notification channel, including which policies are using it.
    • status.policies
      array of objects
      List of notification policies that are using this channel across all namespaces.
      • status.policies.name
        string
        Name of the notification policy using this channel.
      • status.policies.namespace
        string
        Namespace of the notification policy. Empty string for cluster-scoped policies.

ClusterObservabilityNotificationPolicy

Scope: Cluster
Version: v1alpha1

A cluster-scoped resource that defines how alerts are routed to notification channels: which alerts are selected (by labels), to which channel they are sent, and how often the notification is repeated.
  • spec
    object
    • spec.alert
      object

      Required value

      Alert matching parameters: determine which alerts this notification policy applies to.
      • spec.alert.groupByLabels
        array of strings
        List of labels used to group alerts into a single notification: alerts that share the same values of the listed labels are merged and sent to the channel as one message.
        • spec.alert.groupByLabels.Element of the array
          string
          Label name.
      • spec.alert.selector
        object

        Required value

        Alert selector by labels: defines which alerts are matched. Either matchLabels or matchExpressions must be set.
        • spec.alert.selector.matchExpressions
          array of objects
          Match expressions.
          • spec.alert.selector.matchExpressions.key
            string
            Name of the alert label to evaluate against the matching condition.
          • 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

  • status
    object
    • status.description
      string
    • status.state
      string

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 by labels: defines which alerts are matched by this silence. Either matchLabels or matchExpressions must be set.
      • spec.selector.matchExpressions
        array of objects
        Match expressions.
        • spec.selector.matchExpressions.key
          string
          Name of the alert label to evaluate against the matching condition.
        • 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 set for selecting alerts. Notifications for alerts whose labels match all of the specified ones are suppressed for the duration of the silence.
    • 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. Resources with heritage=deckhouse can only be managed by the Deckhouse ServiceAccount: end users cannot create or modify them. It allows platform developers to deliver standard monitoring rules and alerts that are available across all namespaces without namespace enforcement.
  • 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_:]*$

  • status
    object
    ClusterObservabilityPropagatedMetricsRulesGroupStatus defines the observed state of the propagated rules group
    • status.conditions
      array of objects
      Conditions represent the latest available observations of the propagated rules group state
      • status.conditions.lastTransitionTime
        string
        Last time the condition transitioned from one status to another
      • status.conditions.message
        string
        Human-readable message indicating details about last transition
      • status.conditions.reason
        string
        Unique, one-word, CamelCase reason for the condition’s last transition
      • status.conditions.status
        string
        Current value of the condition: True — satisfied, False — not satisfied, Unknown — could not be determined.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        Type of the rules group condition: Created — resource is created, Failed — sync failed, Ready — rules group is applied and active.

        Allowed values: Created, Failed, Ready

    • status.lastSyncTime
      string
      Last time the propagated rules group was successfully synced
    • status.prometheusRuleName
      string
      Name of the PrometheusRule resource created for this propagated rules group

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.expressMessenger
      object
      eXpress messenger channel parameters.
      • spec.expressMessenger.apiUrl
        string

        Required value

        eXpress CTS server URL.
      • spec.expressMessenger.botId
        string

        Required value

        eXpress bot ID (UUID).

        Pattern: ^[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
        string

        Required value

        eXpress bot secret key for JWT signing.
      • spec.expressMessenger.template
        string
        eXpress message 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.httpConfig
        object
        HTTP client options for the Alertmanager telegram receiver (http_config). Use proxyUrl or proxyFromEnvironment when the Telegram API is only reachable via a proxy. basicAuth and authorization must not be used together. oauth2 cannot be used together with basicAuth or authorization.
        • spec.telegram.httpConfig.authorization
          object
          Static Authorization header; mutually exclusive with basicAuth.
          • spec.telegram.httpConfig.authorization.credentials
            string
          • spec.telegram.httpConfig.authorization.credentialsFile
            string
            Path to a credentials file available inside the alertmanager container.
          • spec.telegram.httpConfig.authorization.type
            string
            Authentication scheme (Alertmanager default is Bearer when unset).
        • spec.telegram.httpConfig.basicAuth
          object
          HTTP basic authentication for outbound Telegram API requests.
          • spec.telegram.httpConfig.basicAuth.password
            string
          • spec.telegram.httpConfig.basicAuth.passwordFile
            string
            Path to a password file available inside the alertmanager container.
          • spec.telegram.httpConfig.basicAuth.username
            string
        • spec.telegram.httpConfig.enableHttp2
          boolean
        • spec.telegram.httpConfig.followRedirects
          boolean
        • spec.telegram.httpConfig.httpHeaders
          object
          Custom HTTP headers for Telegram API requests.
          • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
        • spec.telegram.httpConfig.noProxy
          string
        • spec.telegram.httpConfig.oauth2
          object
          OAuth2 client credentials; mutually exclusive with basicAuth and authorization.
          • spec.telegram.httpConfig.oauth2.clientId
            string

            Required value

          • spec.telegram.httpConfig.oauth2.clientSecret
            string
          • spec.telegram.httpConfig.oauth2.clientSecretFile
            string
          • spec.telegram.httpConfig.oauth2.endpointParams
            object
          • spec.telegram.httpConfig.oauth2.noProxy
            string
          • spec.telegram.httpConfig.oauth2.proxyFromEnvironment
            boolean
          • spec.telegram.httpConfig.oauth2.proxyUrl
            string
          • spec.telegram.httpConfig.oauth2.scopes
            array of strings
          • spec.telegram.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.telegram.httpConfig.oauth2.tlsConfig.caFile
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.certFile
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
            • spec.telegram.httpConfig.oauth2.tlsConfig.keyFile
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.maxVersion
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.minVersion
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.serverName
              string
          • spec.telegram.httpConfig.oauth2.tokenUrl
            string

            Required value

        • spec.telegram.httpConfig.proxyConnectHeader
          object
          Header names mapped to header values for CONNECT requests to proxies.
        • spec.telegram.httpConfig.proxyFromEnvironment
          boolean
        • spec.telegram.httpConfig.proxyUrl
          string
        • spec.telegram.httpConfig.tlsConfig
          object
          TLS settings for the Telegram notifier HTTP client.
          • spec.telegram.httpConfig.tlsConfig.caFile
            string
          • spec.telegram.httpConfig.tlsConfig.certFile
            string
          • spec.telegram.httpConfig.tlsConfig.insecureSkipVerify
            boolean
          • spec.telegram.httpConfig.tlsConfig.keyFile
            string
          • spec.telegram.httpConfig.tlsConfig.maxVersion
            string
          • spec.telegram.httpConfig.tlsConfig.minVersion
            string
          • spec.telegram.httpConfig.tlsConfig.serverName
            string
      • spec.telegram.template
        string
        Telegram message template.
    • spec.type
      string

      Required value

      Notification channel type.

      Allowed values: Email, Slack, Telegram, Webhook, ExpressMessenger

    • spec.webhook
      object
      Webhook channel parameters.
      • spec.webhook.httpConfig
        object
        HTTP client options for the Alertmanager webhook receiver (http_config). basicAuth and authorization must not be used together. oauth2 cannot be used together with basicAuth or authorization.
        • spec.webhook.httpConfig.authorization
          object
          Static Authorization header; mutually exclusive with basicAuth.
          • spec.webhook.httpConfig.authorization.credentials
            string
          • spec.webhook.httpConfig.authorization.credentialsFile
            string
            Path to a credentials file available inside the alertmanager container.
          • spec.webhook.httpConfig.authorization.type
            string
            Authentication scheme (Alertmanager default is Bearer when unset).
        • spec.webhook.httpConfig.basicAuth
          object
          HTTP basic authentication for webhook requests.
          • spec.webhook.httpConfig.basicAuth.password
            string
          • spec.webhook.httpConfig.basicAuth.passwordFile
            string
            Path to a password file available inside the alertmanager container.
          • spec.webhook.httpConfig.basicAuth.username
            string
        • spec.webhook.httpConfig.enableHttp2
          boolean
        • spec.webhook.httpConfig.followRedirects
          boolean
        • spec.webhook.httpConfig.httpHeaders
          object
          Custom HTTP headers appended to webhook requests.
          • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
        • spec.webhook.httpConfig.noProxy
          string
        • spec.webhook.httpConfig.oauth2
          object
          OAuth2 client credentials; mutually exclusive with basicAuth and authorization.
          • spec.webhook.httpConfig.oauth2.clientId
            string

            Required value

          • spec.webhook.httpConfig.oauth2.clientSecret
            string
          • spec.webhook.httpConfig.oauth2.clientSecretFile
            string
          • spec.webhook.httpConfig.oauth2.endpointParams
            object
          • spec.webhook.httpConfig.oauth2.noProxy
            string
          • spec.webhook.httpConfig.oauth2.proxyFromEnvironment
            boolean
          • spec.webhook.httpConfig.oauth2.proxyUrl
            string
          • spec.webhook.httpConfig.oauth2.scopes
            array of strings
          • spec.webhook.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.webhook.httpConfig.oauth2.tlsConfig.caFile
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.certFile
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
            • spec.webhook.httpConfig.oauth2.tlsConfig.keyFile
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.maxVersion
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.minVersion
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.serverName
              string
          • spec.webhook.httpConfig.oauth2.tokenUrl
            string

            Required value

        • spec.webhook.httpConfig.proxyConnectHeader
          object
          Header names mapped to header values for CONNECT requests to proxies.
        • spec.webhook.httpConfig.proxyFromEnvironment
          boolean
        • spec.webhook.httpConfig.proxyUrl
          string
        • spec.webhook.httpConfig.tlsConfig
          object
          TLS settings for the webhook HTTP client.
          • spec.webhook.httpConfig.tlsConfig.caFile
            string
          • spec.webhook.httpConfig.tlsConfig.certFile
            string
          • spec.webhook.httpConfig.tlsConfig.insecureSkipVerify
            boolean
          • spec.webhook.httpConfig.tlsConfig.keyFile
            string
          • spec.webhook.httpConfig.tlsConfig.maxVersion
            string
          • spec.webhook.httpConfig.tlsConfig.minVersion
            string
          • spec.webhook.httpConfig.tlsConfig.serverName
            string
      • spec.webhook.url
        string

        Required value

        Webhook URL.

        Minimal length: 1

  • status
    object
    Status information about the notification channel, including which policies are using it.
    • status.policies
      array of objects
      List of notification policies that are using this channel across all namespaces.
      • status.policies.name
        string
        Name of the notification policy using this channel.
      • status.policies.namespace
        string
        Namespace of the notification policy. Empty string for cluster-scoped policies.

ClusterObservabilityPropagatedNotificationPolicy

Scope: Cluster
Version: v1alpha1

A cluster-scoped resource that defines how propagated alerts are routed to notification channels: which alerts are selected (by labels), to which channel they are sent, and how often the notification is repeated. Propagated policies are delivered by Deckhouse platform developers, work only with propagated channels and handle alerts from propagated rules. Resources with heritage=deckhouse can only be managed by the Deckhouse ServiceAccount.
  • spec
    object
    • spec.alert
      object

      Required value

      Alert matching parameters: determine which alerts this notification policy applies to.
      • spec.alert.groupByLabels
        array of strings
        List of labels used to group alerts into a single notification: alerts that share the same values of the listed labels are merged and sent to the channel as one message.
        • spec.alert.groupByLabels.Element of the array
          string
          Label name.
      • spec.alert.selector
        object

        Required value

        Alert selector by labels: defines which alerts are matched. Either matchLabels or matchExpressions must be set.
        • spec.alert.selector.matchExpressions
          array of objects
          Match expressions.
          • spec.alert.selector.matchExpressions.key
            string
            Name of the alert label to evaluate against the matching condition.
          • 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 - only ClusterObservabilityPropagatedNotificationChannel is allowed.
        • spec.notification.channel.kind
          string

          Required value

          Channel object kind. Must be ClusterObservabilityPropagatedNotificationChannel.

          Default: ClusterObservabilityPropagatedNotificationChannel

          Allowed values: ClusterObservabilityPropagatedNotificationChannel

        • spec.notification.channel.name
          string

          Required value

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

          Required value

          Notification channel parameters.
      • spec.notification.repeatInterval
        string

        Required value

        Notification repeat interval.

        Default: 1m

  • status
    object
    • status.description
      string
    • status.state
      string

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.

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_:]*$

  • status
    object
    ObservabilityMetricsRulesGroupStatus defines the observed state of the rules group
    • status.conditions
      array of objects
      Conditions represent the latest available observations of the rules group state
      • status.conditions.lastTransitionTime
        string
        Last time the condition transitioned from one status to another
      • status.conditions.message
        string
        Human-readable message indicating details about last transition
      • status.conditions.reason
        string
        Unique, one-word, CamelCase reason for the condition’s last transition
      • status.conditions.status
        string
        Current value of the condition: True — satisfied, False — not satisfied, Unknown — could not be determined.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        Type of the rules group condition: Created — resource is created, Failed — sync failed, Ready — rules group is applied and active.

        Allowed values: Created, Failed, Ready

    • status.lastSyncTime
      string
      Last time the rules group was successfully synced
    • status.prometheusRuleName
      string
      Name of the PrometheusRule resource created for this rules group

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.expressMessenger
      object
      eXpress messenger channel parameters.
      • spec.expressMessenger.apiUrl
        string

        Required value

        eXpress CTS server URL.
      • spec.expressMessenger.botId
        string

        Required value

        eXpress bot ID (UUID).

        Pattern: ^[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
        string

        Required value

        eXpress bot secret key for JWT signing.
      • spec.expressMessenger.template
        string
        eXpress message 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.httpConfig
        object
        HTTP client options for the Alertmanager telegram receiver (http_config). Use proxyUrl or proxyFromEnvironment when the Telegram API is only reachable via a proxy. basicAuth and authorization must not be used together. oauth2 cannot be used together with basicAuth or authorization.
        • spec.telegram.httpConfig.authorization
          object
          Static Authorization header; mutually exclusive with basicAuth.
          • spec.telegram.httpConfig.authorization.credentials
            string
          • spec.telegram.httpConfig.authorization.credentialsFile
            string
            Path to a credentials file available inside the alertmanager container.
          • spec.telegram.httpConfig.authorization.type
            string
            Authentication scheme (Alertmanager default is Bearer when unset).
        • spec.telegram.httpConfig.basicAuth
          object
          HTTP basic authentication for outbound Telegram API requests.
          • spec.telegram.httpConfig.basicAuth.password
            string
          • spec.telegram.httpConfig.basicAuth.passwordFile
            string
            Path to a password file available inside the alertmanager container.
          • spec.telegram.httpConfig.basicAuth.username
            string
        • spec.telegram.httpConfig.enableHttp2
          boolean
        • spec.telegram.httpConfig.followRedirects
          boolean
        • spec.telegram.httpConfig.httpHeaders
          object
          Custom HTTP headers for Telegram API requests.
          • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
            • spec.telegram.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
        • spec.telegram.httpConfig.noProxy
          string
        • spec.telegram.httpConfig.oauth2
          object
          OAuth2 client credentials; mutually exclusive with basicAuth and authorization.
          • spec.telegram.httpConfig.oauth2.clientId
            string

            Required value

          • spec.telegram.httpConfig.oauth2.clientSecret
            string
          • spec.telegram.httpConfig.oauth2.clientSecretFile
            string
          • spec.telegram.httpConfig.oauth2.endpointParams
            object
          • spec.telegram.httpConfig.oauth2.noProxy
            string
          • spec.telegram.httpConfig.oauth2.proxyFromEnvironment
            boolean
          • spec.telegram.httpConfig.oauth2.proxyUrl
            string
          • spec.telegram.httpConfig.oauth2.scopes
            array of strings
          • spec.telegram.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.telegram.httpConfig.oauth2.tlsConfig.caFile
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.certFile
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
            • spec.telegram.httpConfig.oauth2.tlsConfig.keyFile
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.maxVersion
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.minVersion
              string
            • spec.telegram.httpConfig.oauth2.tlsConfig.serverName
              string
          • spec.telegram.httpConfig.oauth2.tokenUrl
            string

            Required value

        • spec.telegram.httpConfig.proxyConnectHeader
          object
          Header names mapped to header values for CONNECT requests to proxies.
        • spec.telegram.httpConfig.proxyFromEnvironment
          boolean
        • spec.telegram.httpConfig.proxyUrl
          string
        • spec.telegram.httpConfig.tlsConfig
          object
          TLS settings for the Telegram notifier HTTP client.
          • spec.telegram.httpConfig.tlsConfig.caFile
            string
          • spec.telegram.httpConfig.tlsConfig.certFile
            string
          • spec.telegram.httpConfig.tlsConfig.insecureSkipVerify
            boolean
          • spec.telegram.httpConfig.tlsConfig.keyFile
            string
          • spec.telegram.httpConfig.tlsConfig.maxVersion
            string
          • spec.telegram.httpConfig.tlsConfig.minVersion
            string
          • spec.telegram.httpConfig.tlsConfig.serverName
            string
      • spec.telegram.template
        string
        Telegram message template.
    • spec.type
      string

      Required value

      Notification channel type.

      Allowed values: Email, Slack, Telegram, Webhook, ExpressMessenger

    • spec.webhook
      object
      Webhook channel parameters.
      • spec.webhook.httpConfig
        object
        HTTP client options for the Alertmanager webhook receiver (http_config). basicAuth and authorization must not be used together. oauth2 cannot be used together with basicAuth or authorization.
        • spec.webhook.httpConfig.authorization
          object
          Static Authorization header; mutually exclusive with basicAuth.
          • spec.webhook.httpConfig.authorization.credentials
            string
          • spec.webhook.httpConfig.authorization.credentialsFile
            string
            Path to a credentials file available inside the alertmanager container.
          • spec.webhook.httpConfig.authorization.type
            string
            Authentication scheme (Alertmanager default is Bearer when unset).
        • spec.webhook.httpConfig.basicAuth
          object
          HTTP basic authentication for webhook requests.
          • spec.webhook.httpConfig.basicAuth.password
            string
          • spec.webhook.httpConfig.basicAuth.passwordFile
            string
            Path to a password file available inside the alertmanager container.
          • spec.webhook.httpConfig.basicAuth.username
            string
        • spec.webhook.httpConfig.enableHttp2
          boolean
        • spec.webhook.httpConfig.followRedirects
          boolean
        • spec.webhook.httpConfig.httpHeaders
          object
          Custom HTTP headers appended to webhook requests.
          • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>
            object
            <KEY_NAME> — item (key) name.
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.files
              array of strings
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.secrets
              array of strings
            • spec.webhook.httpConfig.httpHeaders.<KEY_NAME>.values
              array of strings
        • spec.webhook.httpConfig.noProxy
          string
        • spec.webhook.httpConfig.oauth2
          object
          OAuth2 client credentials; mutually exclusive with basicAuth and authorization.
          • spec.webhook.httpConfig.oauth2.clientId
            string

            Required value

          • spec.webhook.httpConfig.oauth2.clientSecret
            string
          • spec.webhook.httpConfig.oauth2.clientSecretFile
            string
          • spec.webhook.httpConfig.oauth2.endpointParams
            object
          • spec.webhook.httpConfig.oauth2.noProxy
            string
          • spec.webhook.httpConfig.oauth2.proxyFromEnvironment
            boolean
          • spec.webhook.httpConfig.oauth2.proxyUrl
            string
          • spec.webhook.httpConfig.oauth2.scopes
            array of strings
          • spec.webhook.httpConfig.oauth2.tlsConfig
            object
            TLS settings for the token request.
            • spec.webhook.httpConfig.oauth2.tlsConfig.caFile
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.certFile
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.insecureSkipVerify
              boolean
            • spec.webhook.httpConfig.oauth2.tlsConfig.keyFile
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.maxVersion
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.minVersion
              string
            • spec.webhook.httpConfig.oauth2.tlsConfig.serverName
              string
          • spec.webhook.httpConfig.oauth2.tokenUrl
            string

            Required value

        • spec.webhook.httpConfig.proxyConnectHeader
          object
          Header names mapped to header values for CONNECT requests to proxies.
        • spec.webhook.httpConfig.proxyFromEnvironment
          boolean
        • spec.webhook.httpConfig.proxyUrl
          string
        • spec.webhook.httpConfig.tlsConfig
          object
          TLS settings for the webhook HTTP client.
          • spec.webhook.httpConfig.tlsConfig.caFile
            string
          • spec.webhook.httpConfig.tlsConfig.certFile
            string
          • spec.webhook.httpConfig.tlsConfig.insecureSkipVerify
            boolean
          • spec.webhook.httpConfig.tlsConfig.keyFile
            string
          • spec.webhook.httpConfig.tlsConfig.maxVersion
            string
          • spec.webhook.httpConfig.tlsConfig.minVersion
            string
          • spec.webhook.httpConfig.tlsConfig.serverName
            string
      • spec.webhook.url
        string

        Required value

        Webhook URL.

        Minimal length: 1

  • status
    object
    Status information about the notification channel, including which policies are using it.
    • status.policies
      array of strings
      List of notification policies that are using this channel.
      • status.policies.Element of the array
        string
        Name of the notification policy using this channel.

ObservabilityNotificationPolicy

Scope: Namespaced
Version: v1alpha1

A namespace-scoped resource that defines how alerts are routed to notification channels: which alerts are selected (by labels), to which channel they are sent, and how often the notification is repeated.
  • spec
    object
    • spec.alert
      object

      Required value

      Alert matching parameters: determine which alerts this notification policy applies to.
      • spec.alert.groupByLabels
        array of strings
        List of labels used to group alerts into a single notification: alerts that share the same values of the listed labels are merged and sent to the channel as one message.
        • spec.alert.groupByLabels.Element of the array
          string
          Label name.
      • spec.alert.selector
        object

        Required value

        Alert selector by labels: defines which alerts are matched. Either matchLabels or matchExpressions must be set.
        • spec.alert.selector.matchExpressions
          array of objects
          Match expressions.
          • spec.alert.selector.matchExpressions.key
            string
            Name of the alert label to evaluate against the matching condition.
          • 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

  • status
    object
    • status.description
      string
    • status.state
      string

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 by labels: defines which alerts are matched by this silence. Either matchLabels or matchExpressions must be set.
      • spec.selector.matchExpressions
        array of objects
        Match expressions.
        • spec.selector.matchExpressions.key
          string
          Name of the alert label to evaluate againstthe matching condition.
        • 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 set for selecting alerts. Notifications for alerts whose labels match all of the specified ones are suppressed for the duration of the silence.
    • spec.startsAt
      string

      Required value

      Notification silence start time.