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
189 lines
11 KiB
Markdown
189 lines
11 KiB
Markdown
# Быстрый запуск
|
||
|
||
Примеры команд для **PowerShell**. Репозиторий: корень `EvoBGP`, Docker Compose лежит в `deploy\compose`.
|
||
|
||
## Требования
|
||
|
||
- **Docker** с поддержкой Compose v2 — для готового стека.
|
||
- **Go 1.22+** (версию см. в `go.mod`) — для локального запуска бинарников из исходников.
|
||
- **Node.js** и npm — для разработки веб-интерфейса в `web/`.
|
||
- **PostgreSQL** — если запускаете API вне Compose; строка подключения в `EVOBGP_DATABASE_URL`.
|
||
|
||
## Готовые образы без сборки (Container Registry Gitea)
|
||
|
||
После успешного CI (push в `main` или `master`) образы публикуются в **Container Registry** вашего Gitea. В workflow зафиксирован хост реестра **`git.shts.su`**; имя владельца в пути образа — **в нижнем регистре**, как у `github.repository_owner` в CI (например, пользователь `Denozord` → префикс `denozord`).
|
||
|
||
### Шаблон имени и теги
|
||
|
||
```text
|
||
git.shts.su/<owner>/<имя_образа>:<тег>
|
||
```
|
||
|
||
**Теги:** `latest`, короткий SHA коммита (7 символов), `sha-<полный_sha>` — см. [.gitea/README.md](../.gitea/README.md).
|
||
|
||
**Платформа образов из CI:** `linux/amd64` (на другой архитектуре pull пройдёт, но запуск может быть невозможен без своей сборки).
|
||
|
||
### Вход в реестр (если пакеты не публичные)
|
||
|
||
На сервере или в PowerShell перед `docker pull`:
|
||
|
||
```powershell
|
||
docker login git.shts.su
|
||
```
|
||
|
||
Укажите учётную запись Gitea и **PAT / пароль приложения** с правом чтения пакетов (или токен, который принимает ваш реестр).
|
||
|
||
### Ссылки и команды `docker pull`
|
||
|
||
Ниже пример для владельца **`denozord`** — замените сегмент пути на своего владельца репозитория в нижнем регистре. В веб-интерфейсе все контейнерные пакеты можно открыть разом: [список пакетов `denozord` на git.shts.su](https://git.shts.su/denozord/-/packages). Если прямая ссылка на версию `latest` не открывается (зависит от версии Gitea), откройте общий список пакетов и выберите нужный образ по имени.
|
||
|
||
| Образ | Назначение | Страница пакета (пример) | Pull |
|
||
|--------|------------|--------------------------|------|
|
||
| `evobgp-api` | HTTP API (с `birdc` в образе) | [packages/…/evobgp-api](https://git.shts.su/denozord/-/packages/container/evobgp-api/latest) | `docker pull git.shts.su/denozord/evobgp-api:latest` |
|
||
| `evobgp-all` | Монолит microVPS: API + заглушки воркеров в одном процессе | [packages/…/evobgp-all](https://git.shts.su/denozord/-/packages/container/evobgp-all/latest) | `docker pull git.shts.su/denozord/evobgp-all:latest` |
|
||
| `evobgp-scheduler` | Планировщик (reference) | [packages/…/evobgp-scheduler](https://git.shts.su/denozord/-/packages/container/evobgp-scheduler/latest) | `docker pull git.shts.su/denozord/evobgp-scheduler:latest` |
|
||
| `evobgp-ingest` | Ingest CDN / ETag | [packages/…/evobgp-ingest](https://git.shts.su/denozord/-/packages/container/evobgp-ingest/latest) | `docker pull git.shts.su/denozord/evobgp-ingest:latest` |
|
||
| `evobgp-render` | Render | [packages/…/evobgp-render](https://git.shts.su/denozord/-/packages/container/evobgp-render/latest) | `docker pull git.shts.su/denozord/evobgp-render:latest` |
|
||
| `evobgp-deploy` | Deploy | [packages/…/evobgp-deploy](https://git.shts.su/denozord/-/packages/container/evobgp-deploy/latest) | `docker pull git.shts.su/denozord/evobgp-deploy:latest` |
|
||
| `evobgp-node` | Нода на площадке | [packages/…/evobgp-node](https://git.shts.su/denozord/-/packages/container/evobgp-node/latest) | `docker pull git.shts.su/denozord/evobgp-node:latest` |
|
||
| `evobgp-web` | Статика UI + nginx | [packages/…/evobgp-web](https://git.shts.su/denozord/-/packages/container/evobgp-web/latest) | `docker pull git.shts.su/denozord/evobgp-web:latest` |
|
||
| `evobgp-agent` | Агент (bird2 в образе) | [packages/…/evobgp-agent](https://git.shts.su/denozord/-/packages/container/evobgp-agent/latest) | `docker pull git.shts.su/denozord/evobgp-agent:latest` |
|
||
| `evobgp-bird2` | Только BIRD2 | [packages/…/evobgp-bird2](https://git.shts.su/denozord/-/packages/container/evobgp-bird2/latest) | `docker pull git.shts.su/denozord/evobgp-bird2:latest` |
|
||
|
||
На **Linux-сервере** команды `docker pull` и `docker login` такие же (выполняйте в обычном shell).
|
||
|
||
### Запуск контейнера с готового образа (минимум)
|
||
|
||
После pull, например только API (порты и переменные подставьте свои):
|
||
|
||
```powershell
|
||
docker run --rm -p 8080:8080 `
|
||
-e EVOBGP_DATABASE_URL="postgres://user:pass@host:5432/evobgp?sslmode=disable" `
|
||
-e EVOBGP_HTTP_ADDR=":8080" `
|
||
git.shts.su/denozord/evobgp-api:latest
|
||
```
|
||
|
||
Для полного стека удобнее **Compose** из репозитория: по умолчанию он собирает из исходников (`--build`). Чтобы использовать **уже скачанные** образы из реестра, задайте в override-файле или правке `deploy/compose/docker-compose.yaml` у сервисов поле **`image:`** вместо **`build:`** с тем же префиксом `git.shts.su/<owner>/...` и тегом (`:latest` или зафиксированный `:sha-...` для воспроизводимости). Подробности CI и имён — [.gitea/README.md](../.gitea/README.md).
|
||
|
||
## Вариант 1: Docker, профиль microvps
|
||
|
||
Один процесс `evobgp-all` (HTTP API + in-process заглушки воркеров), PostgreSQL, BIRD2, `evobgp-agent`.
|
||
|
||
```powershell
|
||
cd deploy\compose
|
||
docker compose --profile microvps up -d --build
|
||
```
|
||
|
||
Ожидаемые сервисы:
|
||
|
||
- **API:** `http://localhost:8080` (внутри контейнера `EVOBGP_HTTP_ADDR=:8080`).
|
||
- **BGP:** порт **179/tcp** проброшен с контейнера BIRD (для отладки; в проде часто нужен `network_mode: host` или отдельная сеть — см. комментарии в `docker-compose.yaml`).
|
||
|
||
Проверка живости (без ключа):
|
||
|
||
```powershell
|
||
Invoke-RestMethod -Uri "http://localhost:8080/v1/health"
|
||
```
|
||
|
||
Остановка:
|
||
|
||
```powershell
|
||
docker compose --profile microvps down
|
||
```
|
||
|
||
Полная очистка томов (осторожно, удалит данные БД):
|
||
|
||
```powershell
|
||
docker compose --profile microvps down -v
|
||
```
|
||
|
||
## Вариант 2: Docker, профиль reference
|
||
|
||
Эталонное разбиение: отдельные контейнеры `evobgp-api`, `evobgp-scheduler`, `evobgp-ingest`, `evobgp-render`, `evobgp-deploy`, NATS JetStream, веб UI за nginx, опционально Prometheus.
|
||
|
||
```powershell
|
||
cd deploy\compose
|
||
docker compose --profile reference up -d --build
|
||
```
|
||
|
||
Полезные порты:
|
||
|
||
| Порт | Назначение |
|
||
|------|------------|
|
||
| 8080 | HTTP API (`evobgp-api`) |
|
||
| 3000 | Веб UI (`evobgp-web` → nginx, прокси на API) |
|
||
| 4222 | NATS |
|
||
| 9090 | Prometheus (в compose) |
|
||
| 179 | BGP (BIRD2) |
|
||
|
||
**Воркеры reference:** `evobgp-scheduler` ходит в API по HTTP (`EVOBGP_CONTROL_PLANE_URL`, `EVOBGP_SCHEDULER_BEARER`); в [docker-compose.yaml](../deploy/compose/docker-compose.yaml) для локального запуска включены `EVOBGP_DEV_INSECURE=1` на API и токен `dev` у планировщика. `evobgp-ingest` обновляет ETag CDN-источников; `evobgp-render` по умолчанию не трогает `published_revision` (включите `EVOBGP_RENDER_AUTOPUBLISH=1` осознанно); `evobgp-deploy` пишет в лог расхождение applied vs published. Очередь `jobs` остаётся in-process у **evobgp-api**; общий брокер — в планах.
|
||
|
||
В **evobgp-all** (microvps) те же пакеты крутятся в одном процессе и используют общий `jobs.Registry` без HTTP.
|
||
|
||
## Вариант 3: Локально без Docker (только API)
|
||
|
||
1. Поднимите PostgreSQL и создайте БД (или используйте существующую).
|
||
2. Установите переменные окружения в текущей сессии PowerShell:
|
||
|
||
```powershell
|
||
$env:EVOBGP_DATABASE_URL = "postgres://user:pass@localhost:5432/evobgp?sslmode=disable"
|
||
$env:EVOBGP_HTTP_ADDR = ":8080"
|
||
# Ключи обязательны для защищённых маршрутов (пример формата см. access.md)
|
||
$env:EVOBGP_API_KEYS = "op|YOUR_TENANT_ID|operator"
|
||
```
|
||
|
||
3. Запуск только HTTP API:
|
||
|
||
```powershell
|
||
cd <корень-клона-репозитория>
|
||
go run .\cmd\evobgp-api
|
||
```
|
||
|
||
Или монолит **microVPS** (тот же API плюс горутины заглушек scheduler/ingest/render/deploy):
|
||
|
||
```powershell
|
||
go run .\cmd\evobgp-all
|
||
```
|
||
|
||
При старте в лог выводится **публичный ключ бандла** (base64) — его нужно передать на сторону `evobgp-node` для проверки подписи. При включённом демо-сиде (`EVOBGP_SEED_DEMO` не равен `0`, поведение по умолчанию) сервер также печатает подсказку с примером `EVOBGP_API_KEYS`.
|
||
|
||
Для разработки без настройки ключей (только демо-данные):
|
||
|
||
```powershell
|
||
$env:EVOBGP_DEV_INSECURE = "1"
|
||
go run .\cmd\evobgp-api
|
||
```
|
||
|
||
Запросы с заголовком `Authorization: Bearer dev` получают роль operator в демо-tenant. **Не включайте в продакшене.**
|
||
|
||
## Вариант 4: Веб-интерфейс (разработка)
|
||
|
||
```powershell
|
||
cd web
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
Укажите в окружении API список разрешённых origin для CORS (пример для Vite на порту 5173):
|
||
|
||
```powershell
|
||
$env:EVOBGP_CORS_ORIGINS = "http://localhost:5173,http://127.0.0.1:5173"
|
||
```
|
||
|
||
В эталонном Compose для `evobgp-api` уже заданы origin для 5173 и 3000 — см. `deploy/compose/docker-compose.yaml`.
|
||
|
||
## Пересборка HTML из OpenAPI
|
||
|
||
После правок `docs/openapi.yaml`:
|
||
|
||
```powershell
|
||
.\scripts\build-openapi-html.ps1
|
||
```
|
||
|
||
Подробности — [OPENAPI-GITEA.md](OPENAPI-GITEA.md).
|
||
|
||
## Дальше
|
||
|
||
- [access.md](access.md) — как выдать ключи и настроить ноду.
|
||
- [architecture.md](architecture.md) — состав сервисов и пакетов.
|