docs: update architecture and API documentation to clarify job processing, in-memory registry usage, and future broker integration plans. Enhance OpenAPI specifications for enrollment responses and refine quickstart instructions for Docker setups.

2026-04-05 18:36:32 +07:00
parent c6687b2c91
commit acc0608432
18 changed files with 110 additions and 96 deletions
@@ -118,7 +118,7 @@ EvoBGP/
 │   ├── repository/          # SQL по сущностям (tenant, module, peer, revision, jobs, …)
 │   ├── domain/              # типы и правила без I/O (префиксы, community, ревизии)
 │   ├── httpapi/             # роуты OpenAPI, middleware, валидация, маппинг в сервисы
-│   ├── jobs/                # очередь: брокер (reference) vs PG + SKIP LOCKED (microVPS)
+│   ├── jobs/                # задачи: сейчас in-memory Registry в процессе API; PG job_audit / брокер — целевое расширение (см. примечание ниже §2)
 │   ├── scheduler/           # триггеры по расписанию модулей
 │   ├── ingest/              # CDN, DoH, нормализация, запись в БД
 │   ├── render/              # материализация префиксов, ревизия, текст артефактов BIRD
@@ -237,6 +237,8 @@ flowchart LR

 > **Правило:** логика домена **одинакова**; **один движок БД — PostgreSQL** (одинаковые миграции и SQL). Отличаются число процессов Go, наличие брокера и **настройки** PG.

+> **Примечание (текущий код vs целевая очередь):** исполнение async jobs идёт через **in-memory `jobs.Registry` в процессе `evobgp-api` / `evobgp-all`**; таблица `job_audit` в миграциях заложена под будущую персистенцию и идемпотентность между процессами. В **reference** Compose отдельный `evobgp-scheduler` **не** читает эту очередь, а вызывает `POST .../modules/{id}/refresh` по HTTP. NATS в compose — для будущей интеграции; см. [docs/architecture.md](../../docs/architecture.md).
+
 > **Опция `microVPS_sqlite`:** один контейнер `evobgp-all` без PG — только если критичен абсолютный минимум контейнеров; иначе **не рекомендуется** как основной путь.

 ---