feat(netbird): плейбук и манифесты панели для запуска из Gitea

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
karpenokandCursor committed 2026-11-08 00:51:28 +07:00
1 parent 4a23e17290
commit a1573775ef
12 files changed
+491 -24

No files matched your search

+8
View File
@@ -0,0 +1,8 @@
# Пример переменных. На хосте файл называется .env и создаётся плейбуком при первом запуске.
# Значения ключей сюда не записывать.
COMPOSE_PROJECT_NAME=netbird
NETBIRD_LETSENCRYPT_EMAIL=
NETBIRD_AUTH_SECRET=
NETBIRD_DATASTORE_KEY=
NETBIRD_SESSION_KEY=
+13 -6
View File
@@ -1,11 +1,18 @@
# services/netbird
Манифесты NetBird: management, signal, relay, dashboard.
Эталон панели NetBird `0.82.0` для `https://central.gunihome.ru`.
Появятся после аренды VPS и ответов на вопросы из `docs/netbird/design.md`:
Установку делает Ansible-плейбук `playbook.yml`. Сценарий Gitea Actions только запускает его. Состав контейнеров совпадает с официальным установщиком релиза v0.82.0: `netbird-server`, панель и Traefik.
- `docker-compose.yml` — сервисы NetBird
- `management.json.template` — конфигурация с плейсхолдерами `${VAR}`
- runbook развёртывания в этом файле
| Файл | Назначение |
| --- | --- |
| `playbook.yml` | Плейбук: пакеты, firewall, ключи, запуск панели |
| `compose.yaml` | Сервисы, порты `80/tcp`, `443/tcp`, `3478/udp` |
| `templates/config.yaml.j2` | Шаблон сервера. Ключи подставляет плейбук |
| `templates/env.j2` | Шаблон `.env` для Compose |
| `dashboard.env` | Публичные адреса панели |
| `.env.example` | Имена переменных без значений |
Секреты (домен, ключи шифрования, пароли TURN, IdP) задаются переменными. Значения лежат в Gitea Actions Secrets или в локальном `.env`, который не коммитится.
`.env` и готовый `config.yaml` остаются на хосте в `/opt/netbird`. В git их нет. Повторный прогон не пересоздаёт ключи и не удаляет тома `netbird_data` и `netbird_traefik_letsencrypt`.
Кнопка запуска — сценарий `.gitea/workflows/netbird-install.yml`. В его журнале виден вывод плейбука: каждая задача отдельной строкой. После зелёного прогона первый администратор создаётся в браузере на `https://central.gunihome.ru/setup`.
+156
View File
@@ -0,0 +1,156 @@
# Панель NetBird по образцу getting-started.sh из релиза v0.82.0.
# Встроенный Traefik выпускает сертификат Let's Encrypt и ведёт трафик на панель и сервер.
# Секрет почты и ключи подставляются из .env, который создаётся на хосте и в git не попадает.
name: netbird
services:
traefik:
image: traefik:v3.7.14
container_name: netbird-traefik
restart: unless-stopped
networks:
netbird:
ipv4_address: 172.30.0.10
command:
- "--log.level=INFO"
- "--accesslog=true"
- "--providers.docker=true"
- "--providers.docker.exposedbydefault=false"
- "--providers.docker.network=netbird_netbird"
- "--entrypoints.web.address=:80"
- "--entrypoints.websecure.address=:443"
- "--entrypoints.websecure.allowACMEByPass=true"
- "--entrypoints.web.http.aliasHeadersStrategy=delete"
- "--entrypoints.websecure.http.aliasHeadersStrategy=delete"
- "--entrypoints.websecure.transport.respondingTimeouts.readTimeout=0"
- "--entrypoints.websecure.transport.respondingTimeouts.writeTimeout=0"
- "--entrypoints.websecure.transport.respondingTimeouts.idleTimeout=0"
- "--entrypoints.web.http.redirections.entrypoint.to=websecure"
- "--entrypoints.web.http.redirections.entrypoint.scheme=https"
- "--certificatesresolvers.letsencrypt.acme.email=${NETBIRD_LETSENCRYPT_EMAIL}"
- "--certificatesresolvers.letsencrypt.acme.storage=/letsencrypt/acme.json"
- "--certificatesresolvers.letsencrypt.acme.tlschallenge=true"
- "--serverstransport.forwardingtimeouts.responseheadertimeout=0s"
- "--serverstransport.forwardingtimeouts.idleconntimeout=0s"
- "--ping=true"
- "--ping.entrypoint=ping"
- "--entrypoints.ping.address=:8082"
ports:
- "443:443"
- "80:80"
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
- netbird_traefik_letsencrypt:/letsencrypt
healthcheck:
test: ["CMD", "traefik", "healthcheck", "--ping"]
interval: 5s
timeout: 3s
retries: 10
start_period: 10s
logging:
driver: json-file
options:
max-size: "500m"
max-file: "2"
dashboard:
image: netbirdio/dashboard@sha256:340b13c00b84349572a2acc5605e907cb09250a9e6461c757097eabdb8e02f2c
container_name: netbird-dashboard
restart: unless-stopped
networks: [netbird]
env_file:
- ./dashboard.env
depends_on:
server-health:
condition: service_healthy
labels:
- traefik.enable=true
- traefik.http.routers.netbird-dashboard.rule=Host(`central.gunihome.ru`)
- traefik.http.routers.netbird-dashboard.entrypoints=websecure
- traefik.http.routers.netbird-dashboard.tls=true
- traefik.http.routers.netbird-dashboard.tls.certresolver=letsencrypt
- traefik.http.routers.netbird-dashboard.service=dashboard
- traefik.http.routers.netbird-dashboard.priority=1
- traefik.http.services.dashboard.loadbalancer.server.port=80
logging:
driver: json-file
options:
max-size: "500m"
max-file: "2"
dashboard-health:
image: curlimages/curl:8.22.0
network_mode: service:dashboard
depends_on:
dashboard:
condition: service_started
entrypoint: ["sleep", "infinity"]
healthcheck:
test: ["CMD", "curl", "-fsS", "http://127.0.0.1/"]
interval: 5s
timeout: 3s
retries: 10
start_period: 15s
restart: unless-stopped
netbird-server:
image: netbirdio/netbird-server:0.82.0
container_name: netbird-server
restart: unless-stopped
networks: [netbird]
ports:
- "3478:3478/udp"
volumes:
- netbird_data:/var/lib/netbird
- ./config.yaml:/etc/netbird/config.yaml:ro
command: ["--config", "/etc/netbird/config.yaml"]
labels:
- traefik.enable=true
- traefik.http.routers.netbird-grpc.rule=Host(`central.gunihome.ru`) && (PathPrefix(`/signalexchange.SignalExchange/`) || PathPrefix(`/management.ManagementService/`) || PathPrefix(`/management.ProxyService/`))
- traefik.http.routers.netbird-grpc.entrypoints=websecure
- traefik.http.routers.netbird-grpc.tls=true
- traefik.http.routers.netbird-grpc.tls.certresolver=letsencrypt
- traefik.http.routers.netbird-grpc.service=netbird-server-h2c
- traefik.http.routers.netbird-grpc.priority=100
- traefik.http.routers.netbird-backend.rule=Host(`central.gunihome.ru`) && (PathPrefix(`/relay`) || PathPrefix(`/ws-proxy/`) || PathPrefix(`/api`) || PathPrefix(`/oauth2`))
- traefik.http.routers.netbird-backend.entrypoints=websecure
- traefik.http.routers.netbird-backend.tls=true
- traefik.http.routers.netbird-backend.tls.certresolver=letsencrypt
- traefik.http.routers.netbird-backend.service=netbird-server
- traefik.http.routers.netbird-backend.priority=100
- traefik.http.services.netbird-server.loadbalancer.server.port=80
- traefik.http.services.netbird-server-h2c.loadbalancer.server.port=80
- traefik.http.services.netbird-server-h2c.loadbalancer.server.scheme=h2c
logging:
driver: json-file
options:
max-size: "500m"
max-file: "2"
server-health:
image: curlimages/curl:8.22.0
network_mode: service:netbird-server
depends_on:
netbird-server:
condition: service_started
entrypoint: ["sleep", "infinity"]
healthcheck:
test: ["CMD", "curl", "-fsS", "http://127.0.0.1:9000/health"]
interval: 5s
timeout: 3s
retries: 12
start_period: 20s
restart: unless-stopped
volumes:
netbird_data:
netbird_traefik_letsencrypt:
networks:
netbird:
driver: bridge
ipam:
config:
- subnet: 172.30.0.0/24
gateway: 172.30.0.1
+13
View File
@@ -0,0 +1,13 @@
# Панель за Traefik. Сертификат выпускает Traefik, поэтому LETSENCRYPT_DOMAIN=none.
NETBIRD_MGMT_API_ENDPOINT=https://central.gunihome.ru
NETBIRD_MGMT_GRPC_API_ENDPOINT=https://central.gunihome.ru
AUTH_AUDIENCE=netbird-dashboard
AUTH_CLIENT_ID=netbird-dashboard
AUTH_CLIENT_SECRET=
AUTH_AUTHORITY=https://central.gunihome.ru/oauth2
USE_AUTH0=false
AUTH_SUPPORTED_SCOPES=openid profile email groups
AUTH_REDIRECT_URI=/nb-auth
AUTH_SILENT_REDIRECT_URI=/nb-silent-auth
NGINX_SSL_PORT=443
LETSENCRYPT_DOMAIN=none
+161
View File
@@ -0,0 +1,161 @@
---
# Плейбук панели NetBird. Его запускает сценарий Gitea Actions.
# Повторный прогон не пересоздаёт ключи и не удаляет данные панели.
- name: Установить панель NetBird
hosts: netbird
gather_facts: false
vars:
netbird_dir: /opt/netbird
tasks:
- name: Подготовить Python для Ansible
ansible.builtin.raw: DEBIAN_FRONTEND=noninteractive apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y python3 python3-apt
changed_when: false
- name: Собрать факты
ansible.builtin.setup:
- name: Поставить Docker и firewall
ansible.builtin.apt:
name:
- docker.io
- docker-compose-v2
- ufw
- openssl
- ca-certificates
state: present
update_cache: true
- name: Включить Docker
ansible.builtin.systemd:
name: docker
enabled: true
state: started
- name: Разрешить порты панели
ansible.builtin.command: ufw allow {{ item }}
register: ufw_rule
changed_when: "'added' in (ufw_rule.stdout | lower)"
loop:
- OpenSSH
- 80/tcp
- 443/tcp
- 3478/udp
- name: Проверить состояние firewall
ansible.builtin.command: ufw status
register: ufw_status
changed_when: false
- name: Включить firewall
ansible.builtin.command: ufw --force enable
when: "'Status: active' not in ufw_status.stdout"
changed_when: true
- name: Создать каталог панели
ansible.builtin.file:
path: "{{ netbird_dir }}"
state: directory
owner: root
group: root
mode: "0700"
- name: Проверить, созданы ли уже ключи
ansible.builtin.stat:
path: "{{ netbird_dir }}/.env"
register: netbird_env
- name: Проверить почту Let's Encrypt
ansible.builtin.assert:
that:
- netbird_letsencrypt_email is defined
- netbird_letsencrypt_email | length > 3
fail_msg: Укажите почту Let's Encrypt при запуске плейбука.
when: not netbird_env.stat.exists
- name: Сгенерировать ключи панели
ansible.builtin.shell: openssl rand -base64 32 | tr -d '\n'
register: netbird_generated_keys
changed_when: false
no_log: true
loop:
- auth
- datastore
- session
when: not netbird_env.stat.exists
- name: Запомнить новые ключи
ansible.builtin.set_fact:
netbird_auth_secret: "{{ netbird_generated_keys.results[0].stdout }}"
netbird_datastore_key: "{{ netbird_generated_keys.results[1].stdout }}"
netbird_session_key: "{{ netbird_generated_keys.results[2].stdout }}"
no_log: true
when: not netbird_env.stat.exists
- name: Прочитать сохранённые ключи
ansible.builtin.slurp:
src: "{{ netbird_dir }}/.env"
register: netbird_env_raw
no_log: true
when: netbird_env.stat.exists
- name: Разобрать сохранённые ключи
ansible.builtin.set_fact:
netbird_auth_secret: "{{ env_map['NETBIRD_AUTH_SECRET'] }}"
netbird_datastore_key: "{{ env_map['NETBIRD_DATASTORE_KEY'] }}"
netbird_session_key: "{{ env_map['NETBIRD_SESSION_KEY'] }}"
netbird_letsencrypt_email: "{{ env_map['NETBIRD_LETSENCRYPT_EMAIL'] }}"
vars:
env_lines: "{{ (netbird_env_raw.content | b64decode).splitlines() | reject('equalto', '') | list }}"
env_map: "{{ dict(env_lines | map('split', '=', 1)) }}"
no_log: true
when: netbird_env.stat.exists
- name: Записать .env
ansible.builtin.template:
src: env.j2
dest: "{{ netbird_dir }}/.env"
owner: root
group: root
mode: "0600"
no_log: true
when: not netbird_env.stat.exists
- name: Положить манифесты панели
ansible.builtin.copy:
src: "{{ playbook_dir }}/{{ item }}"
dest: "{{ netbird_dir }}/{{ item }}"
owner: root
group: root
mode: "0644"
loop:
- compose.yaml
- dashboard.env
- name: Собрать config.yaml
ansible.builtin.template:
src: config.yaml.j2
dest: "{{ netbird_dir }}/config.yaml"
owner: root
group: root
mode: "0600"
no_log: true
- name: Поднять панель
ansible.builtin.command: docker compose up -d
args:
chdir: "{{ netbird_dir }}"
register: compose_up
changed_when: "'Started' in compose_up.stderr or 'Created' in compose_up.stderr or 'Recreated' in compose_up.stderr"
- name: Показать состояние контейнеров
ansible.builtin.command: docker compose ps
args:
chdir: "{{ netbird_dir }}"
register: compose_ps
changed_when: false
- name: Итог установки
ansible.builtin.debug:
msg: "{{ compose_ps.stdout_lines + ['Первый вход: https://central.gunihome.ru/setup'] }}"
+34
View File
@@ -0,0 +1,34 @@
# Конфиг netbird-server. Собирает плейбук. Ключи берутся из фактов, не из git.
server:
listenAddress: ":80"
exposedAddress: "https://central.gunihome.ru:443"
stunPorts:
- 3478
metricsPort: 9090
healthcheckAddress: ":9000"
logLevel: "info"
logFile: "console"
authSecret: "{{ netbird_auth_secret }}"
dataDir: "/var/lib/netbird"
auth:
issuer: "https://central.gunihome.ru/oauth2"
signKeyRefreshEnabled: true
sessionCookieEncryptionKey: "{{ netbird_session_key }}"
dashboardRedirectURIs:
- "https://central.gunihome.ru/nb-auth"
- "https://central.gunihome.ru/nb-silent-auth"
cliRedirectURIs:
- "http://localhost:53000/"
reverseProxy:
trustedHTTPProxies:
- "172.30.0.10/32"
trustedPeers:
- "172.30.0.10/32"
store:
engine: "sqlite"
encryptionKey: "{{ netbird_datastore_key }}"
+5
View File
@@ -0,0 +1,5 @@
COMPOSE_PROJECT_NAME=netbird
NETBIRD_LETSENCRYPT_EMAIL={{ netbird_letsencrypt_email }}
NETBIRD_AUTH_SECRET={{ netbird_auth_secret }}
NETBIRD_DATASTORE_KEY={{ netbird_datastore_key }}
NETBIRD_SESSION_KEY={{ netbird_session_key }}