Модуль deckhouse: настройки

Доступно в редакциях: CE, BE, SE, SE+, EE, CSE Lite (1.67), CSE Pro (1.67)

Модуль включен по умолчанию в наборах модулей: Default, Managed, Minimal.

Чтобы явно включить или выключить модуль deckhouse, установите spec.enabled в true или false в ModuleConfig/deckhouse (создайте, при необходимости), или воспользуйтесь командой deckhouse-controller module в поде d8-system/deckhouse.

Пример включения модуля:

с помощью ресурса ModuleConfig:

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

с помощью команды deckhouse-controller (требуется kubectl, настроенный на работу с кластером):
```
kubectl -ti -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module enable deckhouse
```

Пример выключения модуля:

с помощью ресурса ModuleConfig:

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

с помощью команды deckhouse-controller (требуется kubectl, настроенный на работу с кластером):
```
kubectl -ti -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module disable deckhouse
```

Настройки

Чтобы настроить модуль, используйте ресурс ModuleConfig с именем deckhouse (подробнее о настройке Deckhouse…).

Пример ресурса ModuleConfig/deckhouse для настройки модуля:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: deckhouse
spec:
  version: 1
  enabled: true
  settings: # <-- Параметры модуля из раздела "Параметры" ниже.

Параметры

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

settings
объект
- settings.allowExperimentalModules
  булевый
  Разрешает использование экспериментальных модулей (модули на стадии жизненного цикла Experimental).
  
  Экспериментальные модули могут быть нестабильными и не поддерживаются в рамках SLA Deckhouse. Используйте их с осторожностью.
  
  Пример:
  allowExperimentalModules: false
- settings.bundle
  строка
  Набор модулей Deckhouse. Определяет включенные по умолчанию модули:
  - Default — рекомендованный набор модулей для работы кластера: мониторинга, контроля авторизации, организации работы сети и других потребностей.
  - Managed — набор для managed-кластеров от облачных провайдеров (например, Google Kubernetes Engine).
  - Minimal — минимально возможный набор, который включает единственный модуль (этот). Обратите внимание, что в набор модулей Minimal не включен ряд базовых модулей (например, модуль работы с CNI). Deckhouse с набором модулей Minimal без включения базовых модулей сможет работать только в уже развернутом кластере.
  По умолчанию: Default
  Допустимые значения: Default, Minimal, Managed
  Пример:
  bundle: Default
- settings.highAvailability
  булевый
  Ручное управление режимом отказоустойчивости.
  
  По умолчанию режим отказоустойчивости определяется автоматически. Подробнее про режим отказоустойчивости.
  
  Пример:
  highAvailability: true
- settings.license
  объект
  Настройки редакции Deckhouse Kubernetes Platform.
  - settings.license.edition
    строка
    Редакция Deckhouse Kubernetes Platform.
    
    CE — Community Edition.
    
    BE — Basic Edition.
    
    EE — Enterprise Edition.
    
    SE — Standard Edition.
    
    SE-plus — Standard Edition+.
    По умолчанию: CE
    Пример:
    edition: CE
- settings.logLevel
  строка
  Уровень логирования Deckhouse.
  
  По умолчанию: Info
  Допустимые значения: Debug, Info, Error
  Пример:
  logLevel: Info
- settings.nodeSelector
  объект
  Структура, аналогичная spec.nodeSelector пода Kubernetes.
  
  Если значение не указано или указано false, nodeSelector будет определяться автоматически.
  
  Внимание. Deckhouse перестанет работать, если в nodeSelector указать несуществующий лейбл. Для восстановления работоспособности необходимо изменить значения на правильные в ModuleConfig/deckhouse и deployment/deckhouse.
