Доступно в редакциях:  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:

    1apiVersion: deckhouse.io/v1alpha1
2kind: ModuleConfig
3metadata:
4  name: deckhouse
5spec:
6  enabled: true

  • с помощью команды deckhouse-controller (требуется kubectl, настроенный на работу с кластером):

    1kubectl -ti -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module enable deckhouse

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

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

    1apiVersion: deckhouse.io/v1alpha1
2kind: ModuleConfig
3metadata:
4  name: deckhouse
5spec:
6  enabled: false

  • с помощью команды deckhouse-controller (требуется kubectl, настроенный на работу с кластером):

    1kubectl -ti -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module disable deckhouse

Настройки

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

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

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

Параметры

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

  • settings
    объект
    • settings.bundle
      строка

      Набор модулей Deckhouse. Определяет включенные по умолчанию модули:

      • Default — рекомендованный набор модулей для работы кластера: мониторинга, контроля авторизации, организации работы сети и других потребностей.
      • Managed — набор для managed-кластеров от облачных провайдеров (например, Google Kubernetes Engine).
      • Minimal — минимально возможный набор, который включает единственный модуль (этот). Обратите внимание, что в набор модулей Minimal не включен ряд базовых модулей (например, модуль работы с CNI). Deckhouse с набором модулей Minimal без включения базовых модулей сможет работать только в уже развернутом кластере.

      По умолчанию: "Default"

      Допустимые значения: Default, Minimal, Managed

      Пример:

      1bundle: Default
    • settings.highAvailability
      булевый

      Ручное управление режимом отказоустойчивости.

      По умолчанию режим отказоустойчивости определяется автоматически. Подробнее про режим отказоустойчивости.

      Пример:

      1highAvailability: true
    • settings.logLevel
      строка

      Уровень логирования Deckhouse.

      По умолчанию: "Info"

      Допустимые значения: Debug, Info, Error

      Пример:

      1logLevel: Info
    • settings.nodeSelector
      объект

      Структура, аналогичная spec.nodeSelector пода Kubernetes.

      Если значение не указано или указано false, nodeSelector будет определяться автоматически.

      Внимание. Deckhouse перестанет работать, если в nodeSelector указать несуществующий лейбл. Для восстановления работоспособности необходимо изменить значения на правильные в ModuleConfig/deckhouse и deployment/deckhouse.

    • settings.releaseChannel
      строка

      Желаемый канал обновлений Deckhouse (переключение на него произойдет при появлении такой возможности).

      Порядок возрастания стабильности канала обновлений (от наименее стабильного к наиболее стабильному): Alpha, Beta, EarlyAccess, Stable, RockSolid.

      Допустимые значения: Alpha, Beta, EarlyAccess, Stable, RockSolid

      Пример:

      1releaseChannel: 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.

      Пример:

      1update:
2  windows:
3  - from: '8:00'
4    to: '15:00'
5    days:
6    - Tue
7    - Sat
8  disruptionApprovalMode: Manual
9  notification:
10    webhook: https://release-webhook.mydomain.com
11    minimalNotificationTime: 6h
12    auth:
13      basic:
14        username: user
15        password: password
      • settings.update.disruptionApprovalMode
        Параметр устарел
        строка

        Режим обновления версий Deckhouse, имеющих изменения, которые могут привести к кратковременному простою в работе системных компонентов:

        • Auto — автоматический режим обновления.
        • Manual — ручной режим обновления. Для применения обновления нужно установить аннотацию release.deckhouse.io/disruption-approved=true на соответствующий ресурс DeckhouseRelease.

        По умолчанию: "Auto"

        Допустимые значения: Auto, Manual

      • settings.update.mode
        строка

        Режим обновления Deckhouse на выбранном канале обновлений.

        • AutoPatch — автоматический режим обновления для патч-версий.

          Для обновления минорной версии (например, с v1.65.* на v1.66.*) необходимо подтверждение.

          Обновление патч-версии (например, с v1.65.1 на v1.65.4) применяется с учетом окон обновлений, если они заданы.

        • Auto — автоматический режим обновления для всех версий.

          Обновление минорной версии (например, с v1.65.* на v1.66.*) применяется с учетом окон обновлений, если они заданы.

          Обновление патч-версии (например, с v1.65.1 на v1.65.4) применяется без учета окон обновлений (сразу).

        • Manual — ручной режим обновления для всех версий.

          Для обновления и минорной, и патч-версии необходимо подтверждение.

        Для подтверждения обновления версии, в соответствующем ресурсе DeckhouseRelease необходимо установить поле approved в true.

        Выбранный режим обновления применяется только при установленном канале обновлений.

        По умолчанию: "AutoPatch"

        Допустимые значения: AutoPatch, Auto, Manual

      • settings.update.notification
        объект

        Настройка оповещений о запланированном обновлении Deckhouse.

        Имеет эффект только при установленном автоматическом режиме обновлений.

        Пример:

        1notification:
