48 lines
1.9 KiB
Markdown
48 lines
1.9 KiB
Markdown
# Интеграционный модуль для проекта "Буревестник ВКС"
|
||
|
||
## Описание
|
||
`integr_mod` - Rust-пакет, предоставляющий функционал интеграционного модуля в проекте "Буревестник ВКС", состоящий из бинарных крейтов для:
|
||
- получение данных через API ВКС
|
||
- поддержку хранения, валидации и актуализации собственных конфигураций
|
||
- предобработку полученных данных и ~~отправку `Системе Мониторинга`~~ сохранение в БД
|
||
|
||
## Руководство
|
||
|
||
1. Заполнить .env файл или установить переменные окружения в соотвествии с примером в `.env.example` файле
|
||
``` toml
|
||
# Template .env for API grabber
|
||
|
||
# Prometheus-Exporter info
|
||
EXPORTER_URL = "http(s)://ip.ip.ip.ip:port"
|
||
|
||
# eNODE.Monitoring configuration
|
||
ENODE_MONITORING_IP = "ip.ip.ip.ip"
|
||
# admin user is required
|
||
ENODE_MONITORING_LOGIN = "admin_user_enode_monitoring"
|
||
# admin password is required
|
||
ENODE_MONITORING_PASSWORD = "admin_password_enode_monitoring"
|
||
```
|
||
2. Произвести сборку проекта командой :
|
||
``` bash
|
||
cargo build --release
|
||
```
|
||
|
||
3. Запустить
|
||
> Debug версия
|
||
``` bash
|
||
cargo run --bin api-grub
|
||
```
|
||
или
|
||
> Release версия
|
||
``` bash
|
||
cargo run --release --bin api-grub
|
||
```
|
||
## Текущий прогресс
|
||
|
||
| Крейт (подмодуль) | Прогресс |
|
||
|---|---|
|
||
|`api-grub` | ✅✅✅✅✅✅✅✅✅🛠️ |
|
||
|`config-delivery [migrated]` | ❌❌❌❌❌❌❌❌❌❌ |
|
||
|`integrs-structs` | ✅✅✅✅✅✅✅✅✅✅ |
|
||
|`preproc` [temp-deprecated] | ❌❌❌❌❌❌❌❌❌❌ | (разработка временно остановлена)
|