mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-05-28 07:49:35 +08:00
116 lines
4.6 KiB
Markdown
116 lines
4.6 KiB
Markdown
---
|
||
sidebar_position: 4
|
||
title: 多节点集群
|
||
description: Master-Agent 模式 — 通过 HTTP 长轮询把备份路由到远程服务器。
|
||
---
|
||
|
||
# 多节点集群
|
||
|
||
BackupX 支持 Master-Agent 模式：备份任务可以指定在哪个节点执行，Agent 在本地完成备份并直接上传到存储。所有连接都由 Agent 主动发起，所以远程服务器只需要出站 HTTP 访问权限。
|
||
|
||
## 架构
|
||
|
||
```
|
||
[Web 控制台] ─── JWT ──→ [Master (backupx)]
|
||
↑ ↓
|
||
│ │ HTTP 长轮询（Token 认证）
|
||
│ ↓
|
||
[Agent (backupx agent)] ← 运行在远程服务器
|
||
↓
|
||
[70+ 存储后端]
|
||
```
|
||
|
||
- **协议** — HTTP 长轮询，Agent 主动发起所有连接
|
||
- **心跳** — Agent 每 15s 上报一次；Master 超过 45s 未收到心跳即判为离线
|
||
- **下发** — Master 把 `run_task` 命令写入队列，Agent 轮询拉取
|
||
- **执行** — Agent 复用 BackupRunner（file / mysql / postgresql / sqlite / saphana）并直接上传到存储
|
||
- **安全** — 每个节点独立 Token；Agent 不持有 Master 的 JWT 密钥或 AES-256 加密密钥
|
||
|
||
## 一键部署步骤
|
||
|
||
### 1. 打开安装向导
|
||
|
||
Web 控制台 → **节点管理** → **添加节点**，打开三步向导：
|
||
|
||
- **第一步 · 节点信息**：填写节点名称；或切换"批量创建"粘贴多行名称（每行一个，最多 50 个）
|
||
- **第二步 · 部署参数**：选择安装模式（`systemd` 推荐、`Docker`、`前台运行` 调试用）、架构（默认自动检测）、Agent 版本（默认跟随 Master 版本）、有效期（5 分钟 / 15 分钟 / 1 小时 / 24 小时）、下载源（`GitHub` 直连或 `ghproxy` 镜像，国内服务器建议后者）
|
||
- **第三步 · 安装命令**：一行 `curl ... | sudo sh` 命令 + 实时倒计时。点击复制，粘贴到目标机以 root 权限执行
|
||
|
||
### 2. 目标机一条命令完成
|
||
|
||
示例（systemd 模式）：
|
||
|
||
```bash
|
||
curl -fsSL https://master.example.com/install/Xk3p9...vM | sudo sh
|
||
```
|
||
|
||
脚本会自动：
|
||
|
||
1. 检测操作系统与架构（`uname -m`）
|
||
2. 从 GitHub Release（或 ghproxy 镜像）下载匹配的 `backupx` 二进制
|
||
3. 安装到 `/opt/backupx-agent`，创建系统用户 `backupx`
|
||
4. 写入 `/etc/systemd/system/backupx-agent.service`（token 已烧入环境变量）
|
||
5. 执行 `systemctl enable --now backupx-agent`
|
||
6. 轮询 `/api/v1/agent/self`，直到 Master 确认 `status: online`（最多 30 秒）
|
||
|
||
脚本是幂等的：升级或重装只需重新生成一条安装命令再跑一次。一次性安装链接在 TTL 到期或被首次消费后立即作废。
|
||
|
||
### 3. 随时轮换 Agent Token
|
||
|
||
节点操作列（︙）→ **重新生成 Token**。新 Token 一次性显示，旧 Token 24 小时内仍有效，便于滚动替换无需停机。24 小时后旧 Token 被拒绝。
|
||
|
||
### 4. 批量部署
|
||
|
||
第一步选"批量创建"粘贴节点名（每行一个，最多 50 个）。第三步显示每个节点对应的命令表格，底部「导出 .sh」可打包为单个 shell 文件，方便 SSH 循环或 Ansible 任务。
|
||
|
||
### 5. 把任务路由到该节点
|
||
|
||
在 **备份任务** 页面新建任务时选择对应节点。任务触发时：
|
||
|
||
- 本机 / 未指定（`nodeId=0`）：Master 进程内直接执行
|
||
- 远程节点：Master 写入命令队列 → Agent 拉取 → Agent 本地执行 → 上传 → 回报
|
||
|
||
## 已知限制
|
||
|
||
- **Agent 不支持加密备份**：Agent 不持有 Master 的 AES-256 密钥。`encrypt: true` 的任务路由到 Agent 时会直接上报失败
|
||
- **目录浏览超时**：远程目录浏览通过命令队列做同步 RPC，默认 15s 超时
|
||
- **派发命令超时**：Agent 领取但未完成的命令超过 10 分钟会被置 `timeout`
|
||
|
||
## CLI 参考
|
||
|
||
```
|
||
backupx agent --help
|
||
-master string Master URL
|
||
-token string Agent 认证令牌
|
||
-config string YAML 配置文件路径（优先级高于环境变量）
|
||
-temp-dir string 本地临时目录（默认 /tmp/backupx-agent）
|
||
-insecure-tls 跳过 TLS 证书校验（仅测试用）
|
||
```
|
||
|
||
## systemd 单元
|
||
|
||
```ini title="/etc/systemd/system/backupx-agent.service"
|
||
[Unit]
|
||
Description=BackupX Agent
|
||
After=network.target
|
||
|
||
[Service]
|
||
Type=simple
|
||
User=backupx
|
||
Environment="BACKUPX_AGENT_MASTER=https://master.example.com"
|
||
Environment="BACKUPX_AGENT_TOKEN=your-token"
|
||
ExecStart=/opt/backupx/backupx agent
|
||
Restart=on-failure
|
||
RestartSec=10s
|
||
|
||
[Install]
|
||
WantedBy=multi-user.target
|
||
```
|
||
|
||
启用并启动：
|
||
|
||
```bash
|
||
sudo systemctl enable --now backupx-agent
|
||
sudo journalctl -u backupx-agent -f
|
||
```
|