Files
homelab-infra/docs/netbird/design.md
T

63 lines
4.2 KiB
Markdown

# NetBird: архитектура overlay-сети
Статус: **установка панели**. Хост — `central.gunihome.ru`. Эталон файлов лежит в `services/netbird/`.
## Задача
NetBird — транспортный фундамент новой инфраструктуры. Новый хост (VPS, LXC, ВМ, ноутбук) сначала вступает в overlay и только потом получает сервисы.
Сервис не привязан к имени будущей машины. Меняется хост — меняется цель доставки, состав `services/netbird/` остаётся тем же.
## Компоненты
| Компонент | Назначение | Порты |
| --- | --- | --- |
| `netbird-server` 0.82.0 | management, signal, relay и STUN в одном контейнере | 443/tcp через Traefik, 3478/udp |
| Dashboard | веб-панель | 443/tcp через Traefik |
| Traefik v3.7.14 | сертификат Let's Encrypt и маршрутизация | 80/tcp, 443/tcp |
| Встроенный вход | пользователи панели без отдельного Zitadel | — |
Манифесты живут в `services/netbird/` и доставляются сценарием Gitea Actions. Официальный установщик — ориентир по составу контейнеров, не способ запуска.
## Требования к VPS
| Параметр | Минимум | Комментарий |
| --- | --- | --- |
| CPU / RAM | 1 vCPU / 1 ГБ | запас — 2 vCPU / 2 ГБ |
| Диск | 20 ГБ | база management растёт медленно |
| Сеть | белый IPv4 | стабильность важнее локации |
| ОС | Ubuntu 24.04 или Debian 12+ | baseline хоста тоже из этого репозитория |
| Порты | 80, 443/tcp; 3478/udp | signal и API идут через 443 |
80/tcp нужен на выпуск Let's Encrypt. Дальше трафик панели и management идёт на 443.
## Адресация и группы
Overlay NetBird — `100.64.0.0/10`.
Группы описывают роль пира, не имя хоста. Состав группы меняется без смены политики.
| Группа | Кто в ней | Политика |
| --- | --- | --- |
| `infra-core` | management и будущие управляющие узлы | DNS и маршруты, которые нужны остальным группам |
| `servers` | VPS с сервисами | SSH из `admin` |
| `workstations` | ПК и ноутбуки | доступ к `servers` по ACL |
| `iot` | умный дом, камеры | только явно разрешённые направления |
Политика по умолчанию — default-deny.
## Решения до аренды VPS
1. **Домен.** `central.gunihome.ru`, A-запись на адрес VPS создана вручную.
2. **IdP.** На старте встроенный вход панели. Внешний IdP — отдельное решение, когда появится общий SSO.
3. **Хостинг.** Провайдер и локация. На состав сервиса не влияют.
4. **Бэкап базы management.** Куда складывать снимок и как часто. Решить до появления пиров кроме рабочей станции.
## Развёртывание
1. Цель доставки — `central.gunihome.ru`. Отдельного каталога хоста нет.
2. Сценарий `netbird-install` запускает плейбук `services/netbird/playbook.yml`. Плейбук ставит Docker, открывает порты из таблицы выше и поднимает панель.
3. Сертификат выпускает Traefik. Первый администратор создаётся на `/setup`.
4. Группы и политики из этого документа задаются уже в панели.
5. Первый пир — рабочая станция. Проверка: пинг по overlay-адресу и SSH на management по адресу NetBird.