deploy(M00-E): 补充备份恢复检查模板

2026-06-15 16:55:52 +08:00
parent c3be30d4c7
commit 292ab7f062
20 changed files with 151 additions and 21 deletions
@@ -1,5 +1,17 @@
 # 部署变更记录

+## 2026-06-15 / 0.1.4-m00-backup-check
+
+- 关联模块：M00-E/OPS-004
+- 关联 commit：本轮待提交
+- 变化内容：新增 `deploy/backup/backup-policy.template.json`、`deploy/backup/backup-restore-runbook.md` 和 `setup.sh --backup-status`；备份脚本扩展为检查 MySQL/EMQX/上传文件备份工具、目录和模板。
+- 配置变化：初始化目录新增 `/opt/apps/uploads`；菜单第 6 项继续只写 manifest，不导出真实数据。
+- 数据库变化：无。
+- 兼容性：仅增加检查、模板和 runbook，不自动执行 `mysqldump`、`emqx ctl data export` 或文件归档。
+- 已执行验证：Windows 本地检查和敏感信息扫描通过；WSL `bash -n`、`setup.sh --backup-status`、`setup.sh --preflight/--status/--diagnose` 通过，`/opt/apps/backups/*` 未初始化按预期返回 WARN。
+- 回滚方式：移除新增备份模板和 `--backup-status` 检查即可回到 0.1.3 行为；未改动生产环境。
+- 生产环境人工步骤：管理员确认数据库凭据、上传目录、EMQX 配置和保留周期后，再启用真实备份任务。
+
 ## 2026-06-15 / 0.1.3-m00-emqx-check

 - 关联模块：M00-E/IOT-001
@@ -15,7 +27,7 @@
 ## 2026-06-15 / 0.1.2-m00-certbot-check

 - 关联模块：M00-E
- 关联 commit：本轮提交推送后以远端 HEAD 为准
+- 关联 commit：`4cb3ab6`
 - 变化内容：新增 `scripts/setup/certbot.sh` 和 `deploy/certbot/api.txyundm.cn.commands.md`，菜单第 4 项追加 Certbot、证书文件、续期配置和 `certbot.timer` 检查。
 - 配置变化：`setup.sh --https` 会同时输出证书签发命令和续期 dry-run 命令。
 - 数据库变化：无。
@@ -2,7 +2,7 @@

 | 项目 | 当前值 |
 |---|---|
-| 菜单脚本版本 | 0.1.3-m00-emqx-check |
+| 菜单脚本版本 | 0.1.4-m00-backup-check |
 | Gitea 仓库 Web | https://git.txyundm.cn/panda/qipai.git |
 | API 固定域名 | https://api.txyundm.cn |
 | 小程序 API | https://api.txyundm.cn/app-api |
@@ -14,8 +14,8 @@
 | Gitea 仓库 SSH | ssh://git@git.txyundm.cn:2222/panda/qipai.git |
 | 生产拉取仓库 | ssh://git@127.0.0.1:2222/panda/qipai.git |
 | 默认分支 | main |
-| 最近模块 push commit | `86f7da2`（M00-E EMQX 检查模板） |
-| 最近 push 远端校验 | 通过：`HEAD == origin/main`（`86f7da21684330502e64c38af2a4bc24fe78a3d1`） |
+| 最近模块 push commit | `c3be30d`（M00-E EMQX 检查校验记录）；本轮备份检查待提交 |
+| 最近 push 远端校验 | 上一轮通过：`HEAD == origin/main`（`c3be30d4c70ec83e43d0444fa0abbe24d89e0c0b`）；本轮待复验 |
 | 目标系统 | Ubuntu 24.04 |
 | 内核架构 | x86_64 |
 | DPKG 架构 | amd64 |
@@ -25,9 +25,9 @@
 | 命令行 MQTT 工具 | mosquitto-clients：未安装/未验证 |
 | Windows MQTTX 验证 | 未验证 |
 | WSL 环境验证 | 已完成轻量检查、shell 语法检查、临时副本准备和清理；完整构建待正式项目生成 |
-| 最近环境快检 | 2026-06-15 WSL 执行 `setup.sh --preflight/--status/--https/--mqtt/--diagnose` 通过；HTTPS/Certbot/EMQX 生产项返回 WARN，EMQX 模板存在 |
+| 最近环境快检 | 2026-06-15 WSL 执行 `setup.sh --preflight/--status/--https/--mqtt/--backup-status/--diagnose` 通过；备份策略模板/runbook 存在，`/opt/apps/backups/*` 未初始化按预期 WARN |
 | 最近部署后复检 | 未执行 |
