Files
homelab-infra/docs/netbird/design.md
T
2026-11-07 23:35:46 +07:00

64 lines
4.5 KiB
Markdown

# NetBird: архитектура overlay-сети
Статус: **проект**. VPS ещё не арендован. Документ фиксирует состав сервиса и решения, которые нужны до развёртывания.
## Задача
NetBird — транспортный фундамент новой инфраструктуры. Новый хост (VPS, LXC, ВМ, ноутбук) сначала вступает в overlay и только потом получает сервисы.
Сервис не привязан к имени будущей машины. Меняется хост — меняется цель доставки, состав `services/netbird/` остаётся тем же.
## Компоненты
| Компонент | Назначение | Порты |
| --- | --- | --- |
| Management | control plane: пиры, политики, ключи, координация | 443/tcp, 33073/tcp (gRPC) |
| Signal | обмен метаданными для установления соединений | 10000/tcp |
| Relay (TURN) | ретрансляция, если p2p не собрался | 3478/udp |
| Dashboard | веб-панель | 443/tcp |
| IdP | аутентификация. На старте — встроенный 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, 33073/tcp; 3478/udp | 10000/tcp, если signal на том же хосте |
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. **Домен.** Поддомен `gunihome.ru` для management и dashboard. Кто создаёт DNS-запись: вручную или через API.
2. **IdP.** На старте встроенный Zitadel. Внешний IdP — отдельное решение, когда появится общий SSO.
3. **Хостинг.** Провайдер и локация. На состав сервиса не влияют.
4. **Бэкап базы management.** Куда складывать снимок и как часто. Решить до появления пиров кроме рабочей станции.
## Развёртывание
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.