ervu-lkrp-av/config.md

# Описание конфигурации параметров проекта

В micord.env заданы следующие переменные окружения:

#### Конфигурация и топики Kafka ЛК РП

- `AV_KAFKA_BOOTSTRAP_SERVERS` - список пар хост:порт, использующихся для установки первоначального соединения с кластером Kafka
- `AV_KAFKA_SECURITY_PROTOCOL` - протокол, используемый для взаимодействия с брокерами
- `AV_KAFKA_SASL_MECHANISM` - механизм SASL, используемый для клиентских подключений
- `AV_KAFKA_USERNAME` - пользователь для подключения к Kafka
- `AV_KAFKA_PASSWORD` - пароль для подключения к Kafka
- `AV_KAFKA_GROUP_ID` - идентификатор группы потребителей, который отвечает за создание группы для объединения нескольких потребителей
- `AV_KAFKA_TOPIC_CONSUMER_CONCURRENCY` - количество потребителей для обработки сообщений из топиков
- `AV_KAFKA_CONSUMER_FETCH_MIN_BYTES` - минимальный размер пакета для отправки брокером ответа по запросу потребителя (по умолчанию, 1 байт)
- `AV_KAFKA_CONSUMER_FETCH_MAX_WAIT` - максимальное время ожидания для отправки брокером ответа по запросу потребителя (по умолчанию, 500 мс)
- `AV_KAFKA_CONSUMER_MAX_POLL_RECORDS` - максимальное количество записей в пакете (по умолчанию, 500)
- `AV_KAFKA_CONSUMER_RECOVERY_INTERVAL` - интервал между повторными попытками обработки пакета сообщений (по умолчанию, 0 мс)
- `AV_KAFKA_CONSUMER_RECOVERY_ATTEMPTS` - количество попыток обработки пакета сообщений (по умолчанию, 0)

#### Конфигурация и топики Kafka ЕРВУ

- `ERVU_KAFKA_BOOTSTRAP_SERVERS` - список пар хост:порт, использующихся для установки первоначального соединения с кластером Kafka
- `ERVU_KAFKA_SECURITY_PROTOCOL` - протокол, используемый для взаимодействия с брокерами
- `ERVU_KAFKA_SASL_MECHANISM` - механизм SASL, используемый для клиентских подключений
- `ERVU_KAFKA_USERNAME` - пользователь для подключения к Kafka
- `ERVU_KAFKA_PASSWORD` - пароль для подключения к Kafka
- `ERVU_KAFKA_GROUP_ID` - идентификатор группы потребителей, который отвечает за создание группы для объединения нескольких потребителей
- `` - 

#### Настройки взаимодействия с файлами и антивирусом

- `FILE_SAVING_PATH` - путь для сохранения файла на диске
- `AV_CHECK_ENABLED` - параметр включения/отключения проверки на вирусы
- `AV_THREAD_COUNT` - количество потоков для обработки пакета сообщений от Kafka
- `AV_REST_ADDRESS` - url для отправки файлов на проверку антивирусом
- `AV_FIRST_TIMEOUT_MILLISECONDS` - таймаут ожидания окончания проверки анивирусом
- `AV_RETRY_MAX_ATTEMPTS_COUNT` - количество попыток проверки файла 
- `AV_RETRY_DELAY_MILLISECONDS` - задержка между попытками проверки файла

#### Конфигурация S3

- `S3_ENDPOINT` - url для подключения к S3
- `S3_ACCESS_KEY` - публичная часть пары ключей AWS
- `S3_SECRET_KEY` - закрытая часть пары ключей AWS
- `S3_BUCKET_NAME` - наименование бакета для сохранения проверенного файла
- `S3_PATH_STYLE_ACCESS_ENABLED` - параметр включения/отключения стиля, при котором название бакета указывается в части пути до объекта в URI 

## Топики Kafka

| Наименование                   | Описание                                                                | Пишет                 | Читает               | Имя конфигурации               |
| ------------------------------ | ----------------------------------------------------------------------- | --------------------- | -------------------- | ------------------------------ |
| ervu.lkrp.av-fileupload        | топик для чтения данных по загруженному в личном кабинете файлу         | ervu-lkrp-ul-backend  | ervu-lkrp-av         | AV_KAFKA_TOPIC_NAME            |
| ervu.lkrp.av-fileupload-status | топик для отправки статусов проверки файла                              | ervu-lkrp-av          | ervu-lkrp-ul-backend | AV_KAFKA_STATUS_TOPIC_NAME     |
| ervu.lkrp.download.request     | топик для отправки данных об успешной проверке файла                    | ervu-lkrp-av          |                      | ERVU_KAFKA_SUCCESS_TOPIC_NAME  |
| ervu.lkrp.download.request     | топик для отправки данных об ошибках проверки файла или наличии вирусов | ervu-lkrp-av          |                      | ERVU_KAFKA_ERROR_TOPIC_NAME    |
| ervu.lkrp.download.response    | топик для чтения статусов файла, полученных от ЕРВУ                     | organization_registry | ervu-lkrp-av         | ERVU_KAFKA_RESPONSE_TOPIC_NAME |