Alertmgr

Перечень параметров

AMQP_DSN= #[1]
AMQP_TLS_VERIFY_MODE=NONE #[2]
AMQP_SSL_CA_LOCATION="" #[3]
AMQP_SSL_CERT_LOCATION="" #[4]
AMQP_SSL_KEY_LOCATION="" #[5]
AMQP_EXCHANGE=cqrs #[6]
CMDB_DSN="http://cmdb:8000" #[7]
CMDB_TOKEN= #[8]
CQRS_QUEUE_NAME=soar.am.cqrs.alertmgr.default #[9]
DA_DRY_MODE=True #[10]
DRAINED_MESSAGES_MAX_RECORDS="50000" #[11]
FEATURE_ALERT_CREATED=true #[12]
FEATURE_CMDB=true #[13]
KAFKA_ALERT_CREATED_TOPIC_ID=socd-alertmgr-alerts #[14]
KAFKA_BOOTSTRAP_SERVERS= #[15]
KAFKA_GROUP_ID=bedr_alerts #[16]
KAFKA_TOPIC_ID=bedr_alerts #[17]
KAFKA_SECURITY_PROTOCOL=PLAINTEXT #[18]
KAFKA_SSL_CA_LOCATION=/kafka/certs/ca.crt #[19]
KAFKA_SSL_CERT_LOCATION=/kafka/certs/tls.crt #[20]
KAFKA_SSL_KEY_LOCATION=/kafka/certs/tls.key #[21]
KAFKA_SSL_KEY_PASSWORD= #[22]
KAFKA_SASL_MECHANISM= #[23]
KAFKA_SASL_USERNAME= #[24]
KAFKA_SASL_PASSWORD= #[25]
PORTAL_DSN=http://portal-root:8000 #[26]
PORTAL_TOKEN= #[27]
REDIS_DSN= #[28]
REDIS_TLS_VERIFY_MODE=NONE #[29]
REDIS_SSL_CA_LOCATION= #[30]
REDIS_SSL_CERT_LOCATION= #[31]
REDIS_SSL_KEY_LOCATION= #[32]

Описание параметров

Описание параметра

Описание значения

AMQP_DSN

Адрес подключения к RabbitMQ

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

Пример: amqp://<user>:<pass>@<rmqhost>:<rmqport>/<vhost>

Параметры:

  • <user> — учетная запись для RabbitMQ;

  • <pass> — пароль для RabbitMQ;

  • <rmqhost> — хост, где установлен RabbitMQ;

  • <rmqport> — порт для подключения к RabbitMQ;

  • <vhost> — виртуальный хост, указывается при наличии

AMQP_EXCHANGE

Подготовленный exchange в RabbitMQ

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

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

AMQP_SSL_CA_LOCATION

Путь к корневому сертификату

Пример: PATH/TO/CA_CERT/ca.pem

AMQP_SSL_CERT_LOCATION

Путь к клиентскому сертификату. Указывается при использовании клиентской аутентификации к серверу. Для явного отключения нужно убрать параметр

Пример: PATH/TO/CA_CERT/client.pem

AMQP_SSL_KEY_LOCATION

Путь к приватному ключу сертификата клиента. Указывается при использовании клиентской аутентификации к серверу. Для явного отключения нужно убрать параметр

Пример: PATH/TO/CA_CERT/client.key

AMQP_TLS_VERIFY_MODE

Режим проверки TLS-сертификата

Возможные значения: NONE, OPTIONAL, REQUIRED

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

CMDB_DSN

Адрес CMDB-компонента. Переменная задана по умолчанию, не изменять.

Пример: http://<host>:<port>

Где:

  • <host> — хост, где установлена CMDB;

  • <port> — порт для подключения к CMDB

По умолчанию: http://cmdb:8000

CMDB_TOKEN

Токен для взаимодействия с компонентом CMDB

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

Пример: <your-API-token>

CQRS_QUEUE_NAME

Название очереди в RabbitMQ для взаимодействия с SOAR, требуется определить, если развертывается несколько SOAR с отдельными Alertmgr и используется один кластер RabbitMQ, значение должно быть уникальным

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

По умолчанию: soar.am.cqrs.alertmgr.default

