diff --git a/README.md b/README.md index 907435f..dc8410f 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,48 @@ -# Адаптер СМЭВ (эмулятор) - -Эмулятор СМЭВ для тестовых сред и разработки. - -**Требования** - -- Простота локального развёртывания (для разработчиков). -- Использование в автоматическом интеграционном тестировании. -- Использование в ручном тестировании, через ПВВ (реальный или эмулятор). -- Использование в нагрузочном тестировании ПВВ, ПЭП или их эмуляторов. - -**Сценарии использования** - -TODO - -1. Загрузка образцовых данных из Архива реального ПВВ. -2. Инициализация массового обмена. -3. Мониторинг - -# Локальная настройка emulator-smev - -TODO: разработать один или несколько сценариев для запуска и отладки приложений. - -# Продакшн-настройка emulator-smev - -Не рекомендуется включать в окружении, где уже присутствует реальный ПВВ (rel, Песок, Стенд, ПАК и прочие). - -В остальном требуется совместимость emulator-smev и ПВВ (настоящего или эмулятора). Если используется настоящий ПВВ, то необходимо -зарегистрировать эмулятор как отдельный клиент (команда РПД) и разрешить обмен между необходимыми компонентами (команда ПВВ). - -# Авторизация - -TODO: авторизация клиента emulator-smev в РПД или кейклоак. - -# База дынных - -PostgreSQL. - -TODO: Создание базы данных: - -Создайте базу данных для микросервиса с именем указанным в values хелмов, например pvv_fk_adapter_db. - -# Требования - -- Java 11 Bellsoft Liberica Full -- Maven -- Postgres 16 -- Доступ к системе ПВВ (эмулятора или реальной) +# Адаптер СМЭВ (эмулятор) + +Эмулятор СМЭВ для тестовых сред и разработки. + +**Требования** + +- Простота локального развёртывания (для разработчиков). +- Использование в автоматическом интеграционном тестировании. +- Использование в ручном тестировании, через ПВВ (реальный или эмулятор). +- Использование в нагрузочном тестировании ПВВ, ПЭП или их эмуляторов. + +**Сценарии использования** + +TODO: не только логировать события, но и вынести их на DEBUG, чтобы разработчик мог включить этот режим у себя. + +1. Загрузка образцовых данных из Архива реального ПВВ. +2. Инициализация массового обмена. +3. Мониторинг работы. + +# Локальная настройка emulator-smev + +TODO: разработать один или несколько сценариев для запуска и отладки приложений. + +# Продакшн-настройка emulator-smev + +Не рекомендуется включать в окружении, где уже присутствует реальный ПВВ (rel, Песок, Стенд, ПАК и прочие). + +В остальном требуется совместимость emulator-smev и ПВВ (настоящего или эмулятора). Если используется настоящий ПВВ, то необходимо +зарегистрировать эмулятор как отдельный клиент (команда РПД) и разрешить обмен между необходимыми компонентами (команда ПВВ). + +# Авторизация + +TODO: авторизация клиента emulator-smev в РПД или кейклоак. + +# База дынных + +PostgreSQL. + +TODO: Создание базы данных: + +Создайте базу данных для микросервиса с именем указанным в values хелмов, например pvv_fk_adapter_db. + +# Требования + +- Java 11 Bellsoft Liberica Full +- Maven +- Postgres 16 +- Доступ к системе ПВВ (эмулятора или реальной)