Configuration

Requirements

To the Deckhouse version: 1.71 and above.

To the versions of other modules:

• console: 1.41.1 and above.
• operator-prometheus: any version.
• prometheus: any version.

Parameters

Schema version: 1

• settings

  object
  • settings.deadMansSwitch

    object

    Settings for the DeadMansSwitch alerting.

    Default: {}

    • settings.deadMansSwitch.enabled

      boolean

      Whether to enable DeadMansSwitch alert handling.

      When enabled (default), a DeadMansSwitch heartbeat alert is expected from Prometheus and a PrometheusUnavailable alert is generated if the heartbeat is missing. When disabled, neither DeadMansSwitch nor PrometheusUnavailable alerts are created.

      Default: true

  • settings.dop

    object

    Settings for integration with DOP (Deckhouse Observability Platform).

    Default: {}

    • settings.dop.destinations

      array of objects

      List of DOP destinations for metrics delivery. At least one destination is required.

      Example:

      
      

      destinations:
      - host: dop.flant.com
        token: your-api-token-here
      

      • settings.dop.destinations.host

        string

        DOP platform host address (must be a valid FQDN, e.g., dop.flant.com).

        Length: 1..253

        Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$

      • settings.dop.destinations.token

        string

        API token for the DOP platform (UUID format).

        Pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

    • settings.dop.hostMetrics

      boolean

      Whether to enable nodes metrics collection with okagent.

      Default: true

    • settings.dop.nodeAffinity

      object

      Node affinity configuration for the okagent.

      Allows constraining which nodes the pod can be scheduled on.

      Default: {}

      • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

        object

        If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node.
        • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

          array of objects

          A list of node selector terms. The terms are ORed.
          • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

            array of objects

            A list of node selector requirements by node’s labels. The requirements are ANDed.
            • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.key

              string

              The label key that the selector applies to.
            • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.operator

              string

              Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist, Gt, and Lt.

              Allowed values: In, NotIn, Exists, DoesNotExist, Gt, Lt

            • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.values

              array of strings

              An array of string values for the operator to evaluate. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer.
          • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

            array of objects

            A list of node selector requirements by node’s fields. The requirements are ANDed.
            • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.key

              string

              The node field key that the selector applies to.
            • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.operator

              string

              Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist, Gt, and Lt.

              Allowed values: In, NotIn, Exists, DoesNotExist, Gt, Lt

            • settings.dop.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.values

              array of strings

              An array of string values for the operator to evaluate.
  • settings.externalMetricsAccess

    object

    Settings for external access to metrics.

    Default: {}

    • settings.externalMetricsAccess.enabled

      boolean

      Whether to enable metrics external read access.

      If enabled, the observability module will expose the metrics via ingress for reading. Metrics can be read using the Prometheus-compatible API. Providing a valid ServiceAccount token via the Authorization: Bearer header is mandatory. See the documentation for more details.

      Default: false

    • settings.externalMetricsAccess.whitelistSourceRanges

      array of strings

      An array if CIDRs that are allowed to read metrics. If not specified, no restrictions are applied.

      Default: []

      Example:

      
      

      whitelistSourceRanges:
      - 1.1.1.1/32
      

  • settings.grafana

    object

    Grafana related settings.

    Default: {}

    • settings.grafana.customPlugins

      array of strings

      A list of custom Grafana plugins. Contains plugin names from the official repository.

      Here is how you can add custom plugins (in this case, clickhouse-datasource and flowcharting-panel plugins are used):

      grafana:
        customPlugins:
        - agenty-flowcharting-panel
        - vertamedia-clickhouse-datasource

      You can also install plugins from other sources by passing a link to the plugin zip archive in the format <url to plugin zip>;<plugin name>:

      grafana:
        customPlugins:
        - http://10.241.32.16:3000/netsage-bumpchart-panel-1.1.1.zip;netsage-bumpchart-panel

      Example:

      
      

      customPlugins:
      - agenty-flowcharting-panel
      - vertamedia-clickhouse-datasource
      

  • settings.https

    object

    What certificate type to use with observability module.

    This parameter completely overrides the global.modules.https settings.

    Examples:

    
    

    customCertificate:
      secretName: foobar
    mode: CustomCertificate
    

    certManager:
      clusterIssuerName: letsencrypt
    mode: CertManager
    

    • settings.https.certManager

      object
      • settings.https.certManager.clusterIssuerName

        string

        What ClusterIssuer to use for the observability module.

        Currently, letsencrypt, letsencrypt-staging, selfsigned are available. Also, you can define your own.

        Default: letsencrypt

    • settings.https.customCertificate

      object

      Default: {}

      • settings.https.customCertificate.secretName

        string

        The name of the secret in the d8-system namespace to use with the observability module.

        This secret must have the kubernetes.io/tls format.

        Default: false

    • settings.https.mode

      string

      The HTTPS usage mode:

      • Disabled — the observability module will work over HTTP only;
      • CertManager — the observability module will use HTTPS and get a certificate from the clusterissuer defined in the certManager.clusterIssuerName parameter.
      • CustomCertificate — the observability module will use HTTPS using the certificate from the d8-system namespace.
      • OnlyInURI — the observability module will work over HTTP (thinking that there is an external HTTPS load balancer in front that terminates HTTPS traffic). All the links in the user-authn will be generated using the HTTPS scheme. Load balancer should provide a redirect from HTTP to HTTPS.

      Default: Disabled

      Allowed values: Disabled, CertManager, CustomCertificate, OnlyInURI

  • settings.ingressClass

    string

    The ingress class to use for all ingress resources created by the observability module.

    This parameter completely overrides the global.modules.ingressClass settings. If not specified, the global ingress class configuration will be used.

    The value must be a valid Kubernetes resource name (lowercase alphanumeric characters or hyphens, must start and end with alphanumeric character).

    Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

    Examples:

    
    

    ingressClass: nginx
    

    ingressClass: nginx-external