Развертывание в нескольких ЦОД: параметры установки
Конфигурационный файл – это файл в формате YAML, содержащий набор параметров установки компонентов Kaspersky Symphony XDR.
Не все перечисленные ниже параметры включены в шаблон конфигурационного файла. Этот шаблон содержит только те параметры, которые должны быть указаны перед развертыванием Kaspersky Symphony XDR. Остальные параметры имеют значения по умолчанию и не включены в шаблон. Вы можете вручную добавить эти параметры в конфигурационный файл, чтобы перезаписать их значения. Значения параметров должны соответствовать описанным ниже правилам. Во время развертывания Kaspersky Symphony XDR, KDT проверяет, правильно ли указаны нужные параметры установки. Если необходимые параметры в конфигурационном файле отсутствуют или недействительны, развертывание будет прервано.
Пример конфигурационного файла развертывания Kaspersky Symphony XDR в нескольких ЦОД
Для корректной работы KDT с конфигурационным файлом добавьте пустую строку в конце файла.
Секция regions содержит параметры установки для каждого региона логической инфраструктуры. Регион представляет собой географическую область или местоположение развертывания и группирует один или несколько центров обработки данных (зон).
Секция regions
Имя параметра | Обязательная | Описание |
|---|---|---|
| Да | Название региона инфраструктуры. Значение должно соответствовать следующим правилам:
Все регионы инфраструктуры должны иметь уникальные имена. |
Секция zones содержит параметры установки для каждого центра обработки данных. Каждая зона принадлежит определенному региону.
Секция zones
Имя параметра | Обязательная | Описание |
|---|---|---|
| Да | Название региона инфраструктуры, к которому принадлежит зона. Значение должно соответствовать следующим правилам:
Значение параметра |
| Да | Зарезервированный статический IPv4-адрес шлюза кластера Kubernetes. Шлюз Kubernetes предназначен для подключения компонентов Kaspersky Symphony XDR, установленных внутри кластера Kubernetes. У каждого центра обработки данных должен быть свой уникальный IP-адрес шлюза кластера. Шлюз должен быть включен в ту же подсеть, что и управляющие рабочие узлы кластера, расположенные в одном центре обработки данных. |
Раздел nodes конфигурационного файла содержит параметры установки для каждого целевого устройства кластера Kubernetes. Эти параметры перечислены в таблице ниже.
Раздел nodes
Имя параметра | Обязательная | Описание |
|---|---|---|
| Да | Имя узла. Значение должно соответствовать следующим правилам:
Все узлы кластера должны иметь уникальные имена. Это требование является одним из обязательных для установки Kaspersky Symphony XDR и проверяется с помощью KDT.
|
| Да | Возможные значения параметра:
|
| Да | Название центра обработки данных, к которому принадлежит узел. Значение параметра |
| Да | IP-адрес узла. Все узлы, принадлежащие центру обработки данных, должны быть включены в ту же подсеть, что и шлюз кластера Kubernetes этого центра обработки данных. Для узлов требуется IPv4-адресация. KDT самостоятельно отключает IPv6 на узлах кластера. |
| Нет | Тип узла, определяющий компонент Kaspersky Symphony XDR, который будет работать на этом узле. Другие компоненты также могут работать на выбранном узле, но указанный компонент будет иметь приоритет. В случае сбоя узла компонент будет запущен на другом узле.
Единственное возможное значение параметра – Значение параметра Для корректной работы Kaspersky Symphony XDR рекомендуется выбрать узлы, на которых будет работать Сервер администрирования и компонент для взаимодействия с НКЦКИ. Укажите соответствующие значения параметра |
| Нет | Служба KUMA, которую вы можете указать для установки на рабочем узле. Можете задать установку одного или нескольких служб KUMA, либо не указывать их установку. Параметр Сервисы KUMA (коллекторы, корреляторы и хранилища) могут быть установлены полностью внутри кластера на рабочих узлах, полностью на отдельных узлах вне кластера Kubernetes или частично внутри и частично вне кластера Kubernetes. Если все сервисы KUMA будут установлены внутри кластера, для параметра Хранилища, созданные из одного ресурса KUMA, не разрешается размещать на одном рабочем узле. Данное правило добавлено для обеспечения необходимого уровня отказоустойчивости. Если кластер хранилища состоит из нескольких экземпляров, все они должны быть развернуты либо внутри кластера, либо вне его. Возможные значения параметра:
Значение параметра указывается в виде списка строк, включающих в себя роли KUMA. Например:
|
| Да | Имя пользователя учетной записи, созданной на целевом устройстве и используемой для подключения к узлу с помощью KDT. Значение должно соответствовать следующим правилам:
|
| Нет | Пароль для подключения к узлу. Может использоваться вместо SSH-ключа, указанного в параметре |
Остальные параметры установки перечислены в разделе parameters конфигурационного файла и описаны в таблице ниже.
Раздел параметров
Имя параметра | Обязательная | Описание |
|---|---|---|
| Да | Строка подключения для доступа к СУБД, которая установлена и настроена вне кластера Kubernetes. Укажите этот параметр следующим образом:
где:
Чтобы использовать кластер высокой доступности, укажите этот параметр следующим образом:
Чтобы использовать Corosync/Pacemaker, укажите этот параметр с виртуальным IP-адресом следующим образом:
Значение параметра Символы, которые требуется заменить в значении параметра
Дополнительную информацию см. в статье Строка подключения PostgreSQL. |
| Да | Язык интерфейса OSMP Console, указанный по умолчанию. После установки вы можете изменить язык OSMP Console. Возможные значения параметра:
Если вы не укажете этот параметр в конфигурационном файле, будет использоваться значение по умолчанию. |
| Да | Путь к закрытой части SSH-ключа, которая находится на устройстве администратора и используется для подключения к управляющему рабочему узлу и к узлам со службами KUMA (коллекторам, корреляторам и хранилищам) с помощью утилиты KDT. Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64. |
| Да | Параметр Этой учетной записи пользователя назначена роль Главного администратора. Пароль должен соответствовать следующим правилам:
Когда вы указываете значение параметра
Пример: пароль учетной записи пользователя |
| Нет | Параметр, указывающий на то, что приложение Kaspersky Symphony XDR установлено на целевом устройстве с ограниченными вычислительными ресурсами. В случае развертывания на нескольких узлах установите для параметра Возможные значения параметра:
|
| Да | Параметр, который указывает объем дискового пространства для работы Ядра KUMA. Если вы не укажете параметр Если вы не укажете параметр Вы можете изменить параметр |
| Да | Путь к файлу инвентаря KUMA, находящемуся на устройстве администратора. Файл инвентаря содержит параметры установки для развертывания сервисов KUMA, не входящих в кластер Kubernetes. Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64. Если все сервисы KUMA будут установлены внутри кластера, для параметра |
| Нет | Путь к дополнительному файлу инвентаря KUMA, находящемуся на устройстве администратора. Этот файл содержит параметры установки, используемые для частичного добавления или удаления устройств с сервисами KUMA. Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64. Если вы выполняете первоначальное развертывание Kaspersky Symphony XDR или запускаете пользовательское действие, для которого требуется конфигурационный файл, оставьте значение параметра по умолчанию ( |
| Нет | Путь к KUMA лицензионному ключу, находящемуся на устройстве администратора. Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64. Вы можете загрузить лицензионный ключ или указать код активации при входе в OSMP после завершения развертывания. |
| Да | Имя устройства, которое используется в FQDN публичных служб Kaspersky Symphony XDR. Имя устройства службы и доменное имя (значение параметра Если пользовательские имена устройств не указаны, используются следующие имена устройств по умолчанию:
|
| Да | Имя домена, которое используется в FQDN публичных служб Kaspersky Symphony XDR. Значение параметра должно соответствовать требованиям назначения имен доменов до четвертого уровня. Имя устройства службы и доменное имя являются частью FQDN-службы. Например, если значение переменной |
| Да | Список имен устройств публичных служб Kaspersky Symphony XDR, для которых требуется сформировать самоподписанный или пользовательский сертификат. Значение параметра должно быть списком имен устройств разделенных пробелами. |
| Нет | Параметр, который указывает, использовать ли пользовательский промежуточный сертификат вместо самоподписанных сертификатов для публичных служб Kaspersky Symphony XDR. Возможные значения параметра:
|
| Нет | Путь к пользовательскому промежуточному сертификату, который используется для работы с общедоступными службами Kaspersky Symphony XDR. Укажите этот параметр, если для параметра |
| Нет | Пути к пользовательским конечным сертификатам, которые используются для работы с соответствующими публичными службами Kaspersky Symphony XDR: Если вы хотите указать конечные пользовательские сертификаты, установите для параметра |
| Да | Объем свободного места на диске, выделенный для хранения данных Сервера администрирования (обновлений, инсталляционных пакетов и других внутренних служебных данных). Измеряется в гигабайтах, указывается как "<объем>Gi". Требуемый объем свободного места на диске зависит от количества управляемых устройств и других параметров и может быть рассчитан. Значение по умолчанию – 30 ГБ. Если вы не укажете этот параметр в конфигурационном файле, будет использоваться это значение. |
| Да | Объем свободного дискового пространства, выделенного для хранения метрик. Измеряется в гигабайтах, указывается как "<объем>GB". Минимальное рекомендуемое значение и значение по умолчанию – 5 ГБ. Если вы не укажете этот параметр в конфигурационном файле, будет использоваться значение по умолчанию. |
| Нет | Имя учетной записи пользователя, используемой для просмотра метрик OSMP с помощью инструмента Grafana. Значение должно соответствовать следующим правилам:
|
| Нет | Пароль от учетной записи, используемой для просмотра метрик OSMP с помощью инструмента Grafana. Пароль должен соответствовать следующим правилам:
|
| Да | Объем свободного дискового пространства, выделенного для хранения журналов событий OSMP. Измеряется в гигабайтах, указывается как "<объем>Gi". Минимальное рекомендуемое значение и значение по умолчанию – 40 ГБ. Если вы не укажете этот параметр в конфигурационном файле, будет использоваться значение по умолчанию. |
| Да | Период хранения журналов событий OSMP, по истечении которого журналы событий автоматически удаляются. По умолчанию указано значение 72 часа (в конфигурационном файле установите значение параметра – "<time in hours>h". Например, "72h"). Если вы не укажете этот параметр в конфигурационном файле, будет использоваться значение по умолчанию. |
| Нет | Количество свободного дискового пространства, выделенного для хранения данных компонента для работы с действиями по реагированию. Измеряется в гигабайтах, указывается как "<объем>Gi". Минимальное рекомендуемое значение – 20 ГБ. |
| Нет | Параметр, указывающий, следует ли шифровать трафик между компонентами Kaspersky Symphony XDR и СУБД по протоколу TLS. Если СУБД установлена за пределами кластера, шифрование TLS выключено по умолчанию (значение по умолчанию Возможные значения параметра:
|
| Нет | Путь к PEM-файлу, который может содержать TLS-сертификат сервера СУБД или корневой сертификат, из которого может быть выдан сертификат TLS-сервера. Значение параметра должно быть Linux-путем к файлу или содержимым файла в кодировке Base64. Укажите параметр |
| Нет | Параметр, указывающий использовать ли прокси-сервер для подключения компонентов Kaspersky Symphony XDR к интернету. Если устройство, на котором установлен Kaspersky Symphony XDR, имеет доступ в интернет, вы также можете предоставить доступ в интернет для работы компонентов Kaspersky Symphony XDR (например, Сервера администрирования) и для определенных интеграций как с решениями "Лаборатории Касперского", так и со сторонними производителями. Для установки прокси-соединения также необходимо указать параметры прокси-сервера в свойствах Сервера администрирования. Возможные значения параметра:
|
| Нет | IP-адрес прокси-сервера. Если прокси-сервер использует несколько IP-адресов, укажите эти адреса через пробел (например, " |
| Нет | Номер порта, через который будет установлено прокси-подключение. Укажите этот параметр, если для параметра |
| Нет | Уровень детализации файлов трассировки Сервера администрирования. Трассировка записывается во время работы Сервера администрирования. Значение по умолчанию – 0, трассировка не записывается. Возможные значения параметра: 0–5. Чем выше значение параметра, тем более подробная информация о трассировке записывается. |
| Нет | Уровень детальности журнала событий развертывания Ядра KUMA и сервисов KUMA, которое выполняется KDT. Возможные значения параметра:
По мере увеличения количества букв "v" в флаге, журналы событий становятся более детальными. Если этот параметр не указан в конфигурационном файле, сохраняются стандартные журналы событий установки компонентов. |
| Нет | Количество файлов, которые вы можете прикрепить к инциденту. По умолчанию указано значение |
| Нет | Общий размер файлов, прикрепленных к инциденту. Измеряется в байтах. Единицы измерения не отображаются. По умолчанию указано значение |
| Нет | Параметр, указывающий, следует ли проверить аппаратное и программное обеспечение, а также конфигурацию сети узлов кластера Kubernetes на соответствие требованиям, необходимым для установки решения перед развертыванием. Возможные значения параметра:
|
| Нет | Параметр, включающий или выключающий предварительную проверку и обновление кеша пакетов пакетным менеджером APT. Таким образом становится возможным развертывание Kaspersky Symphony XDR в среде с физической изоляцией. Возможные значения параметра:
|
| Нет | Адрес SMTP-сервера для Grafana, который используется для отправки уведомлений о событиях, связанных с работоспособностью кластера Kubernetes, по электронной почте. Укажите этот параметр в формате |
| Нет | Имя пользователя для аутентификации на SMTP-сервере. |
| Нет | Пароль для аутентификации на SMTP-сервере. |
| Нет | Файл, содержащий цепочку сертификатов X.509, которая используется для проверки TLS-подключения к SMTP-серверу. |
| Нет | Данный параметр указывает, следует ли пропускать проверку TLS-сертификата для SMTP-сервера. Возможные значения параметра:
|
| Нет | Электронный адрес отправителя, который будет отображаться в поле "От" при отправке уведомлений по электронной почте. |
| Нет | Отображаемое имя отправителя в уведомлениях по электронной почте. |
| Нет | Идентификатор, используемый в команде EHLO при подключении к SMTP-серверу. |
| Нет | Политика использования STARTTLS при подключении к SMTP-серверу. Возможные значения параметра:
|
| Нет | Параметр, который указывает, следует ли включить ли трассировку SMTP-подключения для отладки отправки электронной почты. Возможные значения параметра:
|
| Нет | Параметр, указывающий, следует ли развертывать сервисы KUMA для Kaspersky EDR или для Kaspersky NGFW. Возможные значения параметра:
|
| Нет | Параметр, указывающий на то, что вам нужно установить компонент для взаимодействия с НКЦКИ на определенном узле кластера. По умолчанию указано значение Возможные значения параметра:
|
| Нет | Параметр, который указывает, использовать ли рабочий процесс, созданный на основании ГОСТ Р 59712-2022, для управления инцидентами. Значение по умолчанию Возможные значения параметра:
|
| Нет | Время жизни токена доступа. В конфигурационном файле установите значение параметра – " Значение по умолчанию – Вы можете изменить параметр |
| Нет | Время жизни токена обновления, используемого для получения нового токена доступа. В конфигурационном файле установите значение параметра – " Значение по умолчанию – Вы можете изменить параметр |
| Нет | Максимальное время простоя сеанса единого входа. В конфигурационном файле установите значение параметра – " Значение по умолчанию – Вы можете изменить параметр |
Пример конфигурационного файла развертывания Kaspersky Symphony XDR на нескольких узлах