Kaspersky Symphony XDR: Single Management Platform
1.1.8
Развертывание Open Single Management Platform  >  Подготовительные работы и развертывание  >  Развертывание на одном узле: Указание параметров установки

Развертывание на одном узле: Указание параметров установки

Развернуть все | Свернуть все

Конфигурационный файл, используемый для развертывания Open Single Management Platform на одном узле, содержит параметры установки, необходимые как для распределенного, так и для развертывания на одном узле. Также этот конфигурационный файл содержит параметры, специфичные только для развертывания на одном узле (vault_replicas, vault_ha_mode, vault_standalone и defaultClassReplicaCount).

Шаблон конфигурационного файла (smp_param.yaml.template) находится в дистрибутиве в архиве с утилитой KDT. Вы можете заполнить шаблон конфигурационного файла вручную либо с помощью мастера настройки: укажите параметры установки, необходимые для развертывания Open Single Management Platform и сгенерируйте конфигурационный файл.

Для корректной работы KDT с конфигурационным файлом добавьте пустую строку в конце файла.

Раздел nodes конфигурационного файла содержит параметры целевого устройства, которые перечислены в таблице ниже.

Раздел узлов

Имя параметра

Обязательная

Описание

desc

Да

Название узла.

type

Да

Тип узла.

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

  • primary
  • worker
  • primary-worker

Для целевого устройства для параметра type задайте значение primary-worker, чтобы включить развертывание на одном узле. В этом случае целевое устройство будет действовать как первичный и рабочий узлы.

host

Да

IP-адрес узла. Все узлы должны быть включены в одну подсеть.

kind

Нет

Тип узла, определяющий компонент Open Single Management Platform, который будет установлен на этом узле. Если для параметра kind узла задано значение admsrv, на этом узле будет установлен Сервер администрирования. Если вы хотите установить СУБД на узле внутри кластера, установите для параметра kind значение db для соответствующего узла. Для других узлов этот параметр можно оставить пустым.

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

  • admsrv
  • db

Не указывайте параметр kind при развертывании Open Single Management Platform на одном узле.

user

Да

Имя пользователя учетной записи, созданной на целевом устройстве и используемой для подключения к узлу с помощью KDT.

key

Да

Путь к закрытой части SSH-ключа находится на устройстве администратора и используется для подключения к узлу KDT.

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

Раздел параметров

Имя параметра

Обязательная

Описание

psql_dsn

Да

Строка подключения для доступа к СУБД, которая установлена и настроена на отдельном сервере.

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

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

password – пароль привилегированной внутренней учетной записи СУБД.

fqdn:port – полное имя домена и порт подключения отдельного сервера, на котором установлена СУБД.

Если задан параметр psql_dsn, компоненты Open Single Management Platform используют СУБД, расположенную по указанному FQDN. Иначе компоненты Open Single Management Platform используют СУБД внутри кластера.
После развертывания Open Single Management Platform замена СУБД, установленной внутри кластера, на СУБД, установленную на отдельном сервере, недоступна.

nwc-language

Да

Язык интерфейса Консоли OSMP, указанный по умолчанию. После установки вы можете изменить язык Консоли OSMP.

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

  • enUS
  • ruRu

ipaddress

Да

Зарезервированный статический IP-адрес шлюза кластера Kubernetes. Шлюз соединения должен быть включен в ту же подсеть, что и все узлы кластера.

Если вы устанавливаете СУБД на отдельный сервер, IP-адрес шлюза соединения должен содержать маску подсети /32.

Если вы устанавливаете СУБД внутри кластера, установите IP-адрес шлюза в IP-диапазоне в формате 0.0.0.0-0.0.0.0, где первый IP-адрес – это сам IP-адрес шлюза, а второй IP-адрес – IP-адрес СУБД.

ssh_pk

Да

Путь к закрытой части SSH-ключа находится на устройстве администратора и используется для подключения к узлу KDT.

sshKey

Да

Путь к приватной части SSH-ключа, которая находится на устройстве администратора и используется для подключения к узлам с сервисам KUMA (коллекторам, корреляторам и хранилищам).

kscpassword

adminPassword

Да

Параметры kscpassword и adminPassword указывают пароль от той же учетной записи пользователя Open Single Management Platform, которая будет создана KDT при установке. Имя пользователя по умолчанию для этой учетной записи – "admin".

