Конфигурация

Доступно с ограничениями в редакциях: Ultimate/EE

Стадия жизненного цикла модуля: Общедоступная версия

У модуля есть требования для установки

Как явно включить или отключить модуль…

Явно включить или выключить модуль можно одним из следующих способов:

С помощью веб-интерфейса Deckhouse. В разделе «Система» → «Управление системой» → «Deckhouse» → «Модули» откройте модуль observability-platform и включите (или выключите) переключатель «Модуль включен». Сохраните изменения.

Пример:
С помощью Deckhouse CLI (d8).

Используйте команду d8 system module enable для включения модуля или d8 system module disable для выключения модуля (требуется Deckhouse CLI (d8), настроенный на работу с кластером).

Пример включения модуля observability-platform:
```
d8 system module enable observability-platform
```
С помощью ModuleConfig observability-platform.

Установите spec.enabled в true или false в ModuleConfig observability-platform (при необходимости создайте его).

Пример манифеста для включения модуля observability-platform:
```
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: observability-platform
spec:
  enabled: true
```

Как настроить модуль…

Настроить модуль можно одним из следующих способов:

С помощью веб-интерфейса Deckhouse.

В разделе «Система» → «Управление системой» → «Deckhouse» → «Модули» откройте модуль observability-platform и включите переключатель «Дополнительные настройки». Заполните необходимые поля формы на вкладке «Конфигурация» или укажите настройки модуля в формате YAML на вкладке «YAML» без ключа верхнего уровня settings. Сохраните изменения.

Пример:

Вы также можете отредактировать объект ModuleConfig observability-platform на вкладке «YAML» в окне настроек модуля («Система» → «Управление системой» → «Deckhouse» → «Модули», откройте модуль observability-platform), указав версию схемы в параметре spec.version и необходимые параметры модуля в секции spec.settings.
С помощью Deckhouse CLI (d8) (требуется Deckhouse CLI (d8), настроенный на работу с кластером).

Отредактируйте существующий ModuleConfig observability-platform (подробнее о настройке Deckhouse Platform читайте в документации), выполнив следующую команду:
```
d8 k edit mc observability-platform
```
Внесите необходимые изменения в секцию spec.settings. При необходимости укажите версию схемы в параметре spec.version. Сохраните изменения.

Вы также можете создать файл манифеста ModuleConfig observability-platform, используя пример ниже. Заполните секцию spec.settings необходимыми параметрами модуля. При необходимости укажите версию схемы в параметре spec.version.

Примените манифест с помощью следующей команды (укажите имя файла манифеста):
```
d8 k apply -f <FILENAME>
```
Пример файла манифеста ModuleConfig observability-platform:
```
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: observability-platform
spec:
  version: 4
  enabled: true
  settings: # Параметры модуля из раздела «Параметры» ниже.
```

Как сменить канал обновлений модуля…

Чтобы сменить канал обновлений модуля, выполните действия из раздела Как сменить канал обновлений для модуля?.

Требования

К версии Deckhouse Platform: 1.68 и выше.

Конверсии

Модуль настраивается с помощью ресурса ModuleConfig, схема которого содержит номер версии. При применении в кластере старой версии схемы ModuleConfig выполняются автоматические преобразования. Чтобы обновить версию схемы ModuleConfig вручную, необходимо последовательно для каждой версии выполнить следующие действия:

Обновление из версии 1 в 2:

Удалите устаревшие поля monitoring.collector.inlet и ui.postgres.backup.dir. Приведите storage.traces.logLevel к нижнему регистру.

Обновление из версии 2 в 3:

Преобразуйте старые настройки resources для внутреннего PostgreSQL в предопределенный размер instanceSize.

Обновление из версии 3 в 4:

Удалите настройки resources для etcd метрик, логов, трейсов, для OSD Ceph и CPU-лимиты ingester: этими ресурсами управляет сам модуль, заданные вручную значения не применялись.

Параметры

Версия схемы: 4

