Available in:  Open/CE, Core, BE, SE, SE+, Ultimate/EE

The module lifecycle stage: Generally available version

The module has requirements for installation

How to explicitly enable or disable the module…

You may explicitly enable or disable the module in one of the following ways:

  • Via Deckhouse web UI. In the “System” → “System Management” → “Deckhouse” → “Modules” section, open the observability module and enable (or disable) the “Module enabled” toggle. Save changes.

    Example:

    Module enable/disable interface
  • Via Deckhouse CLI (d8).

    Use the d8 system module enable command for enabling, or d8 system module disable command for disabling the module (you need Deckhouse CLI (d8), configured to work with the cluster).

    Example of enabling the module:

    d8 system module enable observability
  • Using ModuleConfig observability.

    Set spec.enabled to true or false in ModuleConfig observability (create it if necessary).

    Example of a manifest to enable module observability:

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: observability
    spec:
      enabled: true

How to configure the module…

You can configure the module in one of the following ways:

  • Via Deckhouse web UI.

    In the “System” → “System Management” → “Deckhouse” → “Modules” section, open the observability module and enable the “Advanced Settings” toggle. Fill in the required fields in the “Configuration” tab or specify the module settings in YAML format on the “YAML” tab, without the top-level settings key. Save the changes.

    Example:

    Module settings interface

    You can also edit the ModuleConfig object observability on the “YAML” tab in the module settings window (“System” → “System Management” → “Deckhouse” → “Modules”, open the module observability) by specifying the schema version in the spec.version parameter and the necessary module parameters in the spec.settings section.

  • Via Deckhouse CLI (d8) (requires Deckhouse CLI (d8) configured to work with the cluster).

    Edit the existing ModuleConfig observability (for more details on configuring Deckhouse Platform, see the documentation) by executing the following command:

    d8 k edit mc observability

    Make the necessary changes in the spec.settings section. If necessary, specify the schema version in the spec.version parameter. Save the changes.

    You can also create a manifest file for ModuleConfig observability using the example below. Fill in the spec.settings section with the required module parameters. If necessary, specify the schema version in the spec.version parameter.

    Apply the manifest using the following command (indicate the manifest file name):

    d8 k apply -f <FILENAME>

    Example of a manifest for ModuleConfig observability:

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: observability
    spec:
      version: 2
      enabled: true
      settings: # Module parameters from the "Parameters" section below.

How to change the module release channel…

To change the module release channel, follow the steps in How do I change the release channel for a module?.

Requirements

To the Deckhouse Platform version: 1.74 and above.

To the versions of other modules:

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

Conversions

The module is configured using the ModuleConfig resource, the schema of which contains a version number. When you apply an old version of the ModuleConfig schema in a cluster, automatic transformations are performed. To manually update the ModuleConfig schema version, the following steps must be completed sequentially for each version:

  • Updates from version 1 to 2:

    Delete the .dop.nodeAffinity field: the agent collects node metrics instead of node-exporter and runs on every node of the cluster, restricting the set of nodes is no longer supported.

Parameters