Этой учетной записи пользователя назначена роль Главного администратора.

Параметры kscpassword и adminPassword должны совпадать.

Параметр adminPassword используется для загрузки лицензионных ключей KUMA и стандартных ресурсов.

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

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

lowResources

Да

Параметр, который указывает на то, что Open Single Management Platform установлен на целевом устройстве с ограниченными вычислительными ресурсами.

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

  • true – установка с ограниченными вычислительными ресурсами (для развертывания на одном узле).
  • false – стандартная установка.

Для развертывания на одном узле установите для параметра lowResources установлено значение true, чтобы компоненты Open Single Management Platform требовали меньше ресурсов памяти и процессора. Если вы включите этот параметр, для установки Ядра KUMA на целевом устройстве будет выделено 4 ГБ свободного дискового пространства.

vault_replicas

Да

Количество реплик секретного хранилища в кластере Kubernetes.

Для развертывания на одном узле установите для параметра vault_replicas значение 1.

vault_ha_mode

Да

Параметр, который указывает следует ли запускать хранилище секретов в режиме High Availability (HA).

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

  • true
  • false

Для развертывания на одном узле установите для параметра vault_ha_mode значение false.

vault_standalone

Да

Параметр, который указывает, следует ли запускать хранилище секретов в автономном режиме.

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

  • true
  • false

Для развертывания на одном узле установите для параметра vault_standalone значение true.

coreDiskRequest

Да

Параметр, который указывает объем дискового пространства для работы Ядра KUMA. Этот параметр используется, только если для параметра lowResources установлено значение false. Если для параметра lowResources установлено значение true, параметр coreDiskRequest игнорируется и выделяется 4 ГБ дискового пространства для работы Ядра KUMA. Если вы не укажете параметр coreDiskRequest, а для параметра lowResources установлено значение false, будет выделен объем дискового пространства по умолчанию для работы Ядра KUMA. Объем дискового пространства по умолчанию равен 512 ГБ.

inventory

Да

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

hostInventory

Нет

Путь к файлу инвентаря KUMA, находящемуся на устройстве администратора. Этот файл содержит параметры установки, используемые для частичного добавления или удаления устройств с сервисами KUMA.

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

license

Да

Путь к лицензионному ключу Ядра KUMA.

smp_domain

Да

Имя домена, которое используется в FQDN публичных служб Open Single Management Platform.

pki_domain

Да

Имя домена, для которого должен быть сгенерирован самоподписанный или пользовательский сертификат. Параметры pki_domain и smp_domain должны совпадать.

iam-nwc_host

flow_host

hydra_host

login_host

admsrv_fqdn

console_fqdn

api_fqdn

kuma_fqdn

psql_fqdn

monitoring_fqdn

coreIngressHost

gateway_host

hydra_fqdn

Да

FQDN службы Open Single Management Platform. Эти адреса содержат имя домена, которое должно соответствовать значению параметра smp_domain.

pki_fqdn_list

Да

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

intermediate_enabled

Нет

Параметр, который указывает, использовать ли пользовательский промежуточный сертификат вместо самоподписанных сертификатов для публичных служб Open Single Management Platform. По умолчанию указано значение true.

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

  • true – использовать пользовательский промежуточный сертификат.
  • false – использовать самоподписанные сертификаты.

intermediate_bundle

Нет

Путь к пользовательскому промежуточному сертификату, которые используются для работы с общедоступными службами Open Single Management Platform. Укажите этот параметр, если для параметра intermediate_enabled указано значение true.

admsrv_bundle

api_bundle

console_bundle

psql_bundle

Нет

Пути к пользовательским конечным сертификатам, которые используются для работы с соответствующими публичными службами Open Single Management Platform: admsrv.<smp_domain>, api.<smp_domain>, console.<smp_domain>, psql.<smp_domain>. Укажите параметр psql_bundle, если вы установили СУБД внутри кластера Kubernetes на узле СУБД.

Если вы хотите указать конечные пользовательские сертификаты, установите для параметра intermediate_enabled значение false и не указывайте параметр intermediate_bundle.

KUMAUIURL

Да

Адрес Консоли KUMA. Этот адрес содержит имя домена, которое должно соответствовать значению параметра smp_domain.

webConsoleURL

Да