-| 最近验证 commit | `86f7da2`；EMQX 检查模板已推送并完成远端校验 |
+| 最近验证 commit | `c3be30d`；本轮备份检查脚本验证已通过，待提交 |
 | 最近验证日期 | 2026-06-15 |
 | 已验证系统 | Ubuntu 24.04 / 未验证 |
 | 菜单 1 首次安装 | 脚本已实现目录布局；未在生产 Ubuntu 执行 |
@@ -35,8 +35,8 @@
 | 菜单 3 MQTT | EMQX 命令、systemd、1883/18083 端口、ACL 模板和授权模板检查已实现；EMQX 安装未执行 |
 | 菜单 4 域名与 HTTPS | 域名、Nginx 模板、站点启用、TLS、健康端点、Certbot、证书文件、续期配置和 `certbot.timer` 检查已实现；当前线上证书为 `git.txyundm.cn`，证书申请/续期未执行 |
 | 菜单 5 状态 | 已实现 |
-| 菜单 6 备份 | manifest-only 已实现；真实备份待生产配置 |
-| 菜单 7 恢复 | 人工恢复提示已实现 |
+| 菜单 6 备份 | 备份工具/目录/模板检查已实现；菜单执行仍为 manifest-only，真实备份待生产配置 |
+| 菜单 7 恢复 | 人工恢复提示和 runbook 已实现 |
 | 菜单 8 回滚 | 回滚点列表已实现；自动切换待正式 release |
 | 菜单 9 诊断 | 已实现 |
 | 已知限制 | 未执行生产部署；WSL 快检可能显示 Node/Nginx/PM2 缺失或未安装，生产 Ubuntu 需重新验证；正式后端/后台未生成前，业务构建为 dry-run。 |
@@ -15,6 +15,7 @@
 - 继续补强 M00-E，新增固定 API 域名 Nginx 模板、Ubuntu 菜单第 4 项域名/HTTPS 检查和 Windows 域名检查脚本。
 - 继续补强 TLS-001，新增 Certbot 状态检查、证书签发/续期命令说明和 WSL 域名检查 WARN 记录。
 - 继续补强 IOT-001，新增 EMQX Ubuntu 安装说明、ACL 模板、授权模板和菜单第 3 项/`--mqtt` 检查。
+- 继续补强 OPS-004，新增备份策略模板、恢复 runbook 和 `setup.sh --backup-status` 检查。

 ## 起始状态

@@ -34,7 +35,7 @@

 ## 部署影响

-有。新增并升级 `setup.sh` 与 `scripts/setup/*.sh` 菜单式部署骨架，补充 `api.txyundm.cn` Nginx 模板、域名/HTTPS/Certbot 检查、证书命令说明、EMQX 安装说明和 ACL 模板，但未执行生产部署。
+有。新增并升级 `setup.sh` 与 `scripts/setup/*.sh` 菜单式部署骨架，补充 `api.txyundm.cn` Nginx 模板、域名/HTTPS/Certbot 检查、证书命令说明、EMQX 安装说明、ACL 模板、备份策略模板和恢复 runbook，但未执行生产部署。

 ## 测试记录

@@ -49,6 +50,7 @@
 - Certbot：新增 `scripts/setup/certbot.sh` 和 `deploy/certbot/api.txyundm.cn.commands.md`；生产签发、续期 dry-run 和 `certbot.timer` 尚未执行。
 - WSL 域名脚本：`scripts/dev/wsl/check-api-domain.sh` 已改为输出 PASS/WARN，不因生产健康接口暂未上线而中断整体验证。
 - EMQX：新增 `scripts/setup/emqx.sh`、`deploy/emqx/install-ubuntu24-amd64.md`、ACL 模板和授权模板；WSL `setup.sh --mqtt` 可运行并确认模板存在，生产安装、端口限制、真实账号和 MQTT 冒烟尚未执行。
+- 备份/恢复：新增 `deploy/backup/backup-policy.template.json`、`deploy/backup/backup-restore-runbook.md` 和 `setup.sh --backup-status`；WSL 检查确认模板存在，`/opt/apps/backups/*` 未初始化按预期 WARN，真实 `mysqldump`、EMQX 导出和上传文件归档尚未执行。
 - WSL 检查：已执行 `check-env.sh`、`check-workspace.sh`、`verify-linux.sh`、`prepare-test-copy.sh` 和 `cleanup-test-copy.sh`；临时副本创建和清理通过。完整 Linux 构建待正式后端/后台项目生成后执行。
 - Git fetch/push：首次多次失败后，`git push origin main` 已成功；随后 `git fetch origin main` 校验 `HEAD == origin/main` 通过。