Schema version: 2

  • settings
    object
    • settings.alertDiagnostics
      object

      Experimental. Settings of the diagnostics of firing alerts.

      When enabled, the controller alert-diagnostics-controller finds the Kubernetes object of every firing alert, collects facts about it, evaluates the findings of diagnostic playbooks and writes the result into an ObservabilityDiagnosticReport (alerts of a namespace) or a ClusterObservabilityDiagnosticReport (cluster alerts). The built-in playbooks of the module are installed together with the controller.

      Default: {}

      • settings.alertDiagnostics.enabled
        boolean

        Experimental. Whether to enable the diagnostics of firing alerts.

        When the parameter is turned off, the module deletes all diagnostic reports; playbooks created by users stay.

        Default: false

      • settings.alertDiagnostics.linkedTargets
        object
        Objects a report follows from the object of the alert: the backend of an Ingress and the dependencies the logs of the containers connect to.

        Default: {}

        • settings.alertDiagnostics.linkedTargets.maxDepth
          integer

          Maximum number of objects in a row a report follows from the object of the alert. 0 turns the traversal off.

          A playbook can only lower it with execution.maxLinkedDepth. A report follows at most 20 objects in total.

          Default: 5

          Allowed values: 0 <= X <= 5

      • settings.alertDiagnostics.logs
        object
        Limits of container logs in reports.

        Default: {}

        • settings.alertDiagnostics.logs.maxBytesPerCheck
          integer
          Maximum number of bytes of one log stream stored in a report.

          Default: 32768

          Allowed values: 1024 <= X <= 262144

      • settings.alertDiagnostics.nodeAgent
        object

        Settings of the node agent alert-diagnostics-node-agent.

        The agent runs on every node and, on request of the controller only, reads on the node: the journal and the state of the systemd units (kubelet, containerd, containerd-deckhouse, bashible, cloud-init) and the kernel log; the disk usage of its file systems and of the writable layers of containers; the listening sockets of pods; the counters of connection tracking; the clock; the audit log of kube-apiserver on control-plane nodes. It mounts the root file system of the node read-only, listens on port 4294/TCP of the node address with mutual TLS and changes nothing on the node.

        Default: {}

        • settings.alertDiagnostics.nodeAgent.enabled
          boolean

          Whether to run the node agent while the diagnostics is enabled.

          When disabled, the agent is not deployed, and the checks of the reports that read a node end with the outcome Skipped.

          Default: true

      • settings.alertDiagnostics.podExec
        object
        Settings of the PodExec checks that run fixed commands of playbooks in containers.

        Default: {}

        • settings.alertDiagnostics.podExec.enabled
          boolean

          Whether to allow PodExec checks.

          When enabled, the controller gets the right to run commands in the containers of every namespace of the cluster (pods/exec), including the namespaces of the platform; it runs only the fixed commands of the playbooks. Turn it off where this right is not acceptable.

          When disabled, the controller has no right to run commands in containers (pods/exec) and the checks end with the outcome Skipped.

          Default: true

      • settings.alertDiagnostics.rerun
        object
        Settings of manual runs of the diagnostics.

        Default: {}

        • settings.alertDiagnostics.rerun.minInterval
          string
          Minimum interval between the start of a run and the next manual run of the same alert.

          Default: 5m

          Pattern: ^([0-9]+(ns|us|ms|s|m|h))+$

          Example:

          minInterval: 5m
          
      • settings.alertDiagnostics.retention
        object
        Retention of diagnostic reports.

        Default: {}

        • settings.alertDiagnostics.retention.lostTTL
          string

          How long the report of an alert whose object disappeared without resolving stays available before it is deleted.

          Hours and minutes, at least one minute: 15m, 24h, 1h30m.

          Default: 15m

          Pattern: ^([1-9][0-9]*h([0-9]+m)?|([0-9]+h)?[1-9][0-9]*m)$

          Examples:

          lostTTL: 15m
          
          lostTTL: 24h
          
        • settings.alertDiagnostics.retention.maxReports
          integer

          Maximum number of reports in the cluster, ObservabilityDiagnosticReport and ClusterObservabilityDiagnosticReport counted together.

          When the limit is reached, creating a report first deletes a report of a finished alert: failed reports without facts first, then reports of alerts that disappeared, then reports of resolved alerts, the oldest first. Reports of firing alerts are never deleted. When every report belongs to a firing alert, the automatic creation waits, and a report created by a user is accepted while the total stays below the limit plus 50.

          Reports without diagnostics (the reason NoDiagnostics: no playbook matches the alert and its labels name no object) are not counted and are not deleted to make room; they are deleted by resolvedTTL and lostTTL.

          Default: 300

          Allowed values: 10 <= X <= 3000

        • settings.alertDiagnostics.retention.resolvedTTL
          string

          How long the report of a resolved alert stays available before it is deleted.

          Hours and minutes, at least one minute: 15m, 24h, 1h30m.

          Default: 15m

          Pattern: ^([1-9][0-9]*h([0-9]+m)?|([0-9]+h)?[1-9][0-9]*m)$

          Examples:

          resolvedTTL: 15m
          
          resolvedTTL: 24h
          
    • 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.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. For details, refer to “External access to metrics”.

        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.externalMetricsAccess.whitelistSourceRanges.Element of the array
          string

          Pattern: ^(((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(/([0-9]|[12][0-9]|3[0-2]))?|([0-9A-Fa-f]{0,4}:){2,7}[0-9A-Fa-f]{0,4}(/([0-9]|[1-9][0-9]|1[01][0-9]|12[0-8]))?)$

    • 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.highAvailability
      boolean

      Manually enable the high availability mode.

      By default, the mode is taken from the global highAvailability parameter; if it is not set, the mode is enabled when the cluster control plane is highly available.

      alert-kube-api and observability-webhook always run in two replicas regardless of this parameter.

      Examples:

      highAvailability: true
      
      highAvailability: false
      
    • 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
      
    • settings.lightweightLogs
      object
      Settings for lightweight logs collection directly from kubelet.

      Default: { "enabled": true }

      • settings.lightweightLogs.enabled
        boolean
        Whether to enable lightweight logs collection from kubelet.

        Default: true

    • settings.loki
      object
      Settings for the built-in Loki log storage.

      Default: {}

      • settings.loki.allowDeleteLogs
        boolean
        Allow logs deletion using /loki/api/v1/delete endpoints.

        Default: false

      • settings.loki.distributed
        object
        Settings for the Distributed mode (Loki Simple Scalable). Requires storage.type: S3.

        Default: {}

        • settings.loki.distributed.backend
          object
          Settings for the backend target, which runs the compactor, index gateway, query scheduler and ruler.

          Default: {}

          • settings.loki.distributed.backend.replicas
            integer
            Number of backend replicas.

            Default: 2

            Allowed values: 2 <= X

          • settings.loki.distributed.backend.resourcesManagement
            Settings for CPU and memory requests and limits of the backend pods.

            Default: {}

            • settings.loki.distributed.backend.resourcesManagement.mode
              string

              Resource management mode:

              • Static is a classic one. In it, you specify requests/limits.
              • VPA mode uses VPA.

              Default: VPA

              Allowed values: VPA, Static

            • settings.loki.distributed.backend.resourcesManagement.static
              object
              • settings.loki.distributed.backend.resourcesManagement.static.limits
                object
                • settings.loki.distributed.backend.resourcesManagement.static.limits.cpu
                • settings.loki.distributed.backend.resourcesManagement.static.limits.memory
              • settings.loki.distributed.backend.resourcesManagement.static.requests
                object
                • settings.loki.distributed.backend.resourcesManagement.static.requests.cpu
                • settings.loki.distributed.backend.resourcesManagement.static.requests.memory
            • settings.loki.distributed.backend.resourcesManagement.vpa
              object
              Resource management options for the VPA mode.

              Default: {}

              • settings.loki.distributed.backend.resourcesManagement.vpa.cpu
                object

                Default: {}

                • settings.loki.distributed.backend.resourcesManagement.vpa.cpu.limitRatio
                  number
                • settings.loki.distributed.backend.resourcesManagement.vpa.cpu.max

                  Default: 2

                • settings.loki.distributed.backend.resourcesManagement.vpa.cpu.min

                  Default: 50m

              • settings.loki.distributed.backend.resourcesManagement.vpa.memory
                object

                Default: {}

                • settings.loki.distributed.backend.resourcesManagement.vpa.memory.limitRatio
                  number
                • settings.loki.distributed.backend.resourcesManagement.vpa.memory.max

                  Default: 2Gi

                • settings.loki.distributed.backend.resourcesManagement.vpa.memory.min

                  Default: 256Mi

              • settings.loki.distributed.backend.resourcesManagement.vpa.mode
                string

                Default: InPlaceOrRecreate

                Allowed values: Initial, InPlaceOrRecreate, Auto

        • settings.loki.distributed.read
          object
          Settings for the read target, which serves queries.

          Default: {}

          • settings.loki.distributed.read.replicas
            integer
            Number of read replicas.

            Default: 3

            Allowed values: 1 <= X

          • settings.loki.distributed.read.resourcesManagement
            Settings for CPU and memory requests and limits of the read pods.

            Default: {}

            • settings.loki.distributed.read.resourcesManagement.mode
              string

              Resource management mode:

              • Static is a classic one. In it, you specify requests/limits.
              • VPA mode uses VPA.

              Default: VPA

              Allowed values: VPA, Static

            • settings.loki.distributed.read.resourcesManagement.static
              object
              • settings.loki.distributed.read.resourcesManagement.static.limits
                object
                • settings.loki.distributed.read.resourcesManagement.static.limits.cpu
                • settings.loki.distributed.read.resourcesManagement.static.limits.memory
              • settings.loki.distributed.read.resourcesManagement.static.requests
                object
                • settings.loki.distributed.read.resourcesManagement.static.requests.cpu
                • settings.loki.distributed.read.resourcesManagement.static.requests.memory
            • settings.loki.distributed.read.resourcesManagement.vpa
              object
              Resource management options for the VPA mode.

              Default: {}

              • settings.loki.distributed.read.resourcesManagement.vpa.cpu
                object

                Default: {}

                • settings.loki.distributed.read.resourcesManagement.vpa.cpu.limitRatio
                  number
                • settings.loki.distributed.read.resourcesManagement.vpa.cpu.max

                  Default: 2

                • settings.loki.distributed.read.resourcesManagement.vpa.cpu.min

                  Default: 50m

              • settings.loki.distributed.read.resourcesManagement.vpa.memory
                object

                Default: {}

                • settings.loki.distributed.read.resourcesManagement.vpa.memory.limitRatio
                  number
                • settings.loki.distributed.read.resourcesManagement.vpa.memory.max

                  Default: 2Gi

                • settings.loki.distributed.read.resourcesManagement.vpa.memory.min

                  Default: 256Mi

              • settings.loki.distributed.read.resourcesManagement.vpa.mode
                string

                Default: InPlaceOrRecreate

                Allowed values: Initial, InPlaceOrRecreate, Auto

        • settings.loki.distributed.write
          object
          Settings for the write target, which accepts pushes and flushes chunks to the store.

          Default: {}

          • settings.loki.distributed.write.replicas
            integer

            Number of write replicas.

            Cannot be lower than 3: the ring is configured with a replication factor of 3.

            Default: 3

            Allowed values: 3 <= X

          • settings.loki.distributed.write.resourcesManagement
            Settings for CPU and memory requests and limits of the write pods.

            Default: {}

            • settings.loki.distributed.write.resourcesManagement.mode
              string

              Resource management mode:

              • Static is a classic one. In it, you specify requests/limits.
              • VPA mode uses VPA.

              Default: VPA

              Allowed values: VPA, Static

            • settings.loki.distributed.write.resourcesManagement.static
              object
              • settings.loki.distributed.write.resourcesManagement.static.limits
                object
                • settings.loki.distributed.write.resourcesManagement.static.limits.cpu
                • settings.loki.distributed.write.resourcesManagement.static.limits.memory
              • settings.loki.distributed.write.resourcesManagement.static.requests
                object
                • settings.loki.distributed.write.resourcesManagement.static.requests.cpu
                • settings.loki.distributed.write.resourcesManagement.static.requests.memory
            • settings.loki.distributed.write.resourcesManagement.vpa
              object
              Resource management options for the VPA mode.

              Default: {}

              • settings.loki.distributed.write.resourcesManagement.vpa.cpu
                object

                Default: {}

                • settings.loki.distributed.write.resourcesManagement.vpa.cpu.limitRatio
                  number
                • settings.loki.distributed.write.resourcesManagement.vpa.cpu.max

                  Default: 2

                • settings.loki.distributed.write.resourcesManagement.vpa.cpu.min

                  Default: 50m

              • settings.loki.distributed.write.resourcesManagement.vpa.memory
                object

                Default: {}

                • settings.loki.distributed.write.resourcesManagement.vpa.memory.limitRatio
                  number
                • settings.loki.distributed.write.resourcesManagement.vpa.memory.max

                  Default: 2Gi

                • settings.loki.distributed.write.resourcesManagement.vpa.memory.min

                  Default: 256Mi

              • settings.loki.distributed.write.resourcesManagement.vpa.mode
                string

                Default: InPlaceOrRecreate

                Allowed values: Initial, InPlaceOrRecreate, Auto

      • settings.loki.enabled
        boolean
        Whether to enable the built-in Loki log storage.

        Default: false

      • settings.loki.lokiConfig
        object

        Loki configuration options available for tuning.

        See Loki documentation for more information.

        Caution! Incorrect settings may lead to the malfunction of Loki.

        Default: {}

        • settings.loki.lokiConfig.grpcServerMaxConcurrentStreams
          integer
          Limit on the number of concurrent streams for gRPC calls.

          Default: 100

        • settings.loki.lokiConfig.grpcServerMaxRecvMsgSize
          integer
          Limit on the size of a gRPC message this server can receive in bytes.

          Default: 104857600

        • settings.loki.lokiConfig.grpcServerMaxSendMsgSize
          integer
          Limit on the size of a gRPC message this server can send in bytes.

          Default: 4194304

        • settings.loki.lokiConfig.ingestionBurstSizeMB
          number
          Overall ingestion burst size in megabytes. E.g., maximum push request size.

          Default: 6

        • settings.loki.lokiConfig.ingestionRateMB
          number
          Overall ingestion rate limit in megabytes per second.

          Default: 4

        • settings.loki.lokiConfig.maxChunksPerQuery
          integer
          The maximum number of chunks that can be fetched per query.

          Default: 2000000

        • settings.loki.lokiConfig.maxEntriesLimitPerQuery
          integer
          The maximum number of entries returned for the query.

          Default: 5000

        • settings.loki.lokiConfig.maxLabelNamesPerSeries
          integer
          The maximum number of unique label names per series (log stream).

          Default: 32

        • settings.loki.lokiConfig.maxStreamsPerUser
          integer

          The maximum total number of streams for the Loki instance.

          Each stream has unique labels. The number of streams is the number of unique label sets.

          0 means unlimited.

          Default: 0

        • settings.loki.lokiConfig.perStreamRateLimit
          Maximum byte rate per second per stream. Can be either a number or a string with a unit (KB, MB, GB).

          Default: 3MB

        • settings.loki.lokiConfig.perStreamRateLimitBurst
          Maximum burst size per stream. Can be either a number or a string with a unit (KB, MB, GB).

          Default: 15MB

      • settings.loki.mode
        string

        Deployment mode.

        • Single — a single monolithic Loki instance. Configured via the single parameters.
        • Distributed — Loki in the Simple Scalable topology, with separate write, read and backend targets. Requires storage.type: S3 and is configured via the distributed parameters.

        Warning. Switching the mode does not migrate the data: the new instance starts empty. A disk left over from the previous mode is not deleted automatically.

        Default: Single

        Allowed values: Single, Distributed

      • settings.loki.nodeSelector
        object

        The same as the Pods’ spec.nodeSelector parameter in Kubernetes. Applies to every Loki Pod: loki in Single mode, write, read and backend in Distributed mode.

        If the parameter is omitted or empty, nodeSelector will be determined automatically.

        Example:

        node-role.deckhouse.io/loki: ''
        
      • settings.loki.retentionPeriodHours
        integer

        The desired minimum log retention period in hours.

        With storage.type: Disk this parameter does not cap the retention depth: old data is only deleted once the disk fills up. If Loki deletes data that has not yet reached the specified retention period, you will receive a LokiInsufficientDiskForRetention alert. In this case, you should either increase the disk size or decrease the value of this parameter.

        With storage.type: S3 (in either mode) the compactor enforces this period directly, and data older than it is deleted regardless of how much space is left.

        Default: 168

      • settings.loki.single
        object
        Settings for the Single mode.

        Default: {}

        • settings.loki.single.resourcesManagement
          Settings for CPU and memory requests and limits of the Loki pod.

          Default: {}

          • settings.loki.single.resourcesManagement.mode
            string

            Resource management mode:

            • Static is a classic one. In it, you specify requests/limits.
            • VPA mode uses VPA.

            Default: VPA

            Allowed values: VPA, Static

          • settings.loki.single.resourcesManagement.static
            object
            • settings.loki.single.resourcesManagement.static.limits
              object
              • settings.loki.single.resourcesManagement.static.limits.cpu
              • settings.loki.single.resourcesManagement.static.limits.memory
            • settings.loki.single.resourcesManagement.static.requests
              object
              • settings.loki.single.resourcesManagement.static.requests.cpu
              • settings.loki.single.resourcesManagement.static.requests.memory
          • settings.loki.single.resourcesManagement.vpa
            object
            Resource management options for the VPA mode.

            Default: {}

            • settings.loki.single.resourcesManagement.vpa.cpu
              object

              Default: {}

              • settings.loki.single.resourcesManagement.vpa.cpu.limitRatio
                number
              • settings.loki.single.resourcesManagement.vpa.cpu.max

                Default: 2

              • settings.loki.single.resourcesManagement.vpa.cpu.min

                Default: 50m

            • settings.loki.single.resourcesManagement.vpa.memory
              object

              Default: {}

              • settings.loki.single.resourcesManagement.vpa.memory.limitRatio
                number
              • settings.loki.single.resourcesManagement.vpa.memory.max

                Default: 2Gi

              • settings.loki.single.resourcesManagement.vpa.memory.min

                Default: 256Mi

            • settings.loki.single.resourcesManagement.vpa.mode
              string

              Default: InPlaceOrRecreate

              Allowed values: Initial, InPlaceOrRecreate, Auto

      • settings.loki.storage
        object
        Where Loki keeps its data. The storage is a property of the installation and does not depend on the mode.

        Default: {}

        • settings.loki.storage.disk
          object

          The PersistentVolume of every stateful Loki pod: loki in Single mode, write and backend in Distributed mode. The disk is always there; storage.type decides what is kept on it.

          • Disk — chunks, the index and the write-ahead log. Size it for the period set by retentionPeriodHours: when the disk fills up, the oldest logs are evicted.
          • S3 — only the write-ahead log, the index cache and the compactor scratch space. A small disk is enough, the default size is fine. Retention is enforced by age through the compactor.

          Default: {}

          • settings.loki.storage.disk.sizeGigabytes
            integer

            Disk size in gigabytes.

            With storage.type: Disk you should manually specify the size required to store logs for the period defined by the retentionPeriodHours parameter.

            Note. While a disk is being adopted from the standalone loki module, the size of the existing volume is used and this parameter is ignored. Resize the PersistentVolumeClaim afterwards if a larger disk is needed.

            Default: 2

          • settings.loki.storage.disk.storageClass

            The name of StorageClass that will be used for the disk.

            If omitted, the StorageClass of the existing Loki PersistentVolumeClaim is used. If there is no claim yet, the StorageClass will be used according to the global storageClass parameter setting. false — an emptyDir is used instead of a PersistentVolume, and the data on it does not survive a pod restart.

            Warning. Specifying a value different from the one currently used (in the existing claim) will result in disk re-provisioning and all data will be deleted.

            Examples:

            storageClass: false
            
            storageClass: default
            
        • settings.loki.storage.s3
          object
          Parameters used when storage.type is S3.

          Default: {}

          • settings.loki.storage.s3.accessKeyID
            string
            S3 access key ID.
          • settings.loki.storage.s3.bucket
            string
            Bucket name for Loki chunks and indexes.
          • settings.loki.storage.s3.endpoint
            string
            S3-compatible storage endpoint URL.
          • settings.loki.storage.s3.insecure
            boolean
            Disable TLS certificate verification for the S3 endpoint.

            Default: false

          • settings.loki.storage.s3.region
            string
            AWS region or its equivalent for the S3 API.
          • settings.loki.storage.s3.s3ForcePathStyle
            boolean
            Force path-style S3 URLs. Required for MinIO and some other providers.

            Default: false

          • settings.loki.storage.s3.secretAccessKey
            string
            S3 secret access key.
        • settings.loki.storage.type
          string

          Where chunks and the index live.

          • Disk — on the PersistentVolume described by the storage.disk parameters. The only backend with disk-based retention. Available in Single mode only: the Distributed targets share the store.
          • S3 — in an S3-compatible object storage, configured via the storage.s3 parameters. The disk then holds only the write-ahead log, the index cache and the compactor scratch space.

          Default: Disk

          Allowed values: Disk, S3

      • settings.loki.storeSystemLogs
        boolean

        Save logs from the d8-* namespaces to loki.

        The log-shipper module must be enabled.

        Default: true

      • settings.loki.tolerations
        array of objects

        The same as the Pods’ spec.tolerations parameter in Kubernetes. Applies to every Loki Pod: loki in Single mode, write, read and backend in Distributed mode.

        If the parameter is omitted or empty, tolerations will be determined automatically.

        Example:

        tolerations:
        - effect: NoExecute
          key: dedicated.deckhouse.io
          operator: Equal
          value: loki
        
        • settings.loki.tolerations.effect
          string
        • settings.loki.tolerations.key
          string
        • settings.loki.tolerations.operator
          string
        • settings.loki.tolerations.tolerationSeconds
          integer
        • settings.loki.tolerations.value
          string
    • settings.opagent
      object
      Settings for the opagent host metrics collector.

      Default: {}

      • settings.opagent.pingExternalTargets
        array of objects

        A list of additional hosts outside the cluster that the agent pings from every node.

        Cluster nodes are pinged without this setting; the list adds external hosts. A host is not checked for format: a name that does not resolve to an IPv4 address is still listed in the metrics, but its packet counters do not grow.

        Default: []

        Example:

        pingExternalTargets:
        - host: 8.8.8.8
          name: google-dns
        - host: ya.ru
        
        • settings.opagent.pingExternalTargets.host
          string
          IP address or host name to monitor.

          Length: 1..253

          Pattern: (?s).*\S.*

        • settings.opagent.pingExternalTargets.name
          string
          Monitoring record name. If not set, the host is used as the name.

          Maximum length: 253

      • settings.opagent.scrapeInterval
        integer

        Interval (in seconds) at which opagent collects host metrics.

        Should typically match the cluster’s Prometheus scrape_interval to avoid mismatched data density in Grafana dashboards backed by the same datasource.

        Default: 30

        Allowed values: 10 <= X

    • settings.polkAnnotations
      object
      Settings for Polk-specific alert annotations handling.

      Default: {}

      • settings.polkAnnotations.enabled
        boolean

        Whether to keep Polk-specific alert annotations (with the plk_ prefix) in incoming alerts.

        When enabled (default), plk_* annotations are preserved in alerts for all notification receivers. When disabled, all plk_* annotations are removed from alerts when sending notifications to any receiver.

        Default: true