- settings.registry
  объект
  Настройки для доступа к хранилищу образов контейнеров (container registry) с образами Deckhouse.
  
  Этот параметр позволяет настроить, как Deckhouse будет подключаться к container registry для загрузки образов своих компонентов. Вы можете либо положиться на предварительно настроенный доступ на узлах кластера (режим Unmanaged), либо предоставить Deckhouse прямые учетные данные для доступа (режим Direct).
  
  Примеры:
  registry: mode: Unmanaged
  registry: mode: Direct direct: imagesRepo: registry.deckhouse.io/deckhouse/ee license: DECKHOUSE_LICENSE_KEY
  - settings.registry.direct
    объект
    Параметры для режима доступа Direct. Эти параметры обязательны, если mode установлен в Direct.
    
    Примеры:
    direct: imagesRepo: registry.deckhouse.io/deckhouse/ee license: DECKHOUSE_LICENSE_KEY
    direct: imagesRepo: my-private-registry.com/deckhouse username: user password: password scheme: HTTPS ca: | -----BEGIN CERTIFICATE----- MIIC... -----END CERTIFICATE-----
    - settings.registry.direct.ca
      строка
      Корневой сертификат центра сертификации (CA) в формате PEM для проверки серверного сертификата container registry.
      
      Параметр необходимо указывать, если container registry использует самоподписанный сертификат или сертификат, выданный частным центром сертификации.
      
      Если параметр не указан, будут использоваться сертификаты, определенные в хранилище корневых сертификатов узла.
    - settings.registry.direct.imagesRepo
      строка
      Обязательный параметр
      Адрес репозитория в container registry, где хранятся образы Deckhouse. В изолированных средах это может быть адрес частного registry, который зеркалирует публичный.
      
      Шаблон: ^[0-9a-zA-Z\.\-]+(\:[0-9]{1,5})?(\/[0-9a-zA-Z\.\-\_\/]+)?$
      Примеры:
      
      imagesRepo: registry.deckhouse.io/deckhouse/ee
      
      imagesRepo: private-registry:5000/deckhouse/ce
    - settings.registry.direct.license
      строка
      Лицензионный ключ для доступа к container registry Deckhouse. Этот ключ используется в качестве пароля с именем пользователя license-token. Это поле является взаимоисключающим с username/password.
      
      Пример:
      license: DECKHOUSE_LICENSE_KEY
    - settings.registry.direct.password
      строка
      Пароль для аутентификации в container registry.
      
      Параметр обязателен, если не указан параметр license.
      
      Пример:
      password: registry-password
    - settings.registry.direct.scheme
      строка
      Протокол для подключения к container registry.
      
      Используйте HTTP только для небезопасных, доверенных container registry (например, в изолированной среде). По умолчанию используется HTTPS.
      
      По умолчанию: HTTPS
      Допустимые значения: HTTP, HTTPS
      Пример:
      scheme: HTTPS
    - settings.registry.direct.username
      строка
      Имя пользователя для аутентификации в реестре контейнеров. Это поле обязательно, если не предоставлен license.
      
      Пример:
      username: registry-user
  - settings.registry.mode
    строка
    Режим доступа к container registry с образами Deckhouse.
    
    Unmanaged — режим по умолчанию. В этом режиме модуль registry не запускает внутренний registry. Доступ к registry настраивается вручную с помощью helper-скрипта change-registry. Внимание: изменение registry в этом режиме приведет к полному перезапуску всех компонентов Deckhouse.
    
    Direct — режим прямого доступа к registry. Используется «виртуальный» адрес registry, который «на лету» подменяется на реальный. Это позволяет изменять registry без полного перезапуска компонентов.
    По умолчанию: Direct
    Допустимые значения: Unmanaged, Direct
- settings.releaseChannel
  строка
  Желаемый канал обновлений Deckhouse (переключение на него произойдет при появлении такой возможности).
  
  Порядок возрастания стабильности канала обновлений (от наименее стабильного к наиболее стабильному): Alpha, Beta, EarlyAccess, Stable, RockSolid.
  
  Допустимые значения: Alpha, Beta, EarlyAccess, Stable, RockSolid
  Пример:
  releaseChannel: Stable
- settings.tolerations
  массив объектов
  Структура, аналогичная spec.tolerations пода Kubernetes.
  
  Если значение не указано или указано false, tolerations будет определяться автоматически.
  
  Внимание. Deckhouse перестанет работать, если указать некорректные tolerations. Для восстановления работоспособности необходимо изменить значения на корректные в ModuleConfig/deckhouse и deployment/deckhouse.
  - settings.tolerations.effect
    строка
  - settings.tolerations.key
    строка
  - settings.tolerations.operator
    строка
  - settings.tolerations.tolerationSeconds
    целочисленный
  - settings.tolerations.value
    строка