@@ -11,9 +11,9 @@
 | API-001 | 固定 HTTPS API 域名 | M00-E/M01/M08/M10 | PARTIAL | `4cb3ab6` | 已新增 Windows 检查脚本、Ubuntu 菜单检查和固定域名 Nginx 模板。 | DNS/HTTPS 生产验证未执行，后端健康接口未生成。 | 后续接入真实后端健康接口并执行 Windows/WSL/Ubuntu/微信真机验证。 |
 | TLS-001 | Nginx 与证书自动化 | M00-E/M10 | PARTIAL | `4cb3ab6` | 已生成 Nginx 模板、Certbot 命令说明和菜单第 4 项检查，可检查模板、站点启用、TLS、健康端点、证书文件、续期配置和 `certbot.timer`。 | 证书申请/续期 dry-run、80/443 生产验证未执行。 | 在生产 Ubuntu 执行证书签发、续期 dry-run 和 Nginx 安装记录。 |
 | WXNET-001 | 微信合法域名与真机验证 | M00-E/M08/M10 | TODO | - | 已补 API 域名报告入口，但未做微信后台或真机验证。 | 微信后台/真机未验证。 | 后续导入小程序后执行合法域名和真机验证。 |
-| OPS-001 | 固定 `/opt/apps` 目录 | M00-D/M10 | PARTIAL | 本地 HEAD | `scripts/setup/init-layout.sh` 已生成目录布局和 manifest；未在生产 Ubuntu 执行。 | 生产操作未执行。 | 由管理员在 Ubuntu 菜单执行并记录结果。 |
+| OPS-001 | 固定 `/opt/apps` 目录 | M00-D/M10 | PARTIAL | 本轮待提交 | `scripts/setup/init-layout.sh` 已生成目录布局、uploads 目录和 manifest；WSL 检查脚本通过，未在生产 Ubuntu 执行。 | 生产操作未执行。 | 由管理员在 Ubuntu 菜单执行并记录结果。 |
 | OPS-002 | 单仓库 Gitea 推送与拉取部署 | M00-B/M10 | PARTIAL | 远端 HEAD | Windows 到 Gitea `origin/main` 首次 push 与远端校验通过。 | 生产服务器只读拉取部署尚未验证。 | M00-D/M00-E 继续完善生产拉取、菜单部署和状态检查。 |
 | OPS-003 | 整仓发布清单 | M00-E/M10 | PARTIAL | 本地 HEAD | `deploy-business.sh` 可生成 dry-run release manifest；正式构建待项目生成。 | 后端/后台尚未生成。 | M01/M09 后接入真实构建结果。 |
-| OPS-004 | 菜单式更新与环境监测 | M00-E/M10 | PARTIAL | 本地 HEAD | `setup.sh` 已接入初始化、更新、MQTT、HTTPS、状态、备份、恢复、回滚和诊断菜单；WSL 快检/status/diagnose 通过。 | 未在生产 Ubuntu 执行。 | 生产执行后补部署记录。 |
+| OPS-004 | 菜单式更新与环境监测 | M00-E/M10 | PARTIAL | 本轮待提交 | `setup.sh` 已接入初始化、更新、MQTT、HTTPS、状态、备份、恢复、回滚和诊断菜单；`--backup-status` 已在 WSL 验证，可检查备份工具、目录和模板。 | 未在生产 Ubuntu 执行；真实备份配置未启用。 | 生产执行后补部署记录、真实备份和恢复演练记录。 |
 | IOT-001 | MQTT Broker 生产部署 | M00/M06 | PARTIAL | `86f7da2` | 已生成 EMQX Ubuntu 安装说明、ACL 模板、授权模板和菜单第 3 项检查；WSL `setup.sh --mqtt` 已验证脚本可运行。 | 缺生产 EMQX 安装、端口限制、真实账号和实机验证。 | 生产执行后补 EMQX 版本、端口、ACL、备份和 MQTT 冒烟记录；M06 精化设备 Topic。 |
 | SYS-001 | 微信原生小程序 | M00-C/M08 | TODO | - | - | 参考小程序压缩包尚未深度整理。 | 后续导入正式 `miniapp/`。 |
