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
@@ -18,7 +18,7 @@ const (
 	StatusCancelled = "cancelled"
 )

-// Job is the API-facing job model (maps to job_audit).
+// Job is the API-facing job model (поля согласованы со схемой job_audit в миграциях; персистенция в БД пока не подключена).
 type Job struct {
 	ID               string
 	TenantID         string
@@ -148,7 +148,9 @@ func (j *Job) Snapshot() map[string]any {
 	return m
 }

-// Registry tracks jobs in memory (microVPS-style single process; swap for PG + SKIP LOCKED later).
+// Registry — in-memory очередь и индекс по idempotency в процессе, где поднят HTTP API (evobgp-api и evobgp-all).
+// Отдельные воркеры в reference-профиле не разделяют память с API: scheduler дергает refresh по HTTP; см. docs/architecture.md.
+// Запись задач в PostgreSQL job_audit + SKIP LOCKED / внешний брокер — планируемое расширение (архитектурный план §2, §7.10).
 type Registry struct {
 	mu          sync.RWMutex
 	byID        map[string]*Job