Адрес Консоли OSMP. Этот адрес содержит имя домена, которое должно соответствовать значению параметра smp_domain.

encrypt_secret

sign_secret

Да

Имена секретных файлов, которые хранятся в кластере Kubernetes. Эти имена содержат имя домена, которое должно соответствовать значению параметра smp_domain.

ksc_state_size

Да

Объем свободного места на диске, выделенный для хранения данных Сервера администрирования (обновлений, инсталляционных пакетов и других внутренних служебных данных).

defaultClassReplicaCount

Да

Количество дисковых томов, на которых хранятся служебные данные компонентов Open Single Management Platform и KDT. По умолчанию указано значение 3.

Для развертывания на одном узле установите для параметра defaultClassReplicaCount значение 1.

kdtStateSize

Нет

Объем свободного дискового пространства, выделенного для хранения данных внутренних служб KDT. По умолчанию указано значение 5Gi.

prometheus_size

Да

Объем свободного дискового пространства, выделенного для хранения метрик. Минимальное рекомендуемое значение – 5 ГБ.

loki_size

Да

Объем свободного дискового пространства, выделенного для хранения журналов событий OSMP. Минимальное рекомендуемое значение – 20 ГБ.

loki_retention_period

Да

Период хранения журналов событий OSMP, по истечении которого журналы событий автоматически удаляются. Значение по умолчанию указано 72 часа (в конфигурационном файле установите значение параметра – "<time in hours>h". Например, "72h").

adminLogin

Да

Параметр adminLogin задает учетную запись пользователя Open Single Management Platform, которая будет создана KDT при установке. Этот параметр используется для загрузки ресурсов KUMA.

Параметры adminLogin и kumaLogin должны совпадать.

Значение параметра по умолчанию – admin. Не изменяйте значение параметра.

psql_tls_off

Нет

Параметр, указывающий, следует ли шифровать трафик между компонентами Open Single Management Platform и СУБД по протоколу TLS.

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

  • true – не шифровать трафик (если СУБД будет установлена внутри кластера).
  • false – шифровать трафик.

psql_trusted_cas

Нет

Путь к PEM-файлу, который может содержать TLS-сертификат сервера СУБД или корневой сертификат, из которого может быть выдан сертификат TLS-сервера.

Укажите параметр psql_trusted_cas, если СУБД будет установлена и настроена на отдельном сервере и если включено шифрование трафика (для параметра psql_tls_off указано значение false).

psql_client_certificate

Нет

Путь к PEM-файлу, содержащему сертификат и закрытый ключ компонента Open Single Management Platform. Этот сертификат используется для установления TLS-соединения между компонентами Open Single Management Platform и СУБД.

Укажите параметр psql_client_certificate, если СУБД будет установлена и настроена на отдельном сервере и если включено шифрование трафика (для параметра psql_tls_off указано значение false).

proxy_enabled

Нет

Параметр, указывающий использовать ли прокси-сервер для подключения компонентов Open Single Management Platform к интернету. Если устройство, на котором установлен Open Single Management Platform, имеет доступ в интернет, вы также можете предоставить доступ в интернет для работы компонентов Open Single Management Platform (например, Сервера администрирования) и для определенных интеграций как с решениями "Лаборатории Касперского", так и со сторонними производителями. Для установки прокси-соединения также необходимо указать параметры прокси-сервера в свойствах Сервера администрирования. По умолчанию указано значение false.

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

  • true – использовать прокси-сервер.
  • false – не использовать прокси-сервер.

proxy_addresses

Нет

IP-адрес прокси-сервера. Если прокси-сервер использует несколько IP-адресов, укажите эти адреса через пробел (например, "0.0.0.0 0.0.0.1 0.0.0.2"). Укажите этот параметр, если для параметра proxy_enabled указано значение true.

proxy_port

Нет

Номер порта, через который будет установлено прокси-подключение. Укажите этот параметр, если для параметра proxy_enabled указано значение true.

tracelevel

Нет

Уровень трассировки. По умолчанию указано значение 0.

Возможные значения параметра: 0–5.

kumaUrl

kumaLogin

Да

Параметры для внутреннего использования. Не изменяйте значение параметра.

Пример конфигурационного файла для развертывания Open Single Management Platform на одном узле

Идентификатор статьи: 271992, Последнее изменение: 2 нояб. 2024 г.
В начало