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

70 lines
5.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# NetBird: архитектура overlay-сети
Статус: **проект (этап 0)**. VPS ещё не арендован — документ фиксирует принципы и открытые решения до начала развёртывания.
## Задача
Построить overlay-сеть WireGuard (NetBird) как транспортный фундамент будущей инфраструктуры. Любой новый хост (VPS, LXC, ВМ, ноутбук) сначала вступает в сеть NetBird и только потом получает сервисы. Прямые SSH-связки «по белым IP» между хостами становятся необязательными.
## Компоненты NetBird (что разворачиваем на VPS)
| Компонент | Назначение | Порты |
| --- | --- | --- |
| Management | control plane: пиры, политики, ключи, координация | 443/tcp, 33073/tcp (gRPC) |
| Signal | обмен метаданными для установления соединений | 10000/tcp |
| Relay (TURN) | ретрансляция при невозможности p2p | 3478/udp |
| Dashboard | веб-панель управления | 443/tcp |
| IdP | аутентификация (встроенный Zitadel из официального установщика — по умолчанию) | — |
Официальный путь развёртывания — скрипт `getting-started-with-zitadel.sh` + Docker Compose. Манифесты будут жить в `services/netbird/` и адаптированы под GitOps-доставку (Gitea Actions), а не запускаться руками.
## Требования к арендуемому 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 на том же хосте |
80/tcp нужен только на выпуск Let's Encrypt; далее весь трафик — 443.
## Принципы адресации и групп
Overlay-адреса NetBird (100.64.0.0/10) не пересекаются с LAN 192.168.1.0/24 — конфликтов маршрутизации не будет.
Группы (проект, подлежит уточнению при первом развёртывании):
| Группа | Содержимое (будущее) | Политика (проект) |
| --- | --- | --- |
| `infra-core` | management VPS, будущие управляющие узлы | доступно всем группам (DNS/маршруты) |
| `servers` | боевые VPS | SSH из `admin` |
| `homelab` | домашние LXC/ВМ после миграции | SSH из `admin`, сервисы внутри группы |
| `workstations` | ПК, ноутбуки | доступ к `servers` и `homelab` по ACL |
| `iot` | умный дом, камеры | изолированно, только нужное |
Политики по умолчанию: запрет всего, что не разрешено явно (default-deny).
## Открытые решения (принять до развёртывания)
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. Аренда 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.