Настройки | upmeter

Стадия жизненного цикла модуля: General Availability
У модуля есть требования для установки

Аутентификация

По умолчанию используется модуль user-authn. Также можно настроить аутентификацию через externalAuthentication (см. ниже). Если эти варианты отключены, то модуль включит basic auth со сгенерированным паролем.

Посмотреть сгенерированный пароль можно командой:

d8 k -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module values upmeter -o json | jq '.upmeter.internal.auth.webui.password'

Чтобы сгенерировать новый пароль, нужно удалить Secret:

d8 k -n d8-upmeter delete secret/basic-auth-webui

Посмотреть сгенерированный пароль для страницы статуса можно командой:

d8 k -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module values upmeter -o json | jq '.upmeter.internal.auth.status.password'

Чтобы сгенерировать новый пароль для страницы статуса, нужно удалить секрет:

d8 k -n d8-upmeter delete secret/basic-auth-status

Внимание. Параметры auth.status.password и auth.webui.password больше не поддерживаются.

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

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

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

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

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

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

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

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

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

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

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

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

Пример:

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

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

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

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

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

Для смены канала обновлений модуля воспользуйтесь инструкцией.

Требования

К версии Deckhouse: 1.73.0 и выше.

Конверсии

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

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

Удалите поля .auth.status.password и .auth.webui.password. Если объекты .auth.status или .auth.webui становятся пустыми, удалите их. Если объект .auth становится пустым, удалите его.

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

Удалите поле .smokeMini.ingressClass. Если объект .smokeMini становится пустым, удалите его.

Параметры

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