2  webhook: https://release-webhook.mydomain.com
3  minimalNotificationTime: 8h
        • settings.update.notification.auth
          объект

          Структура, описывающая способ авторизации на webhook.

          Если не указано, авторизация не используется.

          • settings.update.notification.auth.basic
            объект

            Basic-аутентификация на webhook.

            • settings.update.notification.auth.basic.password
              строка

              Обязательный параметр

              Пароль для авторизации на webhook.

              Имя и пароль пользователя будут в заголовке Authorization в формате Basic <base64(username:password)>.

            • settings.update.notification.auth.basic.username
              строка

              Обязательный параметр

              Имя пользователя для авторизации на webhook.

              Имя и пароль пользователя будут в заголовке Authorization в формате Basic <base64(username:password)>.

          • settings.update.notification.auth.bearerToken
            строка

            Токен для авторизации на webhook.

            Токен будет в заголовке Authorization в формате Bearer <token>.

        • settings.update.notification.minimalNotificationTime
          строка

          Минимальное время, которое должно пройти перед обновлением с момента появления новой минорной версии Deckhouse на используемом канале обновлений.

          Задается в виде строки с указанием часов и минут: 30m, 1h, 2h30m, 24h.

          Механизм обновления гарантирует, что Deckhouse не обновится, пока не пройдет указанный период времени.

          При использовании окон обновлений обновление Deckhouse произойдет в ближайшее возможное окно обновлений, но не ранее чем истечет указанное в minimalNotificationTime время.

          Шаблон: ^([0-9]+h([0-9]+m)?|[0-9]+m)$

          Пример:

          1minimalNotificationTime: 6h
        • settings.update.notification.releaseType
          строка

          Определяет тип версии, о которой будет отправлено оповещение:

          • Minor — только для обновления минорной версии.
          • All — для любых обновлений, включая обновление патч-версии.

          По умолчанию: "Minor"

          Допустимые значения: All, Minor

          Пример:

          1releaseType: All
        • settings.update.notification.tlsSkipVerify
          булевый

          Пропустить валидацию TLS-сертификата при запросе webhook.

          По умолчанию: false

        • settings.update.notification.webhook
          строка

          URL-адрес webhook’а.

          Вызов webhook’а произойдет после появления новой минорной версии Deckhouse на используемом канале обновлений, но до момента ее применения в кластере.

          Внимание! При указании неверного адреса webhook’а, обновление Deckhouse будет заблокировано.

          Используйте параметр minimalNotificationTime при необходимости установить минимальное время, которое должно пройти перед обновлением с момента появления новой минорной версии Deckhouse на используемом канале обновлений.

          На адрес webhook’а выполняется POST-запрос с Content-Type: application/json. Пример содержания запроса:

          1{
2  "subject":"Deckhouse",
3  "version": "1.36.0",
4  "requirements":  {"k8s": "1.20.0"},
5  "changelogLink": "https://github.com/deckhouse/deckhouse/changelog/1.36.md",
6  "applyTime": "2023-01-01T14:30:00Z00:00",
7  "message": "New Deckhouse Release 1.36.0 is available. Release will be applied at: Friday, 01-Jan-23 14:30:00 UTC"
8}

          Описание полей POST-запроса:

          • subject — строка, тип события обновления. Возможные значения: Deckhouse, Module;
          • moduleName — строка, имя модуля. Устанавливается только если subject: Module
          • version — строка в формате x.y.z (семантическое версионирование);
          • requirements — объект, требования к версии;
          • changelogLink — строка, ссылка на список изменений (changelog) минорной версии;
          • applyTime — строка, дата и время запланированного обновления (с учетом установленных окон обновлений) в формате RFC3339;
          • message — строка, текстовое сообщение о доступности новой минорной версии и запланированном времени обновления.

          Шаблон: ^https?://[^\s/$.?#].[^\s]*$

          Пример:

          1webhook: https://webhook.site/#!/bc8f71ac-c182-4181-9159-6ba6950afffa
      • settings.update.windows
        массив объектов

        Список окон обновлений в течение суток.

        • settings.update.windows.days
          массив строк

          Дни недели, в которые применяется окно обновлений.

          Пример:

          1days:
2- Mon
3- Wed
          • Элемент массива
            строка

            День недели.

            Допустимые значения: Mon, Tue, Wed, Thu, Fri, Sat, Sun

            Пример:

            1Mon
        • settings.update.windows.from
          строка

          Обязательный параметр

          Время начала окна обновления (в часовом поясе UTC).

          Должно быть меньше времени окончания окна обновления.

          Шаблон: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Пример:

          1from: '13:00'
        • settings.update.windows.to
          строка

          Обязательный параметр

          Время окончания окна обновления (в часовом поясе UTC).

          Должно быть больше времени начала окна обновления.

          Шаблон: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Пример:

          1to: '18:30'