settings
объект
- settings.general
  
  объект
  Общие параметры конфигурации.
  
  По умолчанию: {}
  - settings.general.baseDomain
    
    строка
    Обязательный параметр
    
    Базовый домен для всех компонентов Observability Platform.
    
    Этот домен используется для доступа к интерфейсу Observability Platform. Также существуют несколько поддоменов, которые используются для определенных компонентов.
    
    Шаблон: ^[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.general.clusterBaseDomain
    
    строка
    Доменное имя кластера, используемое для распознавания кластеров в катастрофоустойчивом режиме.
    
    Шаблон: ^([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.general.clusterName
    
    строка
    Обязательный параметр
    
    Имя кластера, которое используется для распознавания кластеров в катастрофоустойчивом режиме.
  - settings.general.clusterNeighbors
    
    объект
    Соседние кластеры в катастрофоустойчивом режиме в формате <clusterName>: <clusterDomain>.
    
    Пример:
    dc2: msk.example.com dc3: spb.example.com
  - settings.general.tls
    
    объект
    Параметры конфигурации для указания сертификатов HTTPS-соединений во всех компонентах модуля Deckhouse Observability Platform.
    
    Вы можете либо предоставить свои сертификаты, либо использовать cert-manager для их выдачи.
    
    По умолчанию: {}
    - settings.general.tls.ca
      
      строка
      Корневой сертификат, необходимый, если сертификат выдан непубличным центром сертификации.
      
      Используется для проверки межсервисных запросов и запросов к внешним ресурсам через HTTPS, где сертификаты выданы тем же центром сертификации (CA).
    - settings.general.tls.crt
      
      строка
      Сертификат, предоставленный для использования пользовательского сертификата на всех доменах Deckhouse Observability Platform.
      
      Сертификат должен предъявлять general.baseDomain (а если задан general.clusterBaseDomain — то и его, независимо от основного домена) как DNS-имена в расширении Subject Alternative Name (SAN): либо wildcard-пара (<domain>, *.<domain>), либо домен вместе с поддоменами api, update, logs, collector и s3. Иначе модуль не проходит валидацию при старте и завершается с ошибкой Error validating TLS-certificate: .... Полный список имён и разбор — в разделе Требования к SSL-сертификатам. Указывать Common Name не обязательно.
      
      Это поле несовместимо с полем issuer. Вы должны указать либо issuer, либо оба – crt и key.
    - settings.general.tls.issuer
      
      строка
      Издатель сертификата. Для всех доменов Deckhouse Observability Platform сертификат может быть выдан с использованием модуля cert-manager.
      
      Это поле несовместимо с полями crt и key. Вы должны указать либо issuer, либо оба – crt и key.
      
      По умолчанию: letsencrypt
      
      Допустимые значения: letsencrypt, digitalocean, cloudflare
    - settings.general.tls.key
      
      строка
      Закрытый ключ, связанный с сертификатом, используемый для настройки пользовательских сертификатов в Deckhouse Observability Platform.
      
      Это поле несовместимо с полем issuer. Вы должны указать либо issuer, либо оба – crt и key.
- settings.ingressClass
  
  строка
  Класс Ingress-контроллера, который используется для компонентов Observability Platform.
  
  Опциональный параметр, по умолчанию используется глобальное значение modules.ingressClass.
  
  Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- settings.monitoring
  
  объект
  Опции, связанные с конфигурацией компонентов, ответственных за мониторинг.
  
  По умолчанию: {}
  - settings.monitoring.agent
    
    объект
    
    По умолчанию: {}
    - settings.monitoring.agent.pgClientTableName
      
      строка
      Имя таблицы, используемой клиентом PostgreSQL.
      
      По умолчанию: okmeter
    - settings.monitoring.agent.productName
      
      строка
      Имя продукта мониторингового агента.
      
      По умолчанию: okagent
  - settings.monitoring.agentUpdater
    
    объект
    Опции, связанные с конфигурацией компонента, используемого для управления процессом обновления агента Deckhouse Observability platform.
    
    По умолчанию: {}
    - settings.monitoring.agentUpdater.config
      
      объект
      Конфигурация для обновления агента.
      
      По умолчанию: {}
  - settings.monitoring.collector
    
    объект
    Опции, связанные с конфигурацией сборщика метрик.
    
    По умолчанию: {}
    - settings.monitoring.collector.maxConnectionAllow
      
      целое число
      Максимальное количество одновременных подключений агентов, принимаемых одним подом сборщика метрик. Увеличьте значение, если HorizontalPodAutoscaler сборщика уже ограничен числом узлов, а утилизация подключений остаётся высокой.
      
      По умолчанию: 2000
      
      Допустимые значения: 100 <= X <= 100000
    - settings.monitoring.collector.storageClass
      
      строка
      StorageClass используемый для создания томов для коллектора метрик. Время жизни тома равно времени жизни пода, поэтому можно использовать StorageClass от LocalPathProvisioner.
  - settings.monitoring.customDomain
    
    объект
    Настройки пользовательского домена для модуля мониторинга.
    
    По умолчанию: {}
    - settings.monitoring.customDomain.baseDomain
      
      строка
      Настройки пользовательского домена для модуля мониторинга.
      
      По умолчанию: ‘’
      
      Шаблон: ^([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.monitoring.customDomain.collectorDomain
      
      строка
      Укажите домен для сборщика метрик.
      
      По умолчанию: ‘’
      
      Шаблон: ^([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.monitoring.customDomain.tls
      
      объект
      Настройки TLS-сертификатов для сборщика метрик и связанных эндпоинтов.
      
      По умолчанию: {}
      - settings.monitoring.customDomain.tls.ca
        
        строка
      - settings.monitoring.customDomain.tls.crt
        
        строка
      - settings.monitoring.customDomain.tls.issuer
        
        строка
      - settings.monitoring.customDomain.tls.key
        
        строка
  - settings.monitoring.dockerRegistry
    
    объект
    Опции, связанные с конфигурацией Docker Registry, используемого для публикации новых образов Docker с новыми версиями агента Deckhouse Observability Platform.
    
    По умолчанию: {}
    - settings.monitoring.dockerRegistry.enabled
      
      булевый
      Указывает, должны ли быть установлены компоненты Docker Registry.
      
      По умолчанию: false
  - settings.monitoring.enabled
    
    булевый
    Включает или отключает компоненты, необходимые для сбора и отображения метрик с использованием opAgent.
    
    По умолчанию: false
- settings.storage
  
  объект
  Опции, связанные с конфигурацией компонентов, ответственных за прием и хранение данных.
  
  По умолчанию: {}
  - settings.storage.ceph
    
    объект
    Опции, связанные с конфигурацией Ceph.
    
    По умолчанию: {}
    - settings.storage.ceph.configOverride
      
      строка
    - settings.storage.ceph.mgr
      
      объект
      Опции, связанные с конфигурацией Ceph MGR.
      
      По умолчанию: {}
      - settings.storage.ceph.mgr.resources
        
        объект
        Опции управления ресурсами для Ceph MGR-подов.
        
        По умолчанию: {}
        
        Пример:
        limits: memory: 1Gi requests: cpu: 500M memory: 1Gi
        
        settings.storage.ceph.mgr.resources.limits
        
        объект
        Настройка пределов ресурсов для Ceph MGR-подов.
        
        settings.storage.ceph.mgr.resources.limits.cpu
        
        Максимальное количество CPU на под для Ceph MGR-подов.
        
        settings.storage.ceph.mgr.resources.limits.memory
        
        Максимальное количество памяти на под для Ceph MGR-подов.
        
        settings.storage.ceph.mgr.resources.requests
        
        объект
        Опции запросов ресурсов для Ceph MGR-подов.
        
        settings.storage.ceph.mgr.resources.requests.cpu
        
        Минимальное количество CPU на под для Ceph MGR-подов.
        
        settings.storage.ceph.mgr.resources.requests.memory
        
        Минимальное количество памяти на под для Ceph MGR-подов.
    - settings.storage.ceph.mon
      
      объект
      Опции, связанные с конфигурацией Ceph-мониторов.
      
      По умолчанию: {}
      - settings.storage.ceph.mon.resources
        
        объект
        Опции управления ресурсами для Ceph-мониторов.
        
        По умолчанию: {}
        
        Пример:
        limits: cpu: 250m memory: 512Mi requests: cpu: 55m memory: 256Mi
        
        settings.storage.ceph.mon.resources.limits
        
        объект
        Настройка пределов ресурсов для подов Ceph-мониторов.
        
        settings.storage.ceph.mon.resources.limits.cpu
        
        Настройка лимита на использование CPU для пода.
        
        settings.storage.ceph.mon.resources.limits.memory
        
        Настройка лимита доступной памяти для пода.
        
        settings.storage.ceph.mon.resources.requests
        
        объект
        Опции запросов ресурсов для подов Ceph-мониторов.
        
        settings.storage.ceph.mon.resources.requests.cpu
        
        Настройка запросов на резервирование ресурсов CPU для пода.
        
        settings.storage.ceph.mon.resources.requests.memory
        
        Настройка запросов на резервирование памяти для пода.
      - settings.storage.ceph.mon.storageClass
        
        строка
        Указывает StorageClass, который будет использоваться для PersistentVolume (PV).
        
        Если не указано, будет использоваться первый доступный StorageClass из списка StorageClass, применимых к группе узлов, где будут развернуты компоненты Ceph.
      - settings.storage.ceph.mon.storageSize
        
        строка
        Определяет размер PersistentVolume (PV), который будет создан для Ceph-монитора.
        
        Размер должен быть указан с использованием стандартных единиц хранения (например, Gi для Гибибайтов, Ti для Тебибайтов, Mi для Мебибайтов).
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|k|Ei|Pi|Ti|Gi|Mi|Ki)?$
    - settings.storage.ceph.objectStore
      
      объект
      Опции, связанные с пулами Ceph ObjectStore.
      
      По умолчанию: {}
      - settings.storage.ceph.objectStore.poolType
        
        строка
        Тип data pool для Ceph ObjectStore.
        
        Поддерживаемые значения:
        
        Replicated — хранить объектные данные в реплицированном пуле.
        
        ErasureCoded — хранить объектные данные в erasure-coded пуле 3+2. Для этого режима требуется не менее 5 узлов Ceph.
        
        По умолчанию: Replicated
        
        Допустимые значения: Replicated, ErasureCoded
    - settings.storage.ceph.osd
      
      объект
      Опции, связанные с конфигурацией Ceph object storage daemons.
      
      По умолчанию: {}
      - settings.storage.ceph.osd.count
        
        целое число
        Указывает количество OSD (Object Storage Daemons), которые нужно создать.
      - settings.storage.ceph.osd.storageClass
        
        строка
        Обязательный параметр
        
        Указывает StorageClass, который будет использоваться для PersistentVolume (PV).
        
        Если не указано, будет использоваться первый доступный StorageClass из списка StorageClass, применимых к группе узлов, где будут развернуты компоненты Ceph.
      - settings.storage.ceph.osd.storageSize
        
        строка
        Определяет размер PersistentVolume (PV), который будет создан для Ceph object storage daemons.
        
        Размер должен быть указан с использованием стандартных единиц хранения (например, Gi для Гибибайтов, Ti для Тебибайтов, Mi для Мебибайтов).
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|k|Ei|Pi|Ti|Gi|Mi|Ki)?$
    - settings.storage.ceph.rgw
      
      объект
      Опции, связанные с конфигурацией Ceph object gateway.
      
      По умолчанию: {}
      - settings.storage.ceph.rgw.resources
        
        объект
        Опции управления ресурсами для Ceph RGW-подов.
        
        По умолчанию: {}
        
        Пример:
        resources: limits: cpu: 250m memory: 512Mi requests: cpu: 55m memory: 256Mi
        
        settings.storage.ceph.rgw.resources.limits
        
        объект
        Настройка пределов ресурсов для Ceph RGW-подов.
        
        settings.storage.ceph.rgw.resources.limits.cpu
        
        Настройка лимита на использование CPU для пода.
        
        settings.storage.ceph.rgw.resources.limits.memory
        
        Настройка лимита доступной памяти для пода.
        
        settings.storage.ceph.rgw.resources.requests
        
        объект
        Опции запросов ресурсов для Ceph RGW-подов.
        
        settings.storage.ceph.rgw.resources.requests.cpu
        
        Настройка запросов на резервирование ресурсов CPU для пода.
        
        settings.storage.ceph.rgw.resources.requests.memory
        
        Настройка запросов на резервирование объема оперативной памяти для пода.
  - settings.storage.logs
    
    объект
    Опции, связанные с конфигурацией компонентов, ответственных за сбор и хранение логов.
    
    По умолчанию: {}
    - settings.storage.logs.cacheSize
      
      строка
      Размер серверов memcached:
      
      Small — 1 под с 1Gi памяти;
      
      Medium — 3 пода с 2Gi памяти;
      
      Large — 3 пода с 4Gi памяти.
      
      По умолчанию: Small
      
      Допустимые значения: Small, Medium, Large
    - settings.storage.logs.compactor
      
      объект
      Опции, связанные с конфигурацией Compactor.
      
      По умолчанию: {}
      - settings.storage.logs.compactor.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) Compactor.
      - settings.storage.logs.compactor.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для Compactor.
        
        По умолчанию: 50Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.logs.defaultStorageClass
      
      строка
      StorageClass, используемый для всех компонентов, участвующих в хранении логов, если для компонента не определен конкретный StorageClass.
    - settings.storage.logs.enabled
      
      булевый
      Включить или выключить компоненты логов.
      
      По умолчанию: false
    - settings.storage.logs.etcd
      
      объект
      Опции, связанные с конфигурацией etcd.
      
      По умолчанию: {}
      - settings.storage.logs.etcd.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) etcd.
      - settings.storage.logs.etcd.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для etcd.
        
        По умолчанию: 2Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.logs.indexCurator
      
      объект
      Настройки Index Curator.
      
      По умолчанию: {}
      - settings.storage.logs.indexCurator.logLevel
        
        строка
        Уровень логирования для index curator, определяющий подробность сообщений журнала.
        
        По умолчанию: info
        
        Допустимые значения: debug, info, warn, error
    - settings.storage.logs.indexGateway
      
      объект
      Опции, связанные с конфигурацией Loki’s index gateway.
      
      По умолчанию: {}
      - settings.storage.logs.indexGateway.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) index gateway.
      - settings.storage.logs.indexGateway.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для index gateway.
        
        По умолчанию: 50Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.logs.ingester
      
      объект
      Опции, связанные с конфигурацией Ingester.
      
      По умолчанию: {}
      - settings.storage.logs.ingester.resources
        
        объект
        Опции управления ресурсами для Ingester-подов.
        
        По умолчанию: {}
        
        settings.storage.logs.ingester.resources.limits
        
        объект
        Настройки пределов ресурсов для Ingester-подов.
        
        По умолчанию: {}
        
        settings.storage.logs.ingester.resources.limits.memory
        
        Настройка лимита доступной памяти для пода.
        
        По умолчанию: 4Gi
        
        settings.storage.logs.ingester.resources.requests
        
        объект
        Настройки запросов ресурсов для Ingester-подов.
        
        По умолчанию: {}
        
        settings.storage.logs.ingester.resources.requests.cpu
        
        Настройка запросов на резервирование ресурсов CPU для пода.
        
        По умолчанию: 50m
        
        settings.storage.logs.ingester.resources.requests.memory
        
        Настройка запросов на резервирование объема оперативной памяти для пода.
        
        По умолчанию: 512Mi
      - settings.storage.logs.ingester.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) Ingester.
      - settings.storage.logs.ingester.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для Ingester.
        
        По умолчанию: 50Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.logs.logLevel
      
      строка
      Уровень логирования для Loki, определяющий подробность сообщений журнала.
      
      По умолчанию: info
      
      Допустимые значения: debug, info, warn, error
    - settings.storage.logs.ruler
      
      объект
      Опции, связанные с конфигурацией ruler.
      
      По умолчанию: {}
      - settings.storage.logs.ruler.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) ruler.
      - settings.storage.logs.ruler.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для ruler.
        
        По умолчанию: 50Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
  - settings.storage.metrics
    
    объект
    Опции, связанные с конфигурацией компонентов, ответственных за сбор и хранение метрик.
    
    По умолчанию: {}
    - settings.storage.metrics.alertmanager
      
      объект
      Опции, связанные с конфигурацией Alertmanager.
      
      По умолчанию: {}
      - settings.storage.metrics.alertmanager.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) Alertmanager.
      - settings.storage.metrics.alertmanager.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для Alertmanager.
        
        По умолчанию: 2Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.metrics.cacheSize
      
      строка
      Размер серверов memcached:
      
      Small — 1 под с 1Gi памяти;
      
      Medium — 3 пода с 2Gi памяти;
      
      Large — 3 пода с 4Gi памяти.
      
      По умолчанию: Small
      
      Допустимые значения: Small, Medium, Large
    - settings.storage.metrics.compactor
      
      объект
      Опции, связанные с конфигурацией Compactor.
      
      По умолчанию: {}
      - settings.storage.metrics.compactor.concurrency
        
        целое число
        Number of concurrent compaction jobs.
        
        По умолчанию: 1
      - settings.storage.metrics.compactor.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) Compactor.
      - settings.storage.metrics.compactor.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для Compactor.
        
        По умолчанию: 100Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.metrics.defaultStorageClass
      
      строка
      StorageClass, используемый для всех компонентов, участвующих в хранении метрик, если для компонента не определен конкретный StorageClass.
    - settings.storage.metrics.etcd
      
      объект
      Опции, связанные с конфигурацией etcd, используемого компонентами хранения метрик.
      
      По умолчанию: {}
      - settings.storage.metrics.etcd.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) etcd.
      - settings.storage.metrics.etcd.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для etcd.
        
        По умолчанию: 2Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.metrics.ingester
      
      объект
      Опции, связанные с конфигурацией Ingester.
      
      По умолчанию: {}
      - settings.storage.metrics.ingester.resources
        
        объект
        Опции управления ресурсами для Ingester-подов.
        
        По умолчанию: {}
        
        settings.storage.metrics.ingester.resources.limits
        
        объект
        Настройки пределов ресурсов для Ingester-подов.
        
        По умолчанию: {}
        
        settings.storage.metrics.ingester.resources.limits.memory
        
        Максимальное количество памяти на под для Ingester-подов.
        
        По умолчанию: 4Gi
        
        settings.storage.metrics.ingester.resources.requests
        
        объект
        Настройки запросов ресурсов для Ingester-подов.
        
        По умолчанию: {}
        
        settings.storage.metrics.ingester.resources.requests.cpu
        
        Минимальное количество CPU на под для Ingester-подов.
        
        По умолчанию: 100m
        
        settings.storage.metrics.ingester.resources.requests.memory
        
        Минимальное количество памяти на под для Ingester-подов.
        
        По умолчанию: 1Gi
      - settings.storage.metrics.ingester.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) Ingester.
      - settings.storage.metrics.ingester.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для Ingester.
        
        По умолчанию: 50Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.metrics.logLevel
      
      строка
      Уровень логирования для метрик, который определяет подробность сообщений журнала.
      
      По умолчанию: info
      
      Допустимые значения: debug, info, warn, error
    - settings.storage.metrics.storeGateway
      
      объект
      Опции, связанные с конфигурацией Store-gateway.
      
      По умолчанию: {}
      - settings.storage.metrics.storeGateway.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) Store-gateway.
      - settings.storage.metrics.storeGateway.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для Store-gateway.
        
        По умолчанию: 50Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
  - settings.storage.reconciler
    
    объект
    Опции, связанные с конфигурацией reconciler.
    
    По умолчанию: {}
    - settings.storage.reconciler.logLevel
      
      строка
      Уровень логирования для reconciler, определяющий подробность сообщений журнала.
      
      По умолчанию: info
      
      Допустимые значения: debug, info, warn, error
  - settings.storage.traces
    
    объект
    Опции, связанные с конфигурацией компонентов, ответственных за сбор и хранение трейсов.
    
    По умолчанию: {}
    - settings.storage.traces.cacheSize
      
      строка
      Размер серверов memcached:
      
      Small — 1 под с 1Gi памяти;
      
      Medium — 3 пода с 2Gi памяти;
      
      Large — 3 пода с 4Gi памяти.
      
      По умолчанию: Small
      
      Допустимые значения: Small, Medium, Large
    - settings.storage.traces.compactor
      
      объект
      Опции, связанные с конфигурацией Compactor.
      
      По умолчанию: {}
      - settings.storage.traces.compactor.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) Compactor.
      - settings.storage.traces.compactor.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для Compactor.
        
        По умолчанию: 50Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.traces.defaultStorageClass
      
      строка
      StorageClass, используемый для всех компонентов, участвующих в хранении трейсов, если для компонента не определен конкретный StorageClass.
    - settings.storage.traces.enabled
      
      булевый
      Включить или выключить компоненты трейсов.
      
      По умолчанию: false
    - settings.storage.traces.etcd
      
      объект
      Опции, связанные с конфигурацией etcd.
      
      По умолчанию: {}
      - settings.storage.traces.etcd.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) etcd.
      - settings.storage.traces.etcd.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для etcd.
        
        По умолчанию: 2Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.traces.ingester
      
      объект
      Опции, связанные с конфигурацией Ingester.
      
      По умолчанию: {}
      - settings.storage.traces.ingester.resources
        
        объект
        Опции управления ресурсами для Ingester-подов.
        
        По умолчанию: {}
        
        settings.storage.traces.ingester.resources.limits
        
        объект
        Настройки пределов ресурсов для Ingester-подов.
        
        По умолчанию: {}
        
        settings.storage.traces.ingester.resources.limits.memory
        
        Настройка лимита доступной памяти для пода.
        
        По умолчанию: 4Gi
        
        settings.storage.traces.ingester.resources.requests
        
        объект
        Настройки запросов ресурсов для Ingester-подов.
        
        По умолчанию: {}
        
        settings.storage.traces.ingester.resources.requests.cpu
        
        Настройка запросов на резервирование ресурсов CPU для пода.
        
        По умолчанию: 50m
        
        settings.storage.traces.ingester.resources.requests.memory
        
        Настройка запросов на резервирование объема оперативной памяти для пода.
        
        По умолчанию: 512Mi
      - settings.storage.traces.ingester.storageClass
        
        строка
        StorageClass, используемый для PersistentVolume (PV) Ingester.
      - settings.storage.traces.ingester.storageSize
        
        строка
        Размер PersistentVolume (PV), выделенного для Ingester.
        
        По умолчанию: 50Gi
        
        Шаблон: ^[0-9]+(\.[0-9]+)?(Ei|Pi|Ti|Gi|Mi)?$
    - settings.storage.traces.logLevel
      
      строка
      Уровень логирования для Tempo, определяющий подробность сообщений журнала.
      
      По умолчанию: info
      
      Допустимые значения: debug, info, warn, error
  - settings.storage.usageCollector
    
    объект
    Опции, связанные с конфигурацией сборщика использования.
    
    По умолчанию: {}
    - settings.storage.usageCollector.logLevel
      
      строка
      Уровень логирования для сборщика использования, определяющий подробность сообщений журнала.
      
      По умолчанию: info
      
      Допустимые значения: debug, info, warn, error
