Указание параметров установки с помощью мастера настройки

Для развертывания Open Single Management Platform на нескольких узлах и развертывания на одном узле необходимо подготовить конфигурационный файл, содержащий параметры установки компонентов приложения. Мастер настройки позволяет указать параметры установки, необходимые для развертывания Open Single Management Platform и сформировать итоговый конфигурационный файл. Необязательные параметры установки имеют значения по умолчанию, и их не следует указывать в мастере настройки. Вы можете вручную добавить эти параметры в конфигурационный файл, чтобы перезаписать их значения по умолчанию.

Предварительные требования

Перед указанием параметров установки с помощью мастера настройки нужно установить систему управления базами данных на отдельном сервере, расположенном вне кластера Kubernetes, выполнить все подготовительные действия, необходимые для устройства администратора, целевых устройств (в зависимости от развертывания на нескольких узлах или развертывания на одном узле) и устройств KUMA.

Процесс

Чтобы указать параметры установки с помощью мастера настройки:

  1. На устройстве администратора, на котором расположена утилита KDT, запустите мастер настройки с помощью следующей команды:

    ./kdt wizard -k <путь_к_транспортному_архиву> -o <путь_к_конфигурационному_файлу>

    где:

    • <путь_к_транспортному_архиву> – путь к транспортному архиву.
    • <путь_к_конфигурационному_файлу> – путь, по которому вы хотите сохранить конфигурационный файл и имя конфигурационного файла.

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

    Если у вас нет прав на запись в указанной директории или в этой директории находится файл с таким же именем, возникает ошибка и мастер завершает работу.

  2. Введите IPv4-адрес первичного узла (или первичного рабочего узла, если вы будете выполнять развертывание на одном узле). Это значение соответствует параметру host конфигурационного файла.

    Этот узел должен быть включен в ту же подсеть, что и шлюз кластера Kubernetes.

  3. Введите имя пользователя учетной записи, используемой для подключения к первичному узлу с помощью KDT (параметр user конфигурационного файла).

    Значение должно соответствовать следующим правилам:

    • Длина имени пользователя должна быть от 1 до 31 символов.
    • Имя пользователя может содержать следующие символы:
      • нижний регистр (a-z);
      • числа (0–9);
      • нижнее подчеркивание (_), дефис (-).
  4. Введите путь к закрытой части SSH-ключа, который находится на устройстве администратора и используется для подключения к первичному узлу KDT (параметр key конфигурационного файла).

    Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64.

  5. Введите количество рабочих узлов.

    Возможные значения:

    • 0 – развертывание на одном узле.
    • 3 или более – развертывание на нескольких узлах.

    Этот шаг определяет вариант развертывания Open Single Management Platform. Если вы хотите выполнить развертывание на одном узле, следующие параметры, характерные для этого варианта развертывания, примут значения по умолчанию:

    • typeprimary-worker
    • low_resourcestrue
    • vault_ha_modefalse
    • vault_standalonetrue
    • default_class_replica_count1
  6. Для каждого рабочего узла введите IPv4-адрес (параметр host конфигурационного файла).

    Обратите внимание, что первичный и рабочий узлы должны быть включены в одну подсеть.

    Для развертывания на нескольких узлах для параметра kind первого рабочего узла по умолчанию установлено значение admsrv. Это означает, что Сервер администрирования будет установлен на первом рабочем узле. Для развертывания на одном узле параметр kind не указывается для первичного рабочего узла.

  7. Для каждого рабочего узла введите имя пользователя, используемое для подключения к рабочему узлу с помощью KDT (параметр user конфигурационного файла).

    Значение должно соответствовать следующим правилам:

    • Длина имени пользователя должна быть от 1 до 31 символов.
    • Имя пользователя может содержать следующие символы:
      • нижний регистр (a-z);
      • числа (0–9);
      • нижнее подчеркивание (_), дефис (-).
  8. Для каждого рабочего узла введите путь к закрытой части SSH-ключа, который используется для подключения к рабочему узлу с помощью KDT (параметр key конфигурационного файла).

    Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64.

  9. Введите строку подключения для доступа к СУБД, которая установлена и настроена на отдельном сервере (параметр psql_dsn конфигурационного файла).

    Укажите этот параметр следующим образом: postgres://<dbms_username>:<password>@<fqdn>:<port>

    где:

    • dbms_username – имя пользователя привилегированной внутренней учетной записи СУБД. Этой учетной записи предоставлены права на создание баз данных и других учетных записей СУБД. С использованием этой привилегированной учетной записи СУБД во время развертывания будут созданы базы данных и другие учетные записи СУБД, необходимые для работы компонентов Open Single Management Platform.
    • password – пароль привилегированной внутренней учетной записи СУБД.
    • fqdn:port – полное имя домена и порт подключения целевого устройства, на котором установлена СУБД.

    Значение параметра psql_dsn должно соответствовать URI-формату. Если URI-подключение включает специальные символы в любой из его частей, символы должны быть экранированы с помощью процентной кодировки.

    Символы, которые требуется заменить в значении параметра psql_dsn:

    • Пробел → %20
    • %%25
    • &%26
    • /%2F
    • :%3A
    • =%3D
    • ?%3F
    • @%40
    • [%5B
    • ]%5D

    Дополнительную информацию см. в статье Строка подключения PostgreSQL.

    Мастер задает параметры установки только для варианта развертывания с установленной СУБД на отдельном сервере, расположенном вне кластера Kubernetes.

  10. Введите IP-адрес шлюза кластера Kubernetes (параметр ingress_ip конфигурационного файла).

    Шлюз кластера должен быть включен в ту же подсеть, что и все узлы кластера.

  11. Введите пароль учетной записи Open Single Management Platform, которая будет создана KDT при установке (параметр admin_password конфигурационного файла).

    Имя пользователя по умолчанию для этой учетной записи – "admin". Этой учетной записи пользователя назначена роль Главного администратора.

    Пароль должен соответствовать следующим правилам:

    • Пароль пользователя не может содержать менее 8 или более 256 символов.
    • Пароль должен содержать символы как минимум трех групп из списка ниже:
      • верхний регистр (A–Z);
      • нижний регистр (a-z);
      • числа (0–9);
      • специальные символы (@ # $ % ^ & * - _ ! + = [ ] { } | : ' , . ? / \ ` ~ " ( ) ;).
    • Пароль не должен содержать пробелов или комбинации ".@".

    Когда вы указываете значение параметра admin_password вручную (не с помощью мастера настройки), убедитесь, что это значение соответствует требованиям стандарта YAML для значений в строках:

    • Значение параметра, содержащего специальные символы, должно быть заключено в одинарные кавычки.
    • Любая одинарная кавычка ' внутри значения параметра должна быть удвоена, чтобы избежать этой одинарной кавычки.

    Пример: пароль учетной записи пользователя Any_pass%1234'5678"90 для параметра admin_password должен быть указан как 'Any_pass%1234''5678"90'.

  12. Введите путь к файлу инвентаря KUMA, расположенному на устройстве администратора (параметр inventory конфигурационного файла).

    Файл инвентаря KUMA содержит параметры установки для развертывания сервисов KUMA, не входящих в кластер Kubernetes. Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64.

  13. Введите путь к файлу с Лицензионным соглашением Ядра KUMA (параметр license конфигурационного файла).

    Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64.

  14. Введите имя домена, которое используется в FQDN публичных служб Open Single Management Platform (параметр smp_domain конфигурационного файла).

    Значение параметра должно соответствовать требованиям назначения имен доменов второго уровня.

  15. Укажите путь к пользовательским сертификатам, которые используются для работы с публичными службами Open Single Management Platform (параметр intermediate_bundle конфигурационного файла).

    Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64.

    Если вы хотите использовать самоподписанные сертификаты, нажмите на клавишу Enter, чтобы пропустить этот шаг.

  16. Введите t, чтобы использовать рабочий процесс для управления инцидентами, разработанный на основании ГОСТ Р 59712-2022 (параметр feature_gost_status в конфигурационном файле).
  17. Проверьте указанные параметры, которые отображаются в нумерованном списке.

    Чтобы изменить параметр, введите его номер и затем укажите новое значение. В противном случае нажмите на клавишу Enter, чтобы продолжить.

  18. Нажмите Y, чтобы сохранить новый конфигурационный файл с указанными параметрами, или N, чтобы остановить мастер настройки без сохранения.

Конфигурационный файл с указанными параметрами сохраняется в формате YAML.

Остальные параметры установки включены в конфигурационный файл со значениями по умолчанию. Вы можете изменить конфигурационный файл вручную перед развертыванием Open Single Management Platform.

В начало