Denozordec
c6687b2c91
CI / changes (push) Successful in 4s
CI / openapi (push) Has been skipped
CI / go (push) Successful in 20s
CI / bird2 (push) Successful in 15s
CI / docker-images (deploy/docker/bird2/Dockerfile, evobgp-bird2) (push) Successful in 45s
CI / docker-images (deploy/docker/evobgp-agent/Dockerfile, evobgp-agent) (push) Successful in 1m6s
CI / docker-images (deploy/docker/evobgp-web/Dockerfile, evobgp-web) (push) Successful in 51s
CI / docker-images (evobgp-all, 1, deploy/docker/gobinary/Dockerfile, evobgp-all) (push) Successful in 1m27s
CI / docker-images (evobgp-api, 1, deploy/docker/gobinary/Dockerfile, evobgp-api) (push) Successful in 1m32s
CI / docker-images (evobgp-deploy, 0, deploy/docker/gobinary/Dockerfile, evobgp-deploy) (push) Successful in 1m27s
CI / docker-images (evobgp-ingest, 0, deploy/docker/gobinary/Dockerfile, evobgp-ingest) (push) Successful in 1m23s
CI / docker-images (evobgp-node, 0, deploy/docker/gobinary/Dockerfile, evobgp-node) (push) Successful in 1m21s
CI / docker-images (evobgp-render, 0, deploy/docker/gobinary/Dockerfile, evobgp-render) (push) Successful in 1m31s
CI / docker-images (evobgp-scheduler, 0, deploy/docker/gobinary/Dockerfile, evobgp-scheduler) (push) Successful in 1m24s
2.0 KiB
2.0 KiB
Документация EvoBGP
Структурированные материалы по проекту на русском языке. Детальный перечень полей и ответов HTTP API — в openapi.yaml (OpenAPI 3.1).
По роли читателя
- Оператор / DevOps — quickstart.md, architecture.md, access.md, deploy/compose/docker-compose.yaml.
- Разработчик бэкенда или интегратор API — api.md, access.md, openapi.yaml, исходники маршрутов в
internal/httpapi/. - Разработчик фронтенда — quickstart.md (раздел про
web/и CORS), api.md, ../web/README.md.
Оглавление
| Раздел | Описание |
|---|---|
| overview.md | Ключевые возможности системы |
| quickstart.md | Быстрый запуск: готовые образы из git.shts.su, Docker Compose, локальный Go, веб |
| architecture.md | Компоненты, потоки данных, пакеты |
| api.md | REST: префикс /v1, публичные маршруты, ссылки на OpenAPI |
| access.md | Выдача доступа: API-ключи, роли, нода, CORS |
| openapi.yaml | Источник правды по контракту API |
| OPENAPI-GITEA.md | Как открыть HTML-документацию API (в т.ч. из Gitea) |
| evobgp-api-sketches.md | Ранний черновик идей API (контекст, не замена OpenAPI) |
Репозиторий и CI
- ../.gitea/README.md — Gitea Actions, runner, сборка образов и push в Container Registry.