This commit is contained in:
karpenok committed 2026-11-07 23:35:46 +07:00
1 parent e5f1ca24e5
commit 4a23e17290
6 files changed
+62 -137

No files matched your search

+36 -42
View File
@@ -1,69 +1,63 @@
# NetBird: архитектура overlay-сети
Статус: **проект (этап 0)**. VPS ещё не арендован — документ фиксирует принципы и открытые решения до начала развёртывания.
Статус: **проект**. VPS ещё не арендован. Документ фиксирует состав сервиса и решения, которые нужны до развёртывания.
## Задача
Построить overlay-сеть WireGuard (NetBird) как транспортный фундамент будущей инфраструктуры. Любой новый хост (VPS, LXC, ВМ, ноутбук) сначала вступает в сеть NetBird и только потом получает сервисы. Прямые SSH-связки «по белым IP» между хостами становятся необязательными.
NetBird — транспортный фундамент новой инфраструктуры. Новый хост (VPS, LXC, ВМ, ноутбук) сначала вступает в overlay и только потом получает сервисы.
## Компоненты NetBird (что разворачиваем на VPS)
Сервис не привязан к имени будущей машины. Меняется хост — меняется цель доставки, состав `services/netbird/` остаётся тем же.
## Компоненты
| Компонент | Назначение | Порты |
| --- | --- | --- |
| Management | control plane: пиры, политики, ключи, координация | 443/tcp, 33073/tcp (gRPC) |
| Signal | обмен метаданными для установления соединений | 10000/tcp |
| Relay (TURN) | ретрансляция при невозможности p2p | 3478/udp |
| Dashboard | веб-панель управления | 443/tcp |
| IdP | аутентификация (встроенный Zitadel из официального установщика — по умолчанию) | — |
| Relay (TURN) | ретрансляция, если p2p не собрался | 3478/udp |
| Dashboard | веб-панель | 443/tcp |
| IdP | аутентификация. На старте — встроенный Zitadel | — |
Официальный путь развёртывания — скрипт `getting-started-with-zitadel.sh` + Docker Compose. Манифесты будут жить в `services/netbird/` и адаптированы под GitOps-доставку (Gitea Actions), а не запускаться руками.
Манифесты живут в `services/netbird/` и рассчитаны на доставку через Gitea Actions. Официальный установщик — ориентир по составу контейнеров, не способ запуска в проде.
## Требования к арендуемому VPS
## Требования к VPS
| Параметр | Минимум | Комментарий |
| --- | --- | --- |
| CPU / RAM | 1 vCPU / 1 ГБ | management лёгкий; запас — 2 vCPU / 2 ГБ |
| Диск | 20 ГБ | БД management (SQLite/Postgres) растёт медленно |
| Сеть | белый IP, IPv4 | стабильность важнее локации; пинг до дома < 100 мс желательно |
| ОС | Ubuntu 24.04 / Debian 12+ | под baseline-роль |
| Порты | 80, 443, 33073/tcp; 3478/udp | 10000/tcp если signal на том же хосте |
| CPU / RAM | 1 vCPU / 1 ГБ | запас — 2 vCPU / 2 ГБ |
| Диск | 20 ГБ | база management растёт медленно |
| Сеть | белый IPv4 | стабильность важнее локации |
| ОС | Ubuntu 24.04 или Debian 12+ | baseline хоста тоже из этого репозитория |
| Порты | 80, 443, 33073/tcp; 3478/udp | 10000/tcp, если signal на том же хосте |
80/tcp нужен только на выпуск Let's Encrypt; далее весь трафик — 443.
80/tcp нужен на выпуск Let's Encrypt. Дальше трафик панели и management идёт на 443.
## Принципы адресации и групп
## Адресация и группы
Overlay-адреса NetBird (100.64.0.0/10) не пересекаются с LAN 192.168.1.0/24 — конфликтов маршрутизации не будет.
Overlay NetBird — `100.64.0.0/10`.
Группы (проект, подлежит уточнению при первом развёртывании):
Группы описывают роль пира, не имя хоста. Состав группы меняется без смены политики.
| Группа | Содержимое (будущее) | Политика (проект) |
| Группа | Кто в ней | Политика |
| --- | --- | --- |
| `infra-core` | management VPS, будущие управляющие узлы | доступно всем группам (DNS/маршруты) |
| `servers` | боевые VPS | SSH из `admin` |
| `homelab` | домашние LXC/ВМ после миграции | SSH из `admin`, сервисы внутри группы |
| `workstations` | ПК, ноутбуки | доступ к `servers` и `homelab` по ACL |
| `iot` | умный дом, камеры | изолированно, только нужное |
| `infra-core` | management и будущие управляющие узлы | DNS и маршруты, которые нужны остальным группам |
| `servers` | VPS с сервисами | SSH из `admin` |
| `workstations` | ПК и ноутбуки | доступ к `servers` по ACL |
| `iot` | умный дом, камеры | только явно разрешённые направления |
Политики по умолчанию: запрет всего, что не разрешено явно (default-deny).
Политика по умолчанию — default-deny.
## Открытые решения (принять до развёртывания)
## Решения до аренды VPS
1. **Домен** — поддомен `gunihome.ru` (например, `nb.gunihome.ru`). Кто добавляет DNS-запись: вручную или через API провайдера (для будущей автоматизации)?
2. **IdP** — встроенный Zitadel (проще, рекомендация для старта) или внешний (Keycloak/Authentik — позже, если появится единый SSO).
3. **Хостинг** — провайдер и локация выбраны? Влияет только на пинг/цену.
4. **Бэкапы management** — SQLite/Postgres management: периодический снимок в существующий PBS (`192.168.1.49`) или внешнее хранилище. Решить до продакшн-нагрузки.
1. **Домен.** Поддомен `gunihome.ru` для management и dashboard. Кто создаёт DNS-запись: вручную или через API.
2. **IdP.** На старте встроенный Zitadel. Внешний IdP — отдельное решение, когда появится общий SSO.
3. **Хостинг.** Провайдер и локация. На состав сервиса не влияют.
4. **Бэкап базы management.** Куда складывать снимок и как часто. Решить до появления пиров кроме рабочей станции.
## План развёртывания (кратко)
## Развёртывание
1. Аренда VPS → запись в `INVENTORY.md` + hosts/.
2. Baseline хоста: пользователь `deploy`, SSH-ключ, firewall (только нужные порты), Docker — **через код** (первый Ansible-плейбук или bootstrap-скрипт репозитория).
3. `services/netbird/` → commit → доставка на VPS (на этапе 1 — вручную через SSH по готовому runbook, Gitea Actions подключаем сразу после).
4. Выпуск сертификата, вход в dashboard, создание групп и политик из раздела выше.
5. Первый пир — рабочая станция (CachyOS). Проверка: пинг по overlay-адресу, SSH через NetBird IP.
6. Только после этого — подключение остальных хостов по одному.
## Что сознательно не делаем сейчас
- Миграция существующих сервисов и хостов в overlay — отдельный этап, отдельный план.
- Отказ от старой сети 192.168.1.0/24 — нет, она остаётся legacy до миграции.
- Развёртывание NetBird на `golova` (там уже есть инстанс) — не трогаем; новый management поднимаем на чистом VPS.
1. Аренда VPS. В репозитории появляется цель доставки, не отдельный каталог «хост».
2. Baseline через код: пользователь `deploy`, SSH-ключ, firewall на порты из таблицы выше, Docker.
3. Манифесты `services/netbird/` коммитятся и доставляются на VPS. Пока runner не подключён — по runbook из `services/netbird/README.md`, сразу следом — Gitea Actions.
4. Сертификат, вход в dashboard, группы и политики из этого документа.
5. Первый пир — рабочая станция. Проверка: пинг по overlay-адресу и SSH на management по адресу NetBird.