Установка утилиты

Оглавление

• Общее описание
• Последовательность установки
  • Шаг 0. Требования утилиты
  • Шаг 1. Установка зависимостей утилиты
  • Шаг 2. Развертывание объектов утилиты
  • Шаг 3. Проверка загрузки объектов утилиты
    • 1. Шаблоны индексов
    • 2. Паттерны индексов
    • 3. Справочники
  • Шаг 4. Регистрация типа инцидента модуля
• Удаление объектов

---

Общее описание

Для развертывания объектов модуля AI Security, не входящих в контентный модуль, используется утилита ai_security_ko_maker.

Утилита устанавливает:

Тип объекта	Объекты
Шаблоны индексов	gen_ai_events*, gen_ai_gpu_metrics*, gen_ai_permissions*
Паттерны индексов	Паттерны для тех же индексов gen_ai_*
Справочники	Сигнатуры атак и эталонные значения
Тип инцидента	Поля карточки инцидента и тип инцидента Инцидент ИБ

---

Последовательность установки

Шаг 0. Требования утилиты

• Python 3.x
• доступ к кластеру Smart Monitor с правами администратора
• сетевой доступ к API фронтенда (порт 5601) и API OpenSearch (порт 9200)

Шаг 1. Установка зависимостей утилиты

./bin/install_dependencies.sh

Шаг 2. Развертывание объектов утилиты

./bin/make_ai_security.py \
  --sm_host <SMART_MONITOR_HOST> \
  --sm_api_port <SMART_MONITOR_API_PORT> \
  --sm_cluster_port <OPENSEARCH_PORT> \
  --sm_user <SMART_MONITOR_USER> \
  --sm_password '<SMART_MONITOR_PASSWORD>'

Параметр	Обязательный	По умолчанию	Описание
--sm_host	Да	—	IP-адрес или имя хоста Smart Monitor
--sm_api_port	Нет	5601	Порт API фронтенда (сохраненные объекты, определения справочников)
--sm_cluster_port	Нет	9200	Порт API OpenSearch (шаблоны индексов, данные справочников)
--sm_user	Да	—	Имя пользователя
--sm_password	Да	—	Пароль пользователя

Дополнительные параметры:

• --skip-index-templates, --skip-index-patterns, --skip-lookups — пропустить соответствующий тип объектов
• --skip-lookup-data — создать определения справочников без загрузки данных из CSV
• --lookup-id — развернуть только указанный справочник; аргумент можно повторять
• --dry-run — показать, что будет сделано, без отправки запросов

Обратите внимание!

--sm_api_port используется для доступа к API фронтенда и определениям справочников, а --sm_cluster_port — для загрузки шаблонов индексов и данных справочников. Если API фронтенда и OpenSearch опубликованы на разных серверах, можно явно задать --sm_api_host и --sm_cluster_host.

Шаг 3. Проверка загрузки объектов утилиты

1. Шаблоны индексов

После загрузки проверьте наличие шаблонов индексов:

Навигационное меню - Параметры системы - Управление индексами - Шаблоны

2. Паттерны индексов

После загрузки проверьте наличие паттернов индексов:

Навигационное меню - Параметры системы - Настройки модулей - OPENSEARCH - Паттерны индексов

3. Справочники

После загрузки проверьте наличие 11 справочников модуля:

Навигационное меню - Lookup Manager - Список справочников

Шаг 4. Регистрация типа инцидента модуля

После импорта контентного модуля AI Security выполните скрипт apply_incident_types.py из состава той же утилиты ai_security_ko_maker. Скрипт создает тип инцидента Инцидент ИБ, после чего назначает его задачам модуля.

./bin/apply_incident_types.py \
  --sm_host <SMART_MONITOR_HOST> \
  --sm_api_port <SMART_MONITOR_API_PORT> \
  --sm_user <SMART_MONITOR_USER> \
  --sm_password '<SMART_MONITOR_PASSWORD>'

После выполнения проверьте:

• тип инцидента Инцидент ИБ появился в разделе Навигационное меню - Incident Manager - Типы инцидента
• задачи по расписанию модуля получили этот тип

---

Удаление объектов

Для удаления всех развернутых объектов используется скрипт удаления:

./bin/remove_ai_security.py \
  --sm_host <SMART_MONITOR_HOST> \
  --sm_api_port <SMART_MONITOR_API_PORT> \
  --sm_cluster_port <OPENSEARCH_PORT> \
  --sm_user <SMART_MONITOR_USER> \
  --sm_password '<SMART_MONITOR_PASSWORD>'