@@ -52,3 +52,9 @@ powershell -ExecutionPolicy Bypass -File scripts/dev/windows/check-gitea-ssh.ps1
 - EMQX 安装说明位于 `deploy/emqx/install-ubuntu24-amd64.md`。
 - ACL 模板位于 `deploy/emqx/acl.conf.template`，授权配置模板位于 `deploy/emqx/authorization.hocon.template`。
 - `setup.sh --mqtt` 仅检查 EMQX 命令、服务、端口和模板状态，不自动安装或写入 `/etc/emqx`。
+
+## Backup And Restore
+
+- 备份策略模板位于 `deploy/backup/backup-policy.template.json`。
+- 备份/恢复 runbook 位于 `deploy/backup/backup-restore-runbook.md`。
+- `setup.sh --backup-status` 仅检查工具、目录和模板状态，不自动导出 MySQL、EMQX 或上传文件。
@@ -2,7 +2,7 @@

 | 模块 | 状态 | 最近提交 | 最近开发日志 | 备注 |
 |---|---|---|---|---|
-| M00 单仓库与服务器基础骨架 | PARTIAL | `86f7da2` | docs/devlogs/2026-06-15-M00-A-单仓库基线.md | M00-A/M00-B 基线已推送并校验；M00-C/D/E 持续完善，域名/HTTPS/Certbot/EMQX 检查已补模板但生产未验证。 |
+| M00 单仓库与服务器基础骨架 | PARTIAL | `c3be30d`；本轮备份检查待提交 | docs/devlogs/2026-06-15-M00-A-单仓库基线.md | M00-A/M00-B 基线已推送并校验；M00-C/D/E 持续完善，域名/HTTPS/Certbot/EMQX/备份检查已补模板但生产未验证。 |
 | M01 后端 API 基础工程 | TODO | - | - | 等 M00 基线完成后开始。 |
 | M02 登录、租户、权限 | TODO | - | - | - |
 | M03 门店、房间、价格、营业时间 | TODO | - | - | - |
@@ -15,3 +15,5 @@
 | 域名/HTTPS 检查 | `setup.sh` 菜单 4、`setup.sh --https`、`scripts/dev/windows/check-api-domain.ps1`、`scripts/dev/wsl/check-api-domain.sh` |
 | EMQX 模板 | `deploy/emqx/install-ubuntu24-amd64.md`、`deploy/emqx/acl.conf.template`、`deploy/emqx/authorization.hocon.template` |
 | EMQX 检查 | `setup.sh` 菜单 3、`setup.sh --mqtt` |
+| 备份模板 | `deploy/backup/backup-policy.template.json`、`deploy/backup/backup-restore-runbook.md` |
+| 备份检查 | `setup.sh` 菜单 6、`setup.sh --backup-status` |
@@ -10,4 +10,5 @@
 | 敏感信息 | PASS/PARTIAL | 明文敏感模式扫描已通过；`参考/env` 已脱敏；含秘密/真实数据风险的原始包和 SQL 已移出 Git 跟踪。 |
 | 大文件 | WARN | `参考/mazongjian-server.xjar` 约 194MB，已记录哈希并作为大文件阻断项忽略。 |
 | 行尾/空白 | PASS | `scripts/dev/windows/test-all.ps1` 已运行，`git diff --check` 通过。 |
-| 远端一致性 | PASS | `git push origin main` 成功，`git fetch origin main` 后 `HEAD == origin/main`。 |
+| 忽略规则 | PASS | 真实 `backup/`、`backups/` 仍忽略；`deploy/backup/` 模板已放行并待提交。 |
+| 远端一致性 | PASS | 最近一次 `git push origin main` 成功，`git fetch origin main` 后 `HEAD == origin/main`；本轮待推送后复验。 |
@@ -11,6 +11,7 @@
 | `deploy/nginx/` | API 域名 Nginx 模板 | 必须提交模板，不提交证书 |
 | `deploy/certbot/` | API 域名证书签发和续期命令说明 | 必须提交命令说明，不提交证书或账户信息 |
 | `deploy/emqx/` | EMQX 安装说明、ACL 模板和授权模板 | 必须提交模板，不提交设备账号、密码或运行数据 |
+| `deploy/backup/` | 备份策略模板和恢复 runbook | 必须提交模板和说明，不提交备份文件 |
 | `scripts/` | 检查、部署和运维脚本 | 必须提交 |
 | `docs/` | 状态、日志、变更和验收记录 | 必须提交 |
 | `docs/reference-page-map.md` | 旧小程序页面脱敏地图 | 必须提交 |