mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-09-29 14:06:36 +08:00
ryan
83a11ead2b
- Introduced OperationSetting component for managing agent configurations. - Updated settings page to include a new tab for operation settings. - Implemented functionality to fetch and update agent parameters such as heartbeat interval, sync interval, and auto-update settings. docs: enhance deployment documentation for agent installation - Added detailed instructions for agent installation using a script. - Included examples for using discovery and agent tokens. - Updated sections on global discovery tokens and agent auto-update features. docs: revise design and development guidelines for V3 - Updated design document to reflect the current state and goals for V3. - Clarified development guidelines to focus on operational experience improvements. ci: add GitHub Actions workflow for agent releases - Created a new workflow to automate the release of agent binaries on GitHub. - Configured the workflow to build binaries for multiple platforms and publish them as releases. feat: implement self-update mechanism for agent - Added updater module to handle checking for and applying updates from GitHub releases. - Implemented logic to restart the agent after a successful update. chore: create install script for agent deployment - Developed a bash script to facilitate the installation of the ATSFlare agent. - The script supports automatic configuration and systemd service creation.
466 lines
11 KiB
Markdown
466 lines
11 KiB
Markdown
# ATSFlare 设计基线（V3）
|
||
|
||
## 1. 文档目的
|
||
|
||
本文档保留当前系统边界、稳定约束与第三版的设计输入。
|
||
|
||
当前结论：
|
||
|
||
* 第一版、第二版已完成并进入归档状态
|
||
* 第三版进入实施阶段
|
||
* 当前代码库的可运行能力，以本文档为唯一设计基线
|
||
|
||
---
|
||
|
||
## 2. 当前产品定位
|
||
|
||
ATSFlare 当前仍定位为**内部自用的反向代理控制面**，不是面向外部租户的 CDN SaaS。
|
||
|
||
当前已经具备的核心能力：
|
||
|
||
* 反代规则管理
|
||
* 配置渲染、发布、激活与回滚
|
||
* Agent 心跳、同步、应用结果上报
|
||
* Nginx 配置写入、校验、reload 与失败回滚
|
||
* HTTPS/TLS 路由支持
|
||
* 证书托管与域名管理
|
||
* 节点预创建、节点专属 `agent_token`、全局 `discovery_token`
|
||
* 配置预览与变更摘要
|
||
|
||
当前默认工作方式：
|
||
|
||
* 所有节点消费同一份全局激活版本
|
||
* 控制面保存状态与配置，不直接 SSH 管理机器
|
||
* Agent 是节点侧唯一落地入口
|
||
|
||
---
|
||
|
||
## 3. 明确保持不做的范围
|
||
|
||
在第三版目标明确前，以下内容仍视为范围外：
|
||
|
||
* 多租户
|
||
* WAF、限流、Bot、防刷
|
||
* 节点分组、差异化下发、灰度百分比发布
|
||
* Redis、消息队列、对象存储、Prometheus
|
||
* 复杂缓存策略、分层缓存、mid-tier
|
||
* 证书自动签发与自动续期
|
||
* 审批流、审计中台、Purge 平台化能力
|
||
* 抽象 `zone`、`origin_pool`、`policy`、`deployment` 等平台对象
|
||
|
||
如果第三版需要引入以上任一能力，必须先补设计，再进入实现。
|
||
|
||
---
|
||
|
||
## 4. 技术基线
|
||
|
||
### 4.1 Server
|
||
|
||
基于 `atsf_server` 单体应用继续演进：
|
||
|
||
* Web 框架：Gin
|
||
* ORM：GORM
|
||
* 数据库：SQLite
|
||
* 管理端前端：`atsf_server/web`
|
||
* 用户鉴权：沿用现有 ATSFlare 登录体系
|
||
|
||
默认不以新基础设施为前提：
|
||
|
||
* 不依赖 Redis
|
||
* 不依赖 MQ
|
||
* 不依赖外部对象存储
|
||
|
||
### 4.2 Agent
|
||
|
||
基于 `atsf_agent` Go 单体程序继续演进：
|
||
|
||
* 单二进制
|
||
* 节点本地执行
|
||
* 优先使用独立 Nginx
|
||
* 显式配置 `nginx_path` 时直接调用该路径
|
||
* 未配置 `nginx_path` 时默认使用 Docker Nginx 容器
|
||
* 生成资源默认落在 `./data`，可由 `data_dir` 覆盖
|
||
|
||
### 4.3 Nginx 管理边界
|
||
|
||
控制面当前只管理以下内容：
|
||
|
||
* 反向代理路由配置
|
||
* 控制面托管证书对应的本地证书文件
|
||
|
||
仍不管理以下内容：
|
||
|
||
* `nginx.conf`
|
||
* upstream 高级编排
|
||
* 复杂缓存策略
|
||
* 节点级系统运维逻辑
|
||
|
||
---
|
||
|
||
## 5. 当前总体架构
|
||
|
||
```text
|
||
ATSFlare Server (Gin + SQLite + Web UI)
|
||
|
|
||
| HTTP API / Config Pull
|
||
v
|
||
ATSFlare Agent (heartbeat / sync / apply / report)
|
||
|
|
||
v
|
||
Local Nginx or Docker Nginx
|
||
|
|
||
v
|
||
Origin
|
||
```
|
||
|
||
设计原则保持不变：
|
||
|
||
* Server 负责配置、版本、节点状态
|
||
* Agent 负责本地落盘、校验、reload、回滚
|
||
* 发布通过“生成新版本并激活”完成
|
||
* 历史版本不可变
|
||
|
||
---
|
||
|
||
## 6. 核心对象
|
||
|
||
### 6.1 `proxy_routes`
|
||
|
||
表示一条 `domain -> origin_url` 的反向代理规则。
|
||
|
||
关键字段：
|
||
|
||
* `domain`
|
||
* `origin_url`
|
||
* `enabled`
|
||
* `enable_https`
|
||
* `cert_id`
|
||
* `redirect_http`
|
||
* `custom_headers`
|
||
* `remark`
|
||
|
||
约束：
|
||
|
||
* 一个域名只对应一个源站
|
||
* `domain` 必须唯一
|
||
* `origin_url` 必须是合法的 `http://` 或 `https://`
|
||
|
||
### 6.2 `config_versions`
|
||
|
||
表示一次完整发布快照。
|
||
|
||
关键字段：
|
||
|
||
* `version`
|
||
* `snapshot_json`
|
||
* `rendered_config`
|
||
* `checksum`
|
||
* `is_active`
|
||
* `created_by`
|
||
|
||
约束：
|
||
|
||
* 每个版本保存完整快照与渲染结果
|
||
* 全局同时只能有一个激活版本
|
||
* 回滚通过重新激活旧版本实现
|
||
|
||
### 6.3 `nodes`
|
||
|
||
表示节点运行状态与接入凭证。
|
||
|
||
关键字段：
|
||
|
||
* `node_id`
|
||
* `name`
|
||
* `ip`
|
||
* `status`
|
||
* `current_version`
|
||
* `last_seen_at`
|
||
* `last_error`
|
||
* `agent_token`
|
||
|
||
约束：
|
||
|
||
* 节点专属 `agent_token` 由 Server 生成并持久化
|
||
* 删除节点后，其凭证必须立即失效
|
||
* 全局 `discovery_token` 不存放在 `nodes` 表中
|
||
|
||
### 6.4 `apply_logs`
|
||
|
||
记录节点应用版本的结果。
|
||
|
||
关键字段：
|
||
|
||
* `node_id`
|
||
* `version`
|
||
* `result`
|
||
* `message`
|
||
* `created_at`
|
||
|
||
### 6.5 `tls_certificates`
|
||
|
||
表示控制面托管的证书与私钥。
|
||
|
||
关键字段：
|
||
|
||
* `name`
|
||
* `cert_pem`
|
||
* `key_pem`
|
||
* `not_before`
|
||
* `not_after`
|
||
* `remark`
|
||
|
||
### 6.6 `managed_domains`
|
||
|
||
表示域名资产及其默认证书关系。
|
||
|
||
关键字段：
|
||
|
||
* `domain`
|
||
* `cert_id`
|
||
* `enabled`
|
||
* `remark`
|
||
|
||
约束：
|
||
|
||
* 支持精确域名与 `*.example.com` 通配符域名
|
||
* 证书匹配同时支持精确匹配与通配符匹配
|
||
|
||
---
|
||
|
||
## 7. 当前发布模型
|
||
|
||
标准链路：
|
||
|
||
```text
|
||
修改规则 -> 预览/查看 diff -> 发布 -> 生成完整配置版本 -> 激活版本 -> Agent 拉取 -> 本地应用 -> 上报结果
|
||
```
|
||
|
||
发布规则：
|
||
|
||
1. 读取全部启用的 `proxy_routes`
|
||
2. 渲染完整 Nginx 配置
|
||
3. 计算 `checksum`
|
||
4. 写入 `config_versions`
|
||
5. 切换激活版本
|
||
6. Agent 在下一轮同步中发现并应用
|
||
|
||
版本规则：
|
||
|
||
* 版本号格式：`YYYYMMDD-NNN`
|
||
* 版本不可变
|
||
* 节点只拉取当前激活版本
|
||
|
||
---
|
||
|
||
## 8. 当前模块边界
|
||
|
||
### 8.1 `atsf_server`
|
||
|
||
负责：
|
||
|
||
* 管理端 UI 与 API
|
||
* Agent API
|
||
* 数据存储
|
||
* 配置渲染
|
||
* 发布与激活
|
||
* 节点状态展示
|
||
|
||
### 8.2 `atsf_agent`
|
||
|
||
负责：
|
||
|
||
* 首次注册与凭证置换
|
||
* 周期性心跳
|
||
* 拉取激活版本
|
||
* 写入本地路由与证书文件
|
||
* 执行 `nginx -t` / `nginx -s reload`
|
||
* 失败回滚
|
||
* 上报应用结果
|
||
|
||
### 8.3 `atsf_server/web`
|
||
|
||
负责：
|
||
|
||
* 规则、版本、节点、应用记录页面
|
||
* 证书与域名管理页面
|
||
* 发布前预览与变更摘要展示
|
||
|
||
---
|
||
|
||
## 9. 当前接口域
|
||
|
||
为控制文档长度，仅保留接口域，不再逐条展开历史接口清单。
|
||
|
||
管理端接口当前覆盖：
|
||
|
||
* `proxy-routes`
|
||
* `config-versions`
|
||
* `nodes`
|
||
* `apply-logs`
|
||
* `tls-certificates`
|
||
* `managed-domains`
|
||
|
||
Agent 接口当前覆盖：
|
||
|
||
* 注册
|
||
* 心跳
|
||
* 获取激活版本
|
||
* 上报应用结果
|
||
|
||
统一约束：
|
||
|
||
* 管理端与 Agent API 均使用 JSON
|
||
* Agent API 固定放在 `/api/agent/*`
|
||
* Agent 鉴权使用 `X-Agent-Token`
|
||
|
||
|
||
## 10. 文档策略
|
||
|
||
第一版、第二版的详细实施过程不再在本文档中长期保留。
|
||
|
||
后续原则：
|
||
|
||
* 设计文档只保留当前有效基线
|
||
* 已完成阶段的细节以 Git 历史为准
|
||
* 新阶段开始前，先把设计输入写清楚，再进入实现
|
||
|
||
---
|
||
|
||
## 11. 第三版设计输入
|
||
|
||
### 11.1 目标定位
|
||
|
||
第三版聚焦**运维体验优化**，不扩展系统功能边界，只提升已有能力的可操作性与可维护性。
|
||
|
||
### 11.2 启动设置热更新
|
||
|
||
当前状态：
|
||
|
||
* `SESSION_SECRET`、`SQLITE_PATH`、`PORT` 等启动参数通过环境变量注入
|
||
* 变更需要重启 Server 进程
|
||
|
||
第三版变更：
|
||
|
||
* 将可热更新的运行时设置迁入 Option 表，通过设置页面管理
|
||
* 以下设置在前端运维设置面板中可配置：
|
||
* `AgentHeartbeatInterval`：Agent 心跳上报间隔（毫秒），默认 30000
|
||
* `AgentSyncInterval`：Agent 配置同步间隔（毫秒），默认 30000
|
||
* `NodeOfflineThreshold`：节点离线判定阈值（毫秒），默认 120000
|
||
* `AgentAutoUpdate`：是否允许 Agent 自动更新（`true`/`false`），默认 `false`
|
||
* `AgentUpdateRepo`：Agent 自动更新 GitHub 仓库地址，默认 `Rain-kl/ATSFlare`
|
||
* 环境变量类设置（`SESSION_SECRET`、`SQLITE_PATH`、`PORT`）不迁移，保留原有方式
|
||
* 前端在设置页面新增「运维设置」Tab
|
||
|
||
### 11.3 Server 下发 Agent 设置
|
||
|
||
当前状态：
|
||
|
||
* Agent 心跳请求只是单向上报，Server 不返回业务数据
|
||
* Agent 的心跳间隔、同步间隔只在本地 `agent.json` 配置
|
||
|
||
第三版变更：
|
||
|
||
* 心跳响应新增 `agent_settings` 字段，包含 Server 端可控的运行时参数：
|
||
* `heartbeat_interval`（毫秒）
|
||
* `sync_interval`（毫秒）
|
||
* `auto_update`（布尔值）
|
||
* `update_repo`（GitHub 仓库名）
|
||
* Agent 收到心跳响应后，动态调整本地定时器间隔
|
||
* 当 Server 未返回 `agent_settings` 或字段为空时，Agent 保持本地值不变
|
||
* Agent 不持久化 Server 下发的间隔值，重启后以本地 `agent.json` 为准，再由下次心跳覆盖
|
||
|
||
### 11.4 Agent 自我更新
|
||
|
||
当前状态：
|
||
|
||
* Agent 版本固定，更新需要运维手动替换二进制文件
|
||
|
||
第三版变更：
|
||
|
||
* Agent 在收到 `auto_update=true` 时：
|
||
* 通过 GitHub Releases API 查询 `update_repo` 的最新 Release
|
||
* 比较本地 `agent_version` 与远端 tag
|
||
* 若存在更新，下载对应平台的二进制文件
|
||
* 替换自身二进制并重启
|
||
* 更新检查频率：每轮心跳周期结束后检查一次，不独立起定时器
|
||
* 更新过程中不中断当前同步任务
|
||
* 更新失败不影响正常心跳与同步
|
||
* Agent 二进制文件命名约定：`atsflare-agent-{os}-{arch}`
|
||
|
||
### 11.5 Agent 一键部署
|
||
|
||
当前状态：
|
||
|
||
* Agent 需要手动编译或复制二进制并创建配置文件
|
||
|
||
第三版变更：
|
||
|
||
* 提供 `install-agent.sh` 脚本，支持以下方式部署：
|
||
```bash
|
||
curl -fsSL https://raw.githubusercontent.com/Rain-kl/ATSFlare/main/scripts/install-agent.sh | bash -s -- \
|
||
--server-url http://your-server:3000 \
|
||
--discovery-token your-token
|
||
```
|
||
* 脚本行为：
|
||
* 检测平台架构（linux/amd64、linux/arm64）
|
||
* 从 GitHub Releases 下载最新 Agent 二进制
|
||
* 创建安装目录（默认 `/opt/atsflare-agent`）
|
||
* 生成基础 `agent.json` 配置
|
||
* 创建 systemd service 文件（可选）
|
||
* 启动 Agent
|
||
|
||
### 11.6 GitHub Actions 内测发布
|
||
|
||
当前状态：
|
||
|
||
* 现有工作流只构建 Server 二进制和 Docker 镜像
|
||
* Agent 二进制不在 CI 中构建
|
||
* Alpha 标签在部分工作流中被排除
|
||
|
||
第三版变更：
|
||
|
||
* 新增 `agent-release.yml` 工作流：
|
||
* 触发条件：推送任意 tag（包括 alpha）
|
||
* 构建 Agent 二进制：`linux/amd64`、`linux/arm64`、`darwin/arm64`
|
||
* 产物命名：`atsflare-agent-{os}-{arch}`
|
||
* 上传至 GitHub Release
|
||
* 修改现有工作流：
|
||
* 统一 `linux-release.yml` 为同时构建 Server + Agent 二进制
|
||
* Alpha 标签的发布标记为 prerelease
|
||
* 安装脚本与自我更新共用同一 Release 产物
|
||
|
||
### 11.7 前端运维体验优化
|
||
|
||
当前状态：
|
||
|
||
* 时间字段使用纳秒整数，不够友好
|
||
* 设置页面未包含运维类设置
|
||
|
||
第三版变更：
|
||
|
||
* 设置页面新增「运维设置」Tab，包含：
|
||
* Agent 心跳间隔
|
||
* Agent 同步间隔
|
||
* 节点离线阈值
|
||
* Agent 自动更新开关
|
||
* Agent 更新仓库
|
||
* 全局 Discovery Token 展示与重新生成
|
||
* Agent 一键部署命令展示（根据当前 ServerAddress 和 DiscoveryToken 动态生成 curl 命令）
|
||
* 节点列表页优化：
|
||
* 时间显示改为友好的相对时间格式
|
||
* 节点状态使用颜色标识
|
||
|
||
---
|
||
|
||
## 12. 第三版不做的范围
|
||
|
||
以下内容不在第三版范围内：
|
||
|
||
* 多租户
|
||
* WAF、限流、Bot
|
||
* 节点分组、差异化下发
|
||
* 证书自动签发与续期
|
||
* Agent 配置文件加密
|
||
* Server 远程执行 Agent 命令
|