- settings.update
  объект
  Настройки режима и окон обновления Deckhouse.
  
  Пример:
  update: windows: - from: '8:00' to: '15:00' days: - Tue - Sat disruptionApprovalMode: Manual notification: webhook: https://release-webhook.mydomain.com minimalNotificationTime: 6h auth: basic: username: user password: password
  - settings.update.disruptionApprovalMode
    Параметр устарел
    строка
    Режим обновления версий Deckhouse, имеющих изменения, которые могут привести к кратковременному простою в работе системных компонентов:
    
    Auto — автоматический режим обновления.
    
    Manual — ручной режим обновления. Для применения обновления нужно установить аннотацию release.deckhouse.io/disruption-approved=true на соответствующий ресурс DeckhouseRelease.
    По умолчанию: Auto
    Допустимые значения: Auto, Manual
  - settings.update.mode
    строка
    Режим обновления Deckhouse на выбранном канале обновлений.
    
    AutoPatch — автоматический режим обновления для патч-версий.
    
    Для обновления минорной версии (например, с v1.69.* на v1.70.*) необходимо подтверждение.
    
    Обновление патч-версии (например, с v1.70.1 на v1.70.2) применяется с учетом окон обновлений, если они заданы.
    
    Auto — автоматический режим обновления для всех версий.
    
    Обновления минорной версии (например, с v1.69.* на v1.70.*) и патч-версии (например, с v1.70.1 на v1.70.2) применяются с учетом заданных окон обновлений, либо, если окна обновлений не заданы, по мере появления обновлений на соответствующем канале обновлений.
    
    Manual — ручной режим обновления для всех версий.
    
    Для обновления и минорной, и патч-версии необходимо подтверждение.
    
    Для подтверждения обновления версии установите поле approved в true в соответствующем ресурсе DeckhouseRelease необходимо установить поле approved в true.
    
    Выбранный режим обновления применяется только при установленном канале обновлений.
    По умолчанию: AutoPatch
    Допустимые значения: AutoPatch, Auto, Manual
  - settings.update.notification
    объект
    Настройка оповещений о запланированном обновлении Deckhouse.
    
    Имеет эффект только при установленном автоматическом режиме обновлений.
    
    Пример:
    notification: webhook: https://release-webhook.mydomain.com minimalNotificationTime: 8h retryMinTime: 2s
    - settings.update.notification.auth
      объект
      Структура, описывающая способ авторизации на вебхуке.
      
      Если не указано, авторизация не используется.
      - settings.update.notification.auth.basic
        объект
        Basic-аутентификация на вебхуке.
        
        settings.update.notification.auth.basic.password
        строка
        Обязательный параметр
        Пароль для авторизации на вебхуке.
        
        Имя и пароль пользователя будут в заголовке Authorization в формате Basic <base64(username:password)>.
        
        settings.update.notification.auth.basic.username
        строка
        Обязательный параметр
        Имя пользователя для авторизации на вебхуке.
        
        Имя и пароль пользователя будут в заголовке Authorization в формате Basic <base64(username:password)>.
      - settings.update.notification.auth.bearerToken
        строка
        Токен для авторизации на вебхуке.
        
        Токен будет в заголовке Authorization в формате Bearer <token>.
    - settings.update.notification.minimalNotificationTime
      строка
      Минимальное время, которое должно пройти перед обновлением с момента появления новой минорной версии Deckhouse на используемом канале обновлений.
      
      Задается в виде строки с указанием часов и минут: 30m, 1h, 2h30m, 24h.
      
      Механизм обновления гарантирует, что Deckhouse не обновится, пока не пройдет указанный период времени.
      
      При использовании окон обновлений обновление Deckhouse произойдет в ближайшее возможное окно обновлений, но не ранее чем истечет указанное в minimalNotificationTime время.
      
      Шаблон: ^([0-9]+h([0-9]+m)?|[0-9]+m)$
      Пример:
      minimalNotificationTime: 6h
    - settings.update.notification.releaseType
      строка
      Определяет тип версии, о которой будет отправлено оповещение:
      
      Minor — только для обновления минорной версии.
      
      All — для любых обновлений, включая обновление патч-версии.
      
      По умолчанию: Minor
      Допустимые значения: All, Minor
      Пример:
      releaseType: All
    - settings.update.notification.retryMinTime
      строка
      Минимальный интервал между повторными попытками вызова вебхука при неуспешном запросе.
      
      Задается в виде строки с указанием часов, минут или секунд: 30s, 1m, 2m30s, 1h, 2h30m.
      
      Повторные попытки выполняются с экспоненциальной задержкой: каждый следующий интервал в два раза больше предыдущего. Например, при retryMinTime = 2s задержки будут: 2s, 4s, 8s, 16s, 32s.
      
      По умолчанию — 2 секунды (если не указано).
      
      Шаблон: ^([0-9]+h([0-9]+m)?|[0-9]+m|[0-9]+s)$
      Пример:
      retryMinTime: 2s
    - settings.update.notification.tlsSkipVerify
      булевый
      Пропустить валидацию TLS-сертификата при запросе вебхука.
      
      По умолчанию: false
    - settings.update.notification.webhook
      строка
      URL-адрес вебхука.
      
      Вызов вебхука произойдет после появления новой минорной версии Deckhouse на используемом канале обновлений, но до момента ее применения в кластере.
      
      Внимание. При указании неверного адреса вебхука, обновление Deckhouse будет заблокировано.
      
      Используйте параметр minimalNotificationTime при необходимости установить минимальное время, которое должно пройти перед обновлением с момента появления новой минорной версии Deckhouse на используемом канале обновлений.
      
      На адрес вебхука выполняется POST-запрос с Content-Type: application/json. Пример содержания запроса:
      
      { "subject":"Deckhouse", "version": "1.36.0", "requirements": {"k8s": "1.20.0"}, "changelogLink": "https://github.com/deckhouse/deckhouse/changelog/1.36.md", "applyTime": "2023-01-01T14:30:00Z00:00", "message": "New Deckhouse Release 1.36.0 is available. Release will be applied at: Friday, 01-Jan-23 14:30:00 UTC" }
      
      Описание полей POST-запроса:
      
      subject — строка, тип события обновления. Возможные значения: Deckhouse, Module;
      
      moduleName — строка, имя модуля. Устанавливается только если subject: Module
      
      version — строка в формате x.y.z (семантическое версионирование);
      
      requirements — объект, требования к версии;
      
      changelogLink — строка, ссылка на список изменений (changelog) минорной версии;
      
      applyTime — строка, дата и время запланированного обновления (с учетом установленных окон обновлений) в формате RFC3339;
      
      message — строка, текстовое сообщение о доступности новой минорной версии и запланированном времени обновления.
      
      Шаблон: ^https?://[^\s/$.?#].[^\s]*$
      Пример:
      webhook: https://webhook.site/#!/bc8f71ac-c182-4181-9159-6ba6950afffa
  - settings.update.windows
    массив объектов
    Список окон обновлений в течение суток.
    - settings.update.windows.days
      массив строк
      Дни недели, в которые применяется окно обновлений.
      
      Пример:
      days: - Mon - Wed
      - Элемент массива
        строка
        День недели.
        
        Допустимые значения: Mon, Tue, Wed, Thu, Fri, Sat, Sun
        Пример:
        Mon
    - settings.update.windows.from
      строка
      Обязательный параметр
      Время начала окна обновления (в часовом поясе UTC).
      
      Должно быть меньше времени окончания окна обновления.
      
      Шаблон: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$
      Пример:
      from: '13:00'
    - settings.update.windows.to
      строка
      Обязательный параметр
      Время окончания окна обновления (в часовом поясе UTC).
      
      Должно быть больше времени начала окна обновления.
      
      Шаблон: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$
      Пример:
      to: '18:30'

Настройки

Параметры

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

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

Модуль deckhouse: настройки

Настройки

Параметры

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

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

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

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

Ошибка

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

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

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

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

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

Ошибка

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

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

Ошибка

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

Спасибо

Ошибка

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

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

Ошибка