Denozordec
7fac79c2e0
CI / changes (push) Successful in 5s
CI / openapi (push) Has been skipped
CI / go (push) Successful in 19s
CI / bird2 (push) Successful in 15s
CI / docker-images (deploy/docker/bird2/Dockerfile, , evobgp-bird2) (push) Successful in 39s
CI / docker-images (deploy/docker/evobgp-agent/Dockerfile, , evobgp-agent) (push) Successful in 1m7s
CI / docker-images (deploy/docker/evobgp-web/Dockerfile, , evobgp-web) (push) Successful in 56s
CI / docker-images (deploy/docker/evobgp-web/Dockerfile, evobgp-all, evobgp-web-all) (push) Successful in 53s
CI / docker-images (evobgp-all, 1, deploy/docker/gobinary/Dockerfile, , evobgp-all) (push) Successful in 1m26s
CI / docker-images (evobgp-api, 1, deploy/docker/gobinary/Dockerfile, , evobgp-api) (push) Successful in 1m27s
CI / docker-images (evobgp-deploy, 0, deploy/docker/gobinary/Dockerfile, , evobgp-deploy) (push) Successful in 1m31s
CI / docker-images (evobgp-ingest, 0, deploy/docker/gobinary/Dockerfile, , evobgp-ingest) (push) Successful in 1m36s
CI / docker-images (evobgp-node, 0, deploy/docker/gobinary/Dockerfile, , evobgp-node) (push) Successful in 1m20s
CI / docker-images (evobgp-render, 0, deploy/docker/gobinary/Dockerfile, , evobgp-render) (push) Successful in 1m30s
CI / docker-images (evobgp-scheduler, 0, deploy/docker/gobinary/Dockerfile, , evobgp-scheduler) (push) Successful in 1m23s
47 lines
2.6 KiB
Markdown
47 lines
2.6 KiB
Markdown
# EvoBGP
|
||
|
||
Control plane для управления префиксами, модулями ingest, ревизиями конфигурации BIRD и выкладкой на BGP-спикеры. Репозиторий включает HTTP API на Go, веб-интерфейс (`web/`), CLI для реплик (`evobgp-node`), агент и Docker Compose для локального и эталонного развёртывания.
|
||
|
||
## Документация
|
||
|
||
| Документ | Содержание |
|
||
|----------|------------|
|
||
| [docs/README.md](docs/README.md) | Оглавление и навигация по разделам |
|
||
| [docs/overview.md](docs/overview.md) | Ключевые возможности продукта |
|
||
| [docs/quickstart.md](docs/quickstart.md) | Быстрый запуск (Docker, локально, фронтенд) |
|
||
| [docs/architecture.md](docs/architecture.md) | Архитектура компонентов и потоков данных |
|
||
| [docs/api.md](docs/api.md) | Как работать с REST API и OpenAPI |
|
||
| [docs/access.md](docs/access.md) | API-ключи, роли, нода, CORS, безопасность |
|
||
|
||
Контракт HTTP API: [docs/openapi.yaml](docs/openapi.yaml). Человекочитаемый просмотр: [docs/openapi.html](docs/openapi.html) (см. [docs/OPENAPI-GITEA.md](docs/OPENAPI-GITEA.md)).
|
||
|
||
## Быстрый старт (Docker)
|
||
|
||
Из каталога [deploy/compose](deploy/compose) (PowerShell):
|
||
|
||
```powershell
|
||
cd deploy\compose
|
||
Copy-Item .env.example .env -Force # EVOBGP_REGISTRY=git.shts.su/<owner>
|
||
docker login git.shts.su
|
||
docker compose --profile microvps pull
|
||
docker compose --profile microvps up -d
|
||
```
|
||
|
||
Профиль **microvps** поднимает `evobgp-all`, PostgreSQL, BIRD2 и агент (образы из Container Registry, без `--build`). API по умолчанию: `http://localhost:8080`.
|
||
|
||
Эталонный стек (несколько сервисов, NATS, веб UI, Prometheus):
|
||
|
||
```powershell
|
||
docker compose --profile reference pull
|
||
docker compose --profile reference up -d
|
||
```
|
||
|
||
Подробности портов и переменных окружения — в [docs/quickstart.md](docs/quickstart.md) и в комментариях в [deploy/compose/docker-compose.yaml](deploy/compose/docker-compose.yaml).
|
||
|
||
## Разработка
|
||
|
||
- **Go:** модуль `evobgp`, точки входа в `cmd/`.
|
||
- **Веб:** SvelteKit в каталоге `web/` (см. [web/README.md](web/README.md)).
|
||
|
||
Лицензия и условия использования — по политике владельца репозитория.
|