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

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

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

Перед включением модуля необходимо разрешить использование экспериментальных модулей в ModuleConfig deckhouse. Для этого установите параметр allowExperimentalModules в true.

Модуль выключен по умолчанию. Чтобы включить его, создайте ModuleConfig infra-provider-baremetal и задайте в нём параметр nodes.parameters.ironic. Пока параметр не задан, компоненты модуля не запускаются.

Выбор режима работы Ironic и порядок настройки описаны на странице «Использование».

Модуль не включен по умолчанию в каком-либо наборе модулей.

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

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

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

    Пример:

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

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

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

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

    d8 system module enable infra-provider-baremetal
    
  • С помощью ModuleConfig infra-provider-baremetal.

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

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

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: infra-provider-baremetal
    spec:
      enabled: true
    

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

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

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

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

    Пример:

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

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

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

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

    d8 k edit mc infra-provider-baremetal
    

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

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

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

    d8 k apply -f <FILENAME>
    

    Пример файла манифеста ModuleConfig infra-provider-baremetal:

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

Требования

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

Параметры

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

  • settings
    объект
    • settings.nodes
      объект

      Настройки создания узлов кластера на физических серверах.

      • settings.nodes.parameters
        объект

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

        Параметры создания узлов кластера на физических серверах.

        • settings.nodes.parameters.ironic
          объект

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

          Настройки сервиса Ironic, с помощью которого модуль управляет серверами и устанавливает на них операционную систему.

          Чтобы подключиться к Ironic, развёрнутому вне кластера, задайте параметр externalInstance. Чтобы развернуть Ironic в кластере, задайте параметры provisioningNetwork и dhcp.

          • settings.nodes.parameters.ironic.bmcProbeTimeoutSeconds
            целочисленный

            Тайм-аут одной проверки протокола при подключении к контроллеру управления сервером (BMC), в секундах.

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

            Допустимые значения: 1 <= X <= 300

          • settings.nodes.parameters.ironic.dhcp
            объект

            Параметры DHCP в сети подготовки серверов.

            Задайте один из параметров internal или external.

            • settings.nodes.parameters.ironic.dhcp.external
              объект

              Параметры внешнего DHCP-сервера в сети подготовки серверов.

              Модуль не разворачивает DHCP-сервер и не настраивает внешний. Настройте загрузку серверов по PXE на внешнем DHCP-сервере самостоятельно.

              • settings.nodes.parameters.ironic.dhcp.external.pxeBootFile
                объект

                Имена загрузочных файлов, заданные на внешнем DHCP-сервере.

                • settings.nodes.parameters.ironic.dhcp.external.pxeBootFile.bios
                  строка

                  Имя загрузочного файла для серверов в режиме legacy BIOS.

                  Длина: 1..1024

                • settings.nodes.parameters.ironic.dhcp.external.pxeBootFile.uefi
                  строка

                  Имя загрузочного файла для серверов в режиме UEFI.

                  Длина: 1..1024

              • settings.nodes.parameters.ironic.dhcp.external.pxeBootServer
                строка

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

                IPv4-адрес PXE-сервера, который внешний DHCP-сервер передаёт серверам.

            • settings.nodes.parameters.ironic.dhcp.internal
              объект

              Параметры встроенного DHCP-сервера, который Ironic запускает в сети подготовки серверов.

              • settings.nodes.parameters.ironic.dhcp.internal.disableDNS
                булевый

                Отключает встроенный DNS-сервер и передачу адреса DNS-сервера через DHCP.

                По умолчанию DHCP передаёт dnsAddress, если он задан. Иначе Ironic предоставляет DNS и пересылает запросы с помощью резолвера своего pod.

                Задайте true для изолированной сети подготовки серверов, в которой DNS не требуется.

                При значении true нельзя использовать вместе с параметром dnsAddress.

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

              • settings.nodes.parameters.ironic.dhcp.internal.dnsAddress
                строка

                Адрес DNS-сервера, который DHCP-сервер передаёт серверам.

                Нельзя использовать, если параметр disableDNS имеет значение true.

              • settings.nodes.parameters.ironic.dhcp.internal.gatewayAddress
                строка

                Адрес шлюза по умолчанию, который DHCP-сервер передаёт серверам.

              • settings.nodes.parameters.ironic.dhcp.internal.networkCIDR
                строка

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

                Подсеть сети подготовки серверов в формате CIDR.

              • settings.nodes.parameters.ironic.dhcp.internal.rangeBegin
                строка

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

                Первый IPv4-адрес диапазона, из которого DHCP-сервер выдаёт адреса серверам.

              • settings.nodes.parameters.ironic.dhcp.internal.rangeEnd
                строка

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

                Последний IPv4-адрес диапазона, из которого DHCP-сервер выдаёт адреса серверам.

          • settings.nodes.parameters.ironic.externalInstance
            объект

            Параметры подключения к Ironic, развёрнутому вне кластера.

            Если параметр задан, модуль не разворачивает Ironic и DHCP-сервер. Нельзя использовать вместе с параметрами provisioningNetwork, dhcp, ramdiskImageRef, ipxeFirmwareRef и provisioningTLS.

            • settings.nodes.parameters.ironic.externalInstance.credentialsRef
              объект

              Ссылка на секрет с учётными данными API внешнего Ironic.

              Секрет должен содержать ключ identity с именем пользователя и ключ secret с паролем.

              • settings.nodes.parameters.ironic.externalInstance.credentialsRef.kind
                строка

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

                Тип ресурса с учётными данными API внешнего Ironic.

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

              • settings.nodes.parameters.ironic.externalInstance.credentialsRef.name
                строка

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

                Имя секрета с учётными данными API внешнего Ironic.

                Длина: 1..253

              • settings.nodes.parameters.ironic.externalInstance.credentialsRef.namespace
                строка

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

                Неймспейс секрета с учётными данными API внешнего Ironic.

                Поддерживается только неймспейс d8-infra-provider-baremetal.

                Шаблон: ^d8-infra-provider-baremetal$

            • settings.nodes.parameters.ironic.externalInstance.endpoint
              строка

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

              URL-адрес API внешнего Ironic.

              URL-адрес должен заканчиваться на /v1 или /v1/ и быть доступен из кластера.

              Шаблон: ^https?://.+/v1/?$

              Максимальная длина: 2048

            • settings.nodes.parameters.ironic.externalInstance.tls
              объект

              Параметры TLS для подключения к внешнему Ironic.

              • settings.nodes.parameters.ironic.externalInstance.tls.caCertRef
                объект

                Ссылка на ключ секрета с сертификатом CA, которым выпущен сертификат API внешнего Ironic.

                • settings.nodes.parameters.ironic.externalInstance.tls.caCertRef.key
                  строка

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

                  Ключ секрета, в котором хранится сертификат CA внешнего Ironic.

                  Длина: 1..253

                • settings.nodes.parameters.ironic.externalInstance.tls.caCertRef.kind
                  строка

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

                  Тип ресурса с сертификатом CA внешнего Ironic.

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

                • settings.nodes.parameters.ironic.externalInstance.tls.caCertRef.name
                  строка

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

                  Имя секрета с сертификатом CA внешнего Ironic.

                  Длина: 1..253

                • settings.nodes.parameters.ironic.externalInstance.tls.caCertRef.namespace
                  строка

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

                  Неймспейс секрета с сертификатом CA внешнего Ironic.

                  Поддерживается только неймспейс d8-infra-provider-baremetal.

                  Шаблон: ^d8-infra-provider-baremetal$

              • settings.nodes.parameters.ironic.externalInstance.tls.clientCertRef
                объект

                Ссылка на секрет с клиентским сертификатом и закрытым ключом для взаимной TLS-аутентификации.

                • settings.nodes.parameters.ironic.externalInstance.tls.clientCertRef.certKey
                  строка

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

                  Ключ секрета, в котором хранится клиентский сертификат.

                  Длина: 1..253

                • settings.nodes.parameters.ironic.externalInstance.tls.clientCertRef.kind
                  строка

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

                  Тип ресурса с клиентским сертификатом.

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

                • settings.nodes.parameters.ironic.externalInstance.tls.clientCertRef.name
                  строка

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

                  Имя секрета с клиентским сертификатом и закрытым ключом.

                  Длина: 1..253

                • settings.nodes.parameters.ironic.externalInstance.tls.clientCertRef.namespace
                  строка

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

                  Неймспейс секрета с клиентским сертификатом и закрытым ключом.

                  Поддерживается только неймспейс d8-infra-provider-baremetal.

                  Шаблон: ^d8-infra-provider-baremetal$

                • settings.nodes.parameters.ironic.externalInstance.tls.clientCertRef.privateKey
                  строка

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

                  Ключ секрета, в котором хранится закрытый ключ клиента.

                  Длина: 1..253

              • settings.nodes.parameters.ironic.externalInstance.tls.insecure
                булевый

                Отключает проверку сертификата API внешнего Ironic.

                Не используйте в production-окружении.

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

          • settings.nodes.parameters.ironic.ipxeFirmwareRef
            объект

            Ссылка на ресурс BareMetalIPXEFirmware с прошивками iPXE для загрузки серверов по TLS.

            Используется только вместе с параметром provisioningTLS. Если параметр задан без provisioningTLS, модуль не создаёт Ironic.

            • settings.nodes.parameters.ironic.ipxeFirmwareRef.kind
              строка

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

              Тип ресурса с прошивками iPXE.

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

            • settings.nodes.parameters.ironic.ipxeFirmwareRef.name
              строка

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

              Имя ресурса BareMetalIPXEFirmware.

              Длина: 1..253

          • settings.nodes.parameters.ironic.provisioningNetwork
            объект

            Параметры сети подготовки серверов, в которой серверы загружаются по PXE.

            Используется, только если модуль разворачивает Ironic в кластере.

            • settings.nodes.parameters.ironic.provisioningNetwork.interface
              строка

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

              Имя сетевого интерфейса, подключённого к сети подготовки серверов, на узле, где запущен Ironic.

              Шаблон: ^[A-Za-z0-9_.:-]{1,15}$

            • settings.nodes.parameters.ironic.provisioningNetwork.ipAddress
              строка

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

              Свободный IPv4-адрес в сети подготовки серверов.

              Ironic назначает этот адрес интерфейсу из параметра interface и принимает на нём подключения серверов.

          • settings.nodes.parameters.ironic.provisioningTLS
            объект

            Включает TLS для API Ironic и для загрузки файлов серверами.

            Поддерживается только со встроенным DHCP-сервером (dhcp.internal). Требует параметров ramdiskImageRef и ipxeFirmwareRef. Модуль создаёт Ironic, только когда секрет и ресурсы из этих параметров готовы.

            • settings.nodes.parameters.ironic.provisioningTLS.certificateRef
              объект

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

              Ссылка на секрет с TLS-сертификатом Ironic в неймспейсе d8-infra-provider-baremetal.

              Секрет должен иметь тип kubernetes.io/tls, содержать ключи tls.crt, tls.key и ca.crt и иметь лейбл environment.metal3.io/ironic-standalone-operator: "true".

              • settings.nodes.parameters.ironic.provisioningTLS.certificateRef.name
                строка

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

                Имя секрета с TLS-сертификатом Ironic.

                Длина: 1..253

          • settings.nodes.parameters.ironic.ramdiskImageRef
            объект

            Ссылка на ресурс BareMetalRamdiskImage с образом Ironic Python Agent (IPA) для загрузки серверов.

            Если параметр не задан, используется встроенный образ IPA. Параметр обязателен, если задан параметр provisioningTLS.

            • settings.nodes.parameters.ironic.ramdiskImageRef.kind
              строка

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

              Тип ресурса с образом IPA.

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

            • settings.nodes.parameters.ironic.ramdiskImageRef.name
              строка

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

              Имя ресурса BareMetalRamdiskImage.

              Длина: 1..253