settings
объект
- settings.auth
  
  объект
  Доступ к веб-интерфейсу.
  
  По умолчанию: {}
  - settings.auth.status
    
    объект
    Обязательный параметр
    
    Настройки доступа к веб-интерфейсу.
    
    По умолчанию: {}
    - settings.auth.status.allowedUserEmails
      
      массив строк
      Массив адресов электронной почты, пользователям которых разрешен доступ к веб-интерфейсу.
      
      Используется, если включен модуль user-authn или задан параметр externalAuthentication.
    - settings.auth.status.allowedUserGroups
      
      массив строк
      Группы доступа к просмотру интерфейса приложения.
      
      Используется, если включен модуль user-authn или параметр externalAuthentication.
      
      Внимание! При использовании совместно с модулем user-authn необходимо также добавить разрешенные группы в соответствующее поле в настройках DexProvider.
    - settings.auth.status.externalAuthentication
      
      объект
      Параметры для подключения внешней аутентификации (используется механизм Ingress NGINX external-auth, работающий на основе модуля NGINX auth_request.
      
      Внешняя аутентификация включается автоматически, если включен модуль user-authn.
      - settings.auth.status.externalAuthentication.authSignInURL
        
        строка
        URL, куда будет перенаправлен пользователь для прохождения аутентификации (если сервис аутентификации вернул код ответа HTTP, отличный от 200).
      - settings.auth.status.externalAuthentication.authURL
        
        строка
        URL сервиса аутентификации. Если пользователь прошел аутентификацию, сервис должен возвращать код ответа HTTP 200.
    - settings.auth.status.whitelistSourceRanges
      
      массив строк
      Список адресов в формате CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.
      
      Пример:
      
      whitelistSourceRanges: - 1.1.1.1/32
  - settings.auth.webui
    
    объект
    Обязательный параметр
    
    Настройки доступа к веб-интерфейсу.
    
    По умолчанию: {}
    - settings.auth.webui.allowedUserEmails
      
      массив строк
      Массив адресов электронной почты, пользователям которых разрешен доступ к веб-интерфейсу.
      
      Используется, если включен модуль user-authn или задан параметр externalAuthentication.
    - settings.auth.webui.allowedUserGroups
      
      массив строк
      Группы доступа к просмотру интерфейса приложения.
      
      Используется, если включен модуль user-authn или параметр externalAuthentication.
      
      Внимание! При использовании совместно с модулем user-authn необходимо также добавить разрешенные группы в соответствующее поле в настройках DexProvider.
    - settings.auth.webui.externalAuthentication
      
      объект
      Параметры для подключения внешней аутентификации (используется механизм Ingress NGINX external-auth, работающий на основе модуля NGINX auth_request.
      
      Внешняя аутентификация включается автоматически, если включен модуль user-authn.
      - settings.auth.webui.externalAuthentication.authSignInURL
        
        строка
        URL, куда будет перенаправлен пользователь для прохождения аутентификации (если сервис аутентификации вернул код ответа HTTP, отличный от 200).
      - settings.auth.webui.externalAuthentication.authURL
        
        строка
        URL сервиса аутентификации. Если пользователь прошел аутентификацию, сервис должен возвращать код ответа HTTP 200.
    - settings.auth.webui.password
      
      строка
      Password for http authorization of the admin user. It is generated automatically, but you can change it.
      
      This parameter is used if the externalAuthentication is not enabled.
    - settings.auth.webui.whitelistSourceRanges
      
      массив строк
      Список адресов в формате CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.
      
      Пример:
      
      whitelistSourceRanges: - 1.1.1.1/32
- settings.disabledProbes
  
  массив строк
  Массив строк из названий групп или определенных проб из группы. Названия можно подсмотреть в веб-интерфейсе.
  
  Пример:
  disabledProbes: - "synthetic/api" # Отключить отдельную пробу. - "synthetic/" # Отключить группу проб. - control-plane # Или без /.
  По умолчанию: []
- settings.https
  
  объект
  Тип сертификата, используемого для веб-приложений webui и status.
  
  При использовании этого параметра полностью переопределяются глобальные настройки global.modules.https.
  
  Примеры:
  customCertificate: secretName: foobar mode: CustomCertificate
  certManager: clusterIssuerName: letsencrypt mode: CertManager
  - settings.https.certManager
    
    объект
    - settings.https.certManager.clusterIssuerName
      
      строка
      ClusterIssuer, используемый для webui/status.
      
      Доступны letsencrypt, letsencrypt-staging, selfsigned, но вы можете определить свои.
      
      По умолчанию: letsencrypt
  - settings.https.customCertificate
    
    объект
    
    По умолчанию: {}
    - settings.https.customCertificate.secretName
      
      строка
      Имя Secret’а в пространстве имен d8-system, который будет использоваться для webui/status.
      
      Secret должен быть в формате TLS.
      
      По умолчанию: false
  - settings.https.mode
    
    строка
    Режим работы HTTPS:
    
    Disabled — webui/status будут работать только по HTTP;
    
    CertManager — webui/status будут работать по HTTPS и заказывать сертификат с помощью ClusterIssuer, заданного в параметре certManager.clusterIssuerName;
    
    CustomCertificate — webui/status будут работать по HTTPS, используя сертификат из namespace d8-system;
    
    OnlyInURI — webui/status будет работать по HTTP (подразумевая, что перед ними стоит внешний балансировщик, который терминирует HTTPS) и все ссылки в user-authn будут генерироваться с HTTPS-схемой. Балансировщик должен обеспечивать перенаправление с HTTP на HTTPS.
    По умолчанию: Disabled
    
    Допустимые значения: Disabled, CertManager, CustomCertificate, OnlyInURI
- settings.ingressClass
  
  строка
  Класс Ingress-контроллера, который используется для Upmeter.
  
  Опциональный параметр, по умолчанию используется глобальное значение modules.ingressClass
  
  Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- settings.nodeSelector
  
  объект
  Структура, аналогичная spec.nodeSelector пода Kubernetes.
  
  Если значение не указано или указано false, будет использоваться автоматика.
  
  Пример:
  disktype: ssd
- settings.registry
  
  объект
  
  По умолчанию: {}
  - settings.registry.dockercfg
    
    строка
    Base64-encoded .dockerconfigjson for pulling module images. If empty, global.modulesImages.registry.dockercfg is used.
- settings.smokeMini
  
  объект
  Configuration of authentication for smoke-mini.
  
  По умолчанию: {}
  - settings.smokeMini.auth
    
    объект
    Обязательный параметр
    
    Настройки доступа к веб-интерфейсу.
    
    По умолчанию: {}
    - settings.smokeMini.auth.allowedUserGroups
      
      массив строк
      Группы доступа к просмотру интерфейса приложения.
      
      Используется, если включен модуль user-authn или параметр externalAuthentication.
      
      Внимание! При использовании совместно с модулем user-authn необходимо также добавить разрешенные группы в соответствующее поле в настройках DexProvider.
    - settings.smokeMini.auth.externalAuthentication
      
      объект
      Параметры для подключения внешней аутентификации. Используется механизм Ingress NGINX external-auth, работающей на основе модуля NGINX auth_request.
      - settings.smokeMini.auth.externalAuthentication.authSignInURL
        
        строка
        URL, куда будет перенаправлен пользователь для прохождения аутентификации (если сервис аутентификации вернул код ответа HTTP, отличный от 200).
      - settings.smokeMini.auth.externalAuthentication.authURL
        
        строка
        URL сервиса аутентификации. Если пользователь прошел аутентификацию, сервис должен возвращать код ответа HTTP 200.
    - settings.smokeMini.auth.password
      
      строка
      Пароль для HTTP-авторизации для пользователя admin (генерируется автоматически, но можно менять)
      
      Используется, если не включен параметр externalAuthentication.
    - settings.smokeMini.auth.whitelistSourceRanges
      
      массив строк
      Список адресов в формате CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.
      
      Пример:
      
      whitelistSourceRanges: - 1.1.1.1/32
  - settings.smokeMini.https
    
    объект
    Тип сертификата, используемого для smoke-mini.
    
    При использовании этого параметра полностью переопределяются глобальные настройки global.modules.https.
    
    Примеры:
    customCertificate: secretName: foobar mode: CustomCertificate
    certManager: clusterIssuerName: letsencrypt mode: CertManager
    - settings.smokeMini.https.certManager
      
      объект
      - settings.smokeMini.https.certManager.clusterIssuerName
        
        строка
        ClusterIssuer, используемый для smoke-mini.
        
        Доступны letsencrypt, letsencrypt-staging, selfsigned, но вы можете определить свои.
        
        По умолчанию: letsencrypt
    - settings.smokeMini.https.customCertificate
      
      объект
      
      По умолчанию: {}
      - settings.smokeMini.https.customCertificate.secretName
        
        строка
        Имя Secret’а в namespace d8-system, который будет использоваться для smoke-mini.
        
        Secret должен быть в формате TLS.
        
        По умолчанию: false
    - settings.smokeMini.https.mode
      
      строка
      Режим работы HTTPS:
      
      Disabled — smoke-mini будут работать только по HTTP;
      
      CertManager — smoke-mini будут работать по HTTPS и заказывать сертификат с помощью ClusterIssuer, заданного в параметре certManager.clusterIssuerName.
      
      CustomCertificate — smoke-mini будут работать по HTTPS, используя сертификат из namespace d8-system.
      
      OnlyInURI — smoke-mini будет работать по HTTP (подразумевая, что перед ними стоит внешний балансировщик, который терминирует HTTPS) и все ссылки в user-authn будут генерироваться с HTTPS-схемой. Балансировщик должен обеспечивать перенаправление с HTTP на HTTPS.
      
      По умолчанию: Disabled
      
      Допустимые значения: Disabled, CertManager, CustomCertificate, OnlyInURI
  - settings.smokeMini.storageClass
    
    StorageClass для использования при проверке работоспособности дисков.
    
    Если значение не указано, то будет использоваться StorageClass, согласно настройке глобального параметра storageClass.
    
    Настройка глобального параметра storageClass учитывается только при включении модуля. Изменение глобального параметра storageClass при включенном модуле не приведет к перезаказу диска.
    
    Если указать false, будет принудительно использоваться emptyDir.
    
    Внимание. Если указать значение, отличное от текущего (используемого в существующей PVC), диск будет перезаказан, и все данные удалятся.
    
    Внимание. При переносе Upmeter с локальным хранилищем на другие узлы, поды зависнут в состоянии Pending. В этом случае будет необходимо сохранить базу данных Upmeter, удалить старые PVC и перезапустить под вручную. Под локальным хранилищем подразумевается StorageClass, связанный не с сетевым хранилищем, а с локальным томом на узле (например, StorageClass, создаваемый модулем local-path-provisioner).
    
    По умолчанию: false
    
    Примеры:
    storageClass: false
    storageClass: default
- settings.smokeMiniDisabled
  
  булевый
  Выключение smokeMini. Также отключает группу “synthetic”.
  
  По умолчанию: false
- settings.statusPageAuthDisabled
  
  булевый
  Выключение авторизации для status-домена.
  
  По умолчанию: false
- settings.storageClass
  
  Имя StorageClass для хранения данных Upmeter (PVC).
  
  Если значение не указано, используется StorageClass существующей PVC. Если PVC нет, будет использоваться StorageClass, согласно настройке глобального параметра storageClass.
  
  Настройка глобального параметра storageClass учитывается только при включении модуля. Изменение глобального параметра storageClass при включенном модуле не приведет к перезаказу диска.
  
  Если указать false, будет принудительно использоваться emptyDir.
  
  Внимание. Если указать значение, отличное от текущего (используемого в существующей PVC), диск будет перезаказан, и все данные удалятся.
  
  Внимание. При переносе Upmeter с локальным хранилищем на другие узлы, поды зависнут в состоянии Pending. В этом случае будет необходимо сохранить базу данных Upmeter, удалить старые PVC и перезапустить под вручную. Под локальным хранилищем подразумевается StorageClass, связанный не с сетевым хранилищем, а с локальным томом на узле (например, StorageClass, создаваемый модулем local-path-provisioner).
  
  Примеры:
  storageClass: false
  storageClass: default
- settings.tolerations
  
  массив объектов
  Структура, аналогичная spec.tolerations пода Kubernetes.
  
  Если значение не указано или указано false, будет использоваться автоматика.
  
  Пример:
  tolerations: - effect: NoSchedule key: key1 operator: Equal value: value1
  - settings.tolerations.effect
    
    строка
  - settings.tolerations.key
    
    строка
  - settings.tolerations.operator
    
    строка
  - settings.tolerations.tolerationSeconds
    
    целочисленный
  - settings.tolerations.value
    
    строка

Мониторинг SLA кластера: настройки

Аутентификация

Требования

Конверсии

Параметры

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

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

Мониторинг SLA кластера: настройки

Аутентификация

Требования

Конверсии

Параметры

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

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

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

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

Ошибка

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

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

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

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

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

Ошибка

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

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

Ошибка

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

Спасибо

Ошибка

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

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

Ошибка