DA_DRY_MODE

Позволяет отключать фактическую отправку писем при рассылке DA

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

DRAINED_MESSAGES_MAX_RECORDS

Максимальное количество записей

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

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

FEATURE_ALERT_CREATED

Включает отправку событий о создании алерта в Apache Kafka

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

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

FEATURE_CMDB

Включает взаимодействие с компонентом CMDB

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

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

KAFKA_ALERT_CREATED_TOPIC_ID

Название топика Apache Kafka, куда будет отправлено событие о создание алерта

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

По умолчанию: socd-alertmgr-alerts

KAFKA_BOOTSTRAP_SERVERS

URI Kafka-серверов

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

Пример: <kafka_host>:<kafka_port>

Где:

  • <kafka_host> — хост, где установлена Kafka;

  • <kafka_port> — порт для подключения к Kafka

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

KAFKA_GROUP_ID

Название группы для Apache Kafka

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

Пример: alerting-prod-default

KAFKA_SASL_MECHANISM

Тип механизма SASL

Возможные значения: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512

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

KAFKA_SASL_PASSWORD

Пароль для SASL. Для явного отключения нужно убрать параметр

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

KAFKA_SASL_USERNAME

Учетная запись для SASL. Для явного отключения нужно убрать параметр

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

KAFKA_SECURITY_PROTOCOL

Тип протокола безопасности для подключения к Apache Kafka

Возможные значения: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL

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

KAFKA_SSL_CA_LOCATION

Путь к корневому сертификату Apache Kafka, указывается при использовании TLS. Для явного отключения нужно убрать параметр.

По умолчанию: PATH/TO/CA_CERT/ca.crt

KAFKA_SSL_CERT_LOCATION

Путь к сертификату Apache Kafka, указывается при использовании клиентской аутентификации к серверу. Для явного отключения нужно убрать параметр.

По умолчанию: PATH/TO/TLS_CERT/tls.crt

KAFKA_SSL_KEY_LOCATION

Путь к ключу сертификата Apache Kafka, указывается при использовании клиентской аутентификации к серверу. Для явного отключения нужно убрать параметр.

По умолчанию: PATH/TO/TLS_KEY/tls.key

KAFKA_SSL_KEY_PASSWORD

Ключ сертификата Apache Kafka

Пример: password

KAFKA_TOPIC_ID

Название топика для Apache Kafka

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

Пример: alerting-prod-default

PORTAL_DSN

Адрес portal-root. Задан по умолчанию, не изменять

Обязательное поле, без изменений

По умолчанию: http://portal-root:8000

PORTAL_TOKEN

Токен для взаимодействия с portal-root

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

Пример: 063e9e3e6702d76a9c623e9047d97ce6c018dffb

REDIS_DSN

Адрес Redis

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

Пример: redis(s)://<user>:<pass>@<host>:<port>/<db>

Где:

  • <user> — учетная запись пользователя базы данных;

  • <pass> — пароль пользователя базы данных;

  • <host> — хост, где установлена база данных;

  • <port> — порт для подключения к базе данных;

  • <db> — название базы данных, при использовании одного Redis для всех сервисов обязательно установить значение 2.

Rediss используется при значениях REDIS_TLS_VERIFY_MODE - OPTIONAL/REQUIRED

REDIS_SSL_CA_LOCATION

Путь к CA-сертификату. Для явного отключения нужно убрать параметр. Для явного отключения нужно убрать параметр

Пример: PATH/TO/CA_CERT/ca.pem

REDIS_SSL_CERT_LOCATION

Путь к клиентскому сертификату. Для явного отключения нужно убрать параметр. Указывается при использовании клиентской аутентификации к серверу

Пример: PATH/TO/CA_CERT/client.pem

REDIS_SSL_KEY_LOCATION

Путь к приватному ключу сертификата клиента. Указывается при использовании клиентской аутентификации к серверу. Для явного отключения нужно убрать параметр

Пример: PATH/TO/CA_CERT/client.key

REDIS_TLS_VERIFY_MODE

Режим проверки TLS

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

  • NONE (по умолчанию) — подключение осуществляется без TLS подключения;

  • OPTIONAL/REQUIRED — подключение должно осуществляться через TLS соединение