Merge pull request 'feature/device-out' (#51) from feature/device-out into rc

Reviewed-on: http://git.enode/deployer3000/integration-module/pulls/51

Dockerfile

@@ -9,8 +9,6 @@ COPY . .
 ENV CARGO_HTTP_DEBUG=true
 ENV CARGO_HTTP_TIMEOUT=100
 
-RUN cargo fetch --locked
-
 RUN cargo test --verbose
 RUN cargo build --release --target=x86_64-unknown-linux-musl
 

README.md

@@ -13,9 +13,11 @@
 
 1) **Нативный** - режим работы, производящий прямой опрос сервиса видео-конференц связи `Vinteo` и соотвествующий процесс `ETL`
 
-2) **Статичный** - режим работы *"посредник"*, когда все метрические данные ВКС `Vinteo` получаются через `Full REST API` средства `еНОД.Мониторинг`
+2) **Статичный** - режим работы *"посредник"*, когда все метрические данные ВКС `Vinteo` получаются через `REST-Full API` средства `еНОД.Мониторинг`
 
-3) **Системный** - аналогичный **статичному** режиму, но метричекие данные (заведомо обогащенные нулевым статусом) отправялются не напрямую в модуль `Prometehus exporter`, а в `Статусную модель` 
+3) **Системный** - аналогичный **статичному** режиму, но метрические данные (заведомо обогащенные нулевым статусом) отправялются не напрямую в модуль `Prometehus exporter`, а в `Статусную модель` 
+
+4) **Vinteo** - особый режим работы, предполагающий сбор определенного набора метрик напрямую с ВКС `Vinteo` механизмом многоэтапного `API-запроса`
 
 > **Примечание**
 По стандарту `ИМ` работает в **НАТИВНОМ** режиме и ожидает конфигурации в формате `.json`, однако приоритетным считается **СТАТИЧНЫЙ** режим. Подробная информация о настройке в пункте `Руководство` 
@@ -41,6 +43,8 @@
 
 ❌❌❌ -- **НЕЛЬЗЯ** настраивать (предпринимать), возможны ошибки в работе
 
+> Режим работы `Vinteo` *не описан* в таблице **намеренно** 
+
 ### Настройка режима работы "Нативный"
 
 Для настройки данного режима необходимо расположить в **активной** директории конфигурационный `config_api.json` файл:
@@ -116,6 +120,42 @@ ENODE_MONITORING_PASSWORD = "admin_password_enode_monitoring"
 ...
 ```
 
+### Настройка режима работы "Vinteo"
+
+Для работы в данном режиме необходимо установить переменные окружения в соотвествии со списком ниже
+
+``` toml
+...
+VINTEO_URL_BASE = "https://demo.vcs.vinteo.dev"
+VINTEO_ENDPOINT_CONFERENCES = "/api/v1/conferences"
+VINTEO_ENDPOINT_PARTICIPANTS = "/api/v1/participants/"
+VINTEO_API_KEY = "00000000000111111111.aaaaaaaaaaaaaaabbbbbbbbbbbbb"
+...
+```
+
+### Настройка экспорта полученных и обработанных данных
+
+Настройка *точки выхода* для полученных и обработанных метрик определеяется установленными в переменных окружения параметрами, варианта два:
+
+1) **Экспорт в статусную модель** в рамках механизма сквозного прохода данных в проекте `Буревестник ВКС`
+
+``` toml
+...
+STATUS_SYSTEM_URL = "{BASE_URL}/{ROUTE}"
+...
+```
+
+2) **Экспорт в экспортер или иной потребитель данных**
+
+``` toml
+...
+EXPORTER_URL = "{BASE_URL}/{ROUTE}"
+...
+```
+> ### **ОЧЕНЬ ВАЖНОЕ ПРИМЕЧАНИЕ** 
+> ---
+> Одновременное использование `$STATUS_SYSTEM_URL` и `$EXPORTER_URL` **НЕДОПУСТИМО** !! Вариант со ссылкой **на статусную модель** является _по стандарту_ **БОЛЕЕ ПРИОРИТЕТНЫМ**, второй затрется, использовать необходимо только один  
+
 2. Произвести сборку проекта командой :
 ``` bash 
 cargo build --release