- settings.ui
  
  объект
  Опции, связанные с конфигурацией компонентов пользовательского интерфейса.
  
  По умолчанию: {}
  - settings.ui.auth
    
    объект
    Опции, связанные с конфигурацией компонентов аутентификации.
    
    По умолчанию: {}
    - settings.ui.auth.afterLogoutUrl
      
      строка
      URL-адрес, на который пользователь будет перенаправлен после выхода из системы.
    - settings.ui.auth.clientId
      
      строка
      Идентификатор клиента, зарегистрированный у провайдера OIDC. Этот идентификатор используется для идентификации клиентского приложения в процессе аутентификации.
    - settings.ui.auth.clientSecret
      
      строка
      Секрет клиента, связанный с идентификатором клиента, используется для аутентификации клиентского приложения у провайдера OIDC.
    - settings.ui.auth.groupsParamName
      
      строка
      Имя параметра в ответе провайдера, содержащее список групп пользователя, по умолчанию groups.
    - settings.ui.auth.issuer
      
      строка
      URL-адрес издателя для провайдера OIDC. Обычно это базовый URL-адрес провайдера, где можно найти метаданные OIDC.
    - settings.ui.auth.mode
      
      строка
      Режим аутентификации, используемый для входа в интерфейс:
      
      default - используются адрес электронной почты и пароль для аутентификации.
      
      externalAuth - используется провайдер OIDC для аутентификации.
      
      По умолчанию: default
      
      Допустимые значения: default, externalAuth
    - settings.ui.auth.provider
      
      строка
      Провайдер OIDC для режима внешней аутентификации. – login использует Keycloak.
      
      По умолчанию: dex
      
      Допустимые значения: dex, okta, adfs, login
  - settings.ui.clusterBootstrapToken
    
    строка
    Обязательный параметр
    
    Токен, используемый для присоединения нескольких установок Deckhouse Observability Platform в кластер.
  - settings.ui.configValidator
    
    объект
    Опции, связанные с компонентом валидатора конфигурации, проверяющего настройки модуля.
    
    По умолчанию: {}
    - settings.ui.configValidator.logLevel
      
      строка
      Уровень логирования для валидатора конфигурации, определяющий подробность сообщений журнала.
      
      По умолчанию: info
      
      Допустимые значения: info, warn, error, debug
  - settings.ui.grafana
    
    объект
    Настройки, связанные с конфигурацией Grafana.
    
    По умолчанию: {}
    - settings.ui.grafana.logLevel
      
      строка
      Уровень логирования для Grafana, определяющий подробность сообщений журнала.
      
      По умолчанию: info
      
      Допустимые значения: info, warn, error, debug
  - settings.ui.locale
    
    строка
    Язык интерфейса.
    
    Допустимые значения: ru, en
  - settings.ui.postgres
    
    объект
    Настройки для конфигурации базы данных PostgreSQL, используемой компонентом пользовательского интерфейса.
    
    По умолчанию: {}
    - settings.ui.postgres.backup
      
      объект
      Настройки, связанные с резервными копиями базы данных.
      
      По умолчанию: {}
      - settings.ui.postgres.backup.enabled
        
        булевый
        Включить или выключить резервные копии базы данных.
        
        По умолчанию: true
      - settings.ui.postgres.backup.includeAuditLogs
        
        булевый
        Включение журнала аудита в резервные копии.
        
        По умолчанию: false
      - settings.ui.postgres.backup.keepDays
        
        число
        Количество дней для хранения резервных копий.
        
        По умолчанию: 3
      - settings.ui.postgres.backup.s3
        
        объект
        Конфигурация хранения резервных копий во внешнем S3.
        
        По умолчанию: {}
        
        settings.ui.postgres.backup.s3.accessKey
        
        строка
        Ключ доступа, используемый для авторизации в бакете.
        
        settings.ui.postgres.backup.s3.bucket
        
        строка
        Имя бакета.
        
        settings.ui.postgres.backup.s3.enabled
        
        булевый
        Включить или выключить резервные копии в совместимом с S3 хранилище.
        
        По умолчанию: false
        
        settings.ui.postgres.backup.s3.host
        
        строка
        URL, указывающий на бакет.
        
        settings.ui.postgres.backup.s3.secretKey
        
        строка
        Секретный ключ, используемый для авторизации в бакете.
      - settings.ui.postgres.backup.schedule
        
        строка
        Определите расписание для резервных копий, используя выражение cron.
        
        По умолчанию: 0 * * * *
    - settings.ui.postgres.external
      
      объект
      Учетные данные и данные о подключении для использования внешней базы данных PostgreSQL.
      - settings.ui.postgres.external.db
        
        строка
        Имя базы данных на внешнем сервере PostgreSQL.
      - settings.ui.postgres.external.fromSecret
        
        булевый
        Если параметр установлен в true, учетные данные будут считываться из объекта Kubernetes Secret, расположенного в пространстве имен d8-observability-platform под названием custom-postgres-credentials.
        
        По умолчанию: true
      - settings.ui.postgres.external.host
        
        строка
        Адрес хоста внешнего сервера PostgreSQL.
      - settings.ui.postgres.external.password
        
        строка
        Пароль для аутентификации на внешнем сервере PostgreSQL.
      - settings.ui.postgres.external.port
        
        строка
        Порт, на котором слушает внешний сервер PostgreSQL.
      - settings.ui.postgres.external.sslmode
        
        строка
        Режим SSL для подключения к внешнему серверу PostgreSQL.
        
        По умолчанию: require
        
        Допустимые значения: disable, allow, prefer, require, verify-ca, verify-full
      - settings.ui.postgres.external.user
        
        строка
        Имя пользователя для аутентификации на внешнем сервере PostgreSQL.
    - settings.ui.postgres.internal
      
      объект
      Настройки конфигурации для внутреннего кластера PostgreSQL.
      
      По умолчанию: {}
      - settings.ui.postgres.internal.instanceSize
        
        строка
        Размер инстансов PostgreSQL в кластере:
        
        Light — 2 пода с 1 CPU и 2 GiB памяти.
        
        Small — 2 пода с 2 CPU и 4 GiB памяти.
        
        Medium — 2 пода с 4 CPU и 8 GiB памяти.
        
        Large — 2 пода с 8 CPU и 16 GiB памяти.
        
        По умолчанию: Small
        
        Допустимые значения: Light, Small, Medium, Large
      - settings.ui.postgres.internal.storage
        
        объект
        Конфигурация хранилища для кластера PostgreSQL.
        
        По умолчанию: {}
        
        settings.ui.postgres.internal.storage.class
        
        строка
        StorageClass, используемый кластером PostgreSQL.
        
        settings.ui.postgres.internal.storage.size
        
        строка
        Размер хранилища, выделенного для кластера PostgreSQL.
        
        По умолчанию: 50Gi
    - settings.ui.postgres.mode
      
      строка
      Настройка режима использования – внутренний или внешний сервер PostgreSQL.
      
      При использовании внешней базы данных PostgreSQL, должны быть включены следующие расширения:
      
      pgcrypto - для базы данных Deckhouse observability platform;
      
      citext - для базы данных Deckhouse observability platform alertgate;
      
      btree_gin - для базы данных Deckhouse observability platform alertgate.
      
      По умолчанию: Internal
      
      Допустимые значения: Internal, External
  - settings.ui.secretKeyBase
    
    строка
    Обязательный параметр
    
    Случайная строка, используемая для шифрования данных и проверки.
  - settings.ui.secretsStore
    
    объект
    Интеграция с хранилищем секретов, совместимым с HashiCorp Vault (Deckhouse Stronghold или HashiCorp Vault), для веб-мониторинга.
    
    В конфигурации сайтов вместо паролей и токенов в открытом виде указываются ссылки на секреты вида ${secret:<путь>#<ключ>}. Backend читает значения из KV v2 secrets engine только в момент формирования конфигурации для агентов gogomonia; значения никогда не сохраняются в базе данных платформы, не возвращаются через API и не пишутся в журнал аудита.
    
    Ссылка разрешается в запрос, который отправляют агенты, поэтому возможность править сайты проекта (роли user и admin, API-токен с доступом к веб-мониторингу) равносильна возможности прочитать любой секрет, на который этот проект может ссылаться.
    
    По умолчанию: {}
    - settings.ui.secretsStore.address
      
      строка
      URL API хранилища секретов, например https://stronghold.d8-stronghold.svc:8200. Обязателен при enabled: true.
    - settings.ui.secretsStore.auth
      
      объект
      Способ аутентификации backend в хранилище секретов.
      
      По умолчанию: {}
      - settings.ui.secretsStore.auth.kubernetes
        
        объект
        Настройки метода аутентификации Kubernetes.
        
        По умолчанию: {}
        
        settings.ui.secretsStore.auth.kubernetes.audience
        
        строка
        Audience projected-токена ServiceAccount. Задавайте только если у роли в хранилище указан явный audience; значения должны совпадать. Пустое значение — audience API-сервера Kubernetes по умолчанию.
        
        settings.ui.secretsStore.auth.kubernetes.grantTokenReview
        
        булевый
        Привязать ServiceAccount backend-secrets к ClusterRole system:auth-delegator. Требуется, когда хранилище проверяет токены клиентов токеном самого клиента (auth/<path>/config без token_reviewer_jwt) — обычный случай для внешнего HashiCorp Vault. Для Deckhouse Stronghold в том же кластере не нужно.
        
        По умолчанию: false
        
        settings.ui.secretsStore.auth.kubernetes.path
        
        строка
        Путь, по которому в хранилище включён метод аутентификации Kubernetes. Deckhouse Stronghold заранее настраивает kubernetes_local для кластера, в котором работает; в HashiCorp Vault по умолчанию используется kubernetes.
        
        По умолчанию: kubernetes_local
        
        settings.ui.secretsStore.auth.kubernetes.role
        
        строка
        Имя роли метода Kubernetes, привязанной к ServiceAccount backend-secrets пространства имён d8-observability-platform. Обязательно при method: Kubernetes.
      - settings.ui.secretsStore.auth.method
        
        строка
        Метод аутентификации:
        
        Kubernetes — метод Kubernetes: под backend входит по projected-токену своего ServiceAccount backend-secrets;
        
        Token — статический токен из Kubernetes Secret.
        
        По умолчанию: Kubernetes
        
        Допустимые значения: Kubernetes, Token
      - settings.ui.secretsStore.auth.token
        
        объект
        Настройки аутентификации статическим токеном.
        
        По умолчанию: {}
        
        settings.ui.secretsStore.auth.token.secretName
        
        строка
        Имя Kubernetes Secret в пространстве имён d8-observability-platform, содержащего токен в ключе token.
        
        По умолчанию: secrets-store-token
    - settings.ui.secretsStore.caCert
      
      строка
      CA-сертификат в формате PEM для проверки TLS-сертификата хранилища. Оставьте пустым, чтобы использовать системный набор CA.
    - settings.ui.secretsStore.enabled
      
      булевый
      Включить ссылки на секреты в конфигурации веб-мониторинга.
      
      По умолчанию: false
    - settings.ui.secretsStore.kv
      
      объект
      Расположение секретов веб-мониторинга в хранилище. Используется ровно один KV v2 secrets engine.
      
      По умолчанию: {}
      - settings.ui.secretsStore.kv.mount
        
        строка
        Путь монтирования KV v2 secrets engine. Все пути к секретам, относительные и абсолютные, разрешаются внутри него.
        
        По умолчанию: secret
      - settings.ui.secretsStore.kv.pathPrefix
        
        строка
        Префикс путей секретов проектов внутри engine. Относительная ссылка ${secret:app/prod#key} в проекте разрешается в <mount>/<pathPrefix>/<имя space>/<имя проекта>/app/prod. Абсолютные ссылки (${secret:/team/db#key}) префикс не используют и разрешены только для префиксов путей, перечисленных администратором платформы в настройках проекта.
        
        По умолчанию: dop/web-monitoring
    - settings.ui.secretsStore.namespace
      
      строка
      Пространство имён Vault, передаётся в заголовке X-Vault-Namespace (пространства имён Stronghold, Vault Enterprise). Оставьте пустым для хранилища без пространств имён или HashiCorp Vault OSS.
  - settings.ui.sentry
    
    объект
    Опции, связанные с конфигурацией Sentry.
    
    По умолчанию: {}
    - settings.ui.sentry.dsn
      
      строка
      DSN для Sentry.
    - settings.ui.sentry.env
      
      строка
      Среда, используемая для Sentry.
  - settings.ui.smtp
    
    объект
    Конфигурация SMTP-сервера, используемого для отправки писем, связанных с аутентификацией, таких как проверка учетной записи и сброс пароля.
    
    По умолчанию: {}
    - settings.ui.smtp.address
      
      строка
      Адрес SMTP-сервера. Это может быть IP-адрес или доменное имя.
    - settings.ui.smtp.domain
      
      строка
      Доменное имя, которое будет использоваться в качестве домена отправителя. Это часть, которая отображается после символа @ в адресе электронной почты.
    - settings.ui.smtp.enabled
      
      булевый
      Включен или отключен SMTP для компонента пользовательского интерфейса. Установите значение true для включения функции SMTP.
    - settings.ui.smtp.password
      
      строка
      Пароль, необходимый для аутентификации на SMTP-сервере.
    - settings.ui.smtp.port
      
      строка
      Порт, на котором слушает SMTP-сервер. Стандартные порты включают 25, 465 (для SSL) и 587 (для TLS).
    - settings.ui.smtp.user
      
      строка
      Имя пользователя, необходимое для аутентификации на SMTP-сервере.
  - settings.ui.tenantHashSalt
    
    строка
    Обязательный параметр
    
    Случайная строка, используемая для генерации идентификатора арендатора.
  - settings.ui.webAppConfiguration
    
    объект
    Дополнительные параметры конфигурации, передаваемые компонентам пользовательского интерфейса.

Требования

Конверсии

Параметры

Произошла ошибка

Расскажите, что не понравилось.

Конфигурация

Требования

Конверсии

Параметры

Произошла ошибка

Расскажите, что не понравилось.

Запросить пробный доступ

Запрос получен

Ошибка

Связаться со специалистом Deckhouse

Заявка отправлена

Возникла ошибка отправки формы

Запросить обучение

Запрос получен

Ошибка

Запросить демо

Запрос получен

Ошибка

Получите отчет о соответствии рекомендациям PCI SSC

Спасибо

Ошибка

Запросить подробности партнёрской программы

Запрос получен

Ошибка