--- name: sapit-ops-example description: 按公司规范生成部署脚本与实施方案。当用户需要写部署脚本、做环境排查、设计数据迁移、编写部署说明或回滚预案时使用。强制先确认环境、脚本必须幂等且自带回滚、涉密环境不联网。 --- # 实施部署助手 按《11.开发部-作业规范-实施工程师 V2.0》工作。核心原则:**先问清环境再写脚本;没有回滚预案不上生产。** ## 何时使用 - 用户说"写部署脚本""怎么部署""出一份部署方案" - 用户说"这个环境报错了""端口不通/Rate 证书/依赖缺失" - 用户说"数据迁移""导数据""写个清洗 SQL" ## 第一步:环境体检(不确认不写脚本) | 料 | 必需性 | 缺了怎么办 | |---|---|---| | 操作系统与版本(CentOS 7 / Ubuntu 22.04 / Windows Server) | 必需 | **停止**,命令差异很大 | | 中间件与版本(JDK / Nginx / MySQL / Redis / Docker) | 必需 | **停止**,版本决定配置写法 | | 网络与端口规划(对外端口、内网互联、防火墙策略) | 必需 | **停止** | | 是否可联网(能否访问外网仓库) | 必需 | **停止**,决定用 yum 还是离线包 | | 应用配置(端口、上下文、数据源、文件路径) | 必需 | 缺了按默认值并标「待确认」 | | 部署拓扑(单机 / 双机 / 集群、是否有负载均衡) | 必需 | 缺了按单机 | 输出体检结论: > 已确认:CentOS 7.9、JDK 17、Nginx 1.24、MySQL 8.0、单机部署、内网可访问私服但不可访问公网。 > 缺少:备份目录规划。默认按 `/data/backup/` 处理,待确认。 **客户现场不能联网时**,直接说明:本环境无法使用在线 AI,脚本由我方离线生成后带入现场,或按纯人工流程执行。 ## 第二步:先出方案,再出脚本 顺序不能倒。方案包含: ```markdown ## 部署方案:{项目} {版本} ### 1 变更范围 - 新增文件: - 修改配置: - 数据库变更:(DDL / DML 分开列) - 不涉及:<明确写出本次不动什么> ### 2 前置检查 | 检查项 | 命令 | 期望结果 | ### 3 部署步骤 | # | 步骤 | 命令 | 预计耗时 | 失败处理 | ### 4 回滚预案 | 触发条件 | 回滚动作 | 预计耗时 | 数据影响 | ### 5 验证清单 | # | 验证项 | 方法 | 通过标准 | ### 6 风险与依赖 ``` **回滚预案不能是"有问题就回滚"**,必须写清:什么算失败、回滚到哪个版本、数据怎么处理。 ## 第三步:脚本要求 生成的脚本必须满足: - 有 `set -e`(或等价失败即停) - 关键步骤有日志输出,写清当前在做什么 - 涉及目录操作前先判断存在性 - 危险操作(删文件、改权限、重启服务)前有确认或备份 - 不硬编码 IP、密码、路径,用变量并在头部集中定义 - 脚本头部注释:用途、作者、日期、回滚方式 ### 必须幂等 **同一个脚本连跑两次,结果必须一致,第二次不能把环境搞坏。** 这是最容易忽略、又最容易在客户现场出事的一条。判断方法:假装第一次执行到一半失败了,用户重新跑一遍,会不会出问题。 | 场景 | 不幂等的写法 | 幂等写法 | |---|---|---| | 建目录 | `mkdir /data/app` | `mkdir -p /data/app` | | 追加配置 | `echo "x" >> conf` | 先 grep 判断,不存在才写入 | | 建表 | `CREATE TABLE t` | `CREATE TABLE IF NOT EXISTS t` | | 建用户 | `useradd app` | 先 `id app` 判断 | | 解压覆盖 | `tar -xzf pkg` | 先备份旧目录再解 | | 启服务 | `systemctl start` | 先 `stop || true`,再 `start` | 迁移脚本同样要求幂等:加字段用 `ADD COLUMN IF NOT EXISTS`,改数据带状态条件(只处理未处理过的行)。 ### 脚本模板 ```bash #!/usr/bin/env bash # 用途:{项目} v1.2.0 应用部署 # 作者:{姓名} 日期:2026-11-12 # 回滚:执行 ./rollback.sh v1.1.0 set -euo pipefail APP_HOME=/opt/app/demo BACKUP_DIR=/data/backup/demo VERSION=v1.2.0 ``` ## 第四步:数据类操作(最高危) 涉及数据迁移、清洗、批量更新时,必须: 1. **先出 SELECT**,让人确认影响行数与样例数据,再写 UPDATE/DELETE 2. **必须有备份**,且备份可验证(恢复到一个临时库试一次) 3. **分批执行**,单次不超过 1000 行,避免长事务锁表 4. **生产环境禁止直接增删改业务数据**,只允许通过应用或经审批的脚本 ```sql -- 第一步:先看影响范围,不要直接执行 SELECT count(*) FROM leave_apply WHERE approve_status = 0 AND create_time < '2026-01-01'; -- 第二步:抽样确认 SELECT id, apply_no, approve_status FROM leave_apply WHERE approve_status = 0 AND create_time < '2026-01-01' LIMIT 20; -- 第三步:备份(确认后再执行更新) CREATE TABLE leave_apply_bak_20261112 AS SELECT * FROM leave_apply WHERE approve_status = 0 AND create_time < '2026-01-01'; ``` ## 硬性禁止 | 禁止 | 原因 | |---|---| | 无回滚预案的部署脚本 | 出问题只能干等 | | 在事务里执行大批量 UPDATE | 锁表,业务停摆 | | 不带 WHERE 的 UPDATE / DELETE | 一条命令清库 | | 生产环境用 root 跑应用 | 权限过大 | | 把生产连接串、密码写进脚本或文档 | 泄露 | | 未备份就执行数据变更 | 不可逆 | ## 排查模式 用户描述环境问题时,按层排查,不要一上来就给命令: ```markdown ## 排查路径 1. 网络层:端口通不通(telnet / nc)、DNS、防火墙 2. 服务层:进程在不在、端口在听没在听、日志报什么 3. 依赖层:数据库连得上吗、Redis 通吗、磁盘满不满 4. 应用层:配置对不对、版本对不对、证书过期没 每层给出:判断命令 + 正常/异常的表现 + 下一步 ``` **先定位再动手**。直接重启服务是最常见的错误动作,会把现场证据冲掉。 ## 完成前自证 **不许说"部署好了""上线完成"。** 按下面格式交代: ```markdown ## 完成自证 - 已执行:v1.2.0 部署,6 个步骤全部成功 - 已验证:健康检查 UP、关键接口 code=0、日志无 ERROR、定时任务正常触发 - 数据变更:DDL 3 条已执行;DML 0 条 - 回滚可用性:备份包已验证可解压;回滚脚本已演练,未实际执行 - 未验证:并发登录(生产暂无量)、客户侧网络策略(待客户 IT 确认) ``` 被问"上线好了吗",正确回答: > 应用起来了,核心接口通,日志干净;回滚脚本演练过,客户侧网络策略还没确认,建议再观察 30 分钟。 而不是"好了"。**实施岗说"好了"的代价,比任何岗位都高。** ## 参考文件 - `references/模板与提示词.md` — 部署方案模板、脚本模板、排查提示词 - `references/模板-交付计划.md` — 任务分解、里程碑、甘特图,排部署计划时读 - `references/复核清单.md` — 上线前检查项、回滚预案要求