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

Стадия жизненного цикла модуля: General Availability

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

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

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

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

    Пример:

    Интерфейс включения и выключения модуля

  • С помощью Deckhouse CLI (d8).

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

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

    d8 system module enable namespace-configurator
    
  • С помощью ModuleConfig namespace-configurator.

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

    Пример манифеста для включения модуля namespace-configurator:

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

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

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

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

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

    Пример:

    Интерфейс настройки модуля

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

  • С помощью Deckhouse CLI (d8) (требуется Deckhouse CLI (d8), настроенный на работу с кластером).

    Отредактируйте существующий ModuleConfig namespace-configurator (подробнее о настройке Deckhouse читайте в документации), выполнив следующую команду:

    d8 k edit mc namespace-configurator
    

    Внесите необходимые изменения в секцию spec.settings. При необходимости укажите версию схемы в параметре spec.version. Сохраните изменения.

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

    Примените манифест с помощью следующей команды (укажите имя файла манифеста):

    d8 k apply -f <FILENAME>
    

    Пример файла манифеста ModuleConfig namespace-configurator:

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

Параметры

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

  • settings
    объект
    • settings.configurations
      массив объектов
      • settings.configurations.annotations
        объект

        Список аннотаций в формате ключ: "значение".

        Пример:

        annotations:
          example: 'true'
        
      • settings.configurations.excludeNames
        массив строк

        Список шаблонов для исключения пространств имен.

        По умолчанию: []

        Пример:

        excludeNames:
        - infra-test
        
      • settings.configurations.includeNames
        массив строк

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

        Список шаблонов для включения пространств имен.

        По умолчанию: []

        Пример:

        includeNames:
        - prod-.*
        - infra-.*
        
      • settings.configurations.labels
        объект

        Список лейблов в формате ключ: "значение".

        Пример:

        labels:
          istio-injection: 'true'