主题
架构与组件
组件清单
| 组件 | 技术栈 | 职责 |
|---|---|---|
| deploy-server | Go 1.24、Gin、SQLite | HTTP API、执行引擎、Git 准备、日志存储、Hook、中间件/工具链安装 |
| deploy-server-ui | React 18、UmiJS Max 4、Ant Design 5 | Web 管理界面;构建产物被服务端 go:embed 内嵌 |
| deploy-cli | Go、cobra、gorilla/websocket | 服务器管理、部署触发、日志跟随、中间件操作;单二进制无运行时依赖 |
| skills | Markdown 技能包 | AI Agent(Codex / Qoder 等)使用 deploy 的操作规程 |
| tools | Shell / PowerShell | SSH 工具、服务器初始化与冒烟检查脚本 |
仓库地址:https://gitee.com/ppnt/deploy。
执行模型
text
浏览器(Web UI) ─
deploy-cli ────┼──HTTP /api/v1──> deploy-server ──> 本机 Shell(bash/PowerShell)
HTTP Hook ─────┘ │ │
│ ├── Git 准备(clone/fetch/checkout)
│ ├── 命令/步骤逐条执行(进程树)
│ └── 中间件/工具链安装脚本
│
├── SQLite(deploy.db:项目/任务/运行/凭据/令牌)
├── 日志文件(logs/<key>/<runId>.log)
└── WebSocket(/api/v1/ws/runs/:id) ──> 网页终端 / CLI 跟随要点:
- 命令在服务端机器上执行。服务端以 systemd 形态运行时,脚本能直接
systemctl restart宿主机服务;以 Docker 形态运行时,脚本在容器内执行,管理宿主机服务或访问宿主机目录需要额外挂载,详见 Docker 部署。 - 前端不是独立服务:UI 构建产物嵌入服务端二进制,访问 10055 端口即得网页,无需另起 Node 进程。
- 日志双通道:运行输出同时落盘与推送;WebSocket 断线后按字节 offset 续拉,不丢不重。
- 安装也是运行:中间件与工具链的安装脚本以普通 Run 的形式执行,因此有日志、有退出码、可取消。
一次部署的数据流
- 触发:Web 按钮、
deploy run <key>、或POST /api/v1/hooks(Hook Token)。 - 服务端创建 Run(全局 runId + 目标内 buildNumber),按并发策略入队或立即执行。
- 可选 Git 准备阶段:clone 或 fetch + checkout 对齐分支,注入
GIT_*变量。 - 依序执行命令/步骤:每条独立超时与失败策略;输出写入日志文件并广播。
- 终态落库:success/failed/timeout/error/canceled;CLI
--wait/-f与 Hook?wait=true据此返回。
代码结构速览
text
deploy/
deploy-server/
cmd/server/ # 入口与启动参数
internal/api/ # 路由与 handlers(契约 v1)
internal/runner/ # 执行引擎:env/shell/git/pipeline/gate
internal/store/ # SQLite 模型与依赖排序
internal/runlog/ # 日志落盘与 offset 读取
internal/middleware/ # 中间件安装脚本(go:embed)
internal/toolchain/ # 工具链安装脚本(go:embed)
internal/web/ # 内嵌前端 dist
deploy-server-ui/ # React + Umi Max 前端
deploy-cli/ # cobra 命令树 + api/ws/config/output/exitcode
skills/ # Agent 技能与安装说明
tools/ # 初始化与冒烟脚本
docs/ # API 契约、需求规格、部署案例