Files
ops/deploy/README.md
2026-06-21 17:50:24 +08:00

81 lines
4.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# OPS 验收部署说明
## 1. 目标
本文定义 OPS 在 Linux/麒麟验收环境中的部署、迁移、回滚和烟测步骤。受项目规则约束,本文不提供 Linux 命令示例,只提供执行顺序、配置项和验收检查点。
## 2. 部署前确认
| 项目 | 必填内容 |
| --- | --- |
| 操作系统 | 发行版、版本、CPU 架构、补丁状态 |
| 网络区域 | Web 访问区、后端 API 区、数据库区、采集区 |
| 域名或访问地址 | 前端访问地址、API 地址、回调地址 |
| PostgreSQL | 版本、地址、端口、库名、账号来源 |
| 时序数据库 | 产品、版本、部署形态、保留策略 |
| 通知渠道 | 站内消息、短信、邮件测试账号和发送限制 |
| 采集入口 | SNMP、Trap、Syslog、URL/API 探测网络策略 |
| 备份目录 | 数据库备份、时序库备份、配置备份、日志归档 |
真实密码、Token、短信密钥和邮件密码只能写入现场配置不进入仓库。
## 3. 部署顺序
| 顺序 | 步骤 | 通过标准 |
| --- | --- | --- |
| 1 | 准备运行用户、目录、端口和防火墙策略 | 服务账号权限最小化,端口策略已审批。 |
| 2 | 部署 PostgreSQL 并初始化数据库 | 可连接,字符集和时区正确。 |
| 3 | 部署选定时序数据库 | 可写入样本,可按时间范围查询。 |
| 4 | 放置后端配置文件 | 配置中无明文提交凭据,凭据来自现场安全渠道。 |
| 5 | 执行数据库迁移 | 表结构与当前版本匹配,迁移日志保留。 |
| 6 | 启动后端服务 | 健康检查成功,日志可查看。 |
| 7 | 部署前端静态包 | 页面可访问API 地址指向验收后端。 |
| 8 | 配置采集和通知通道 | 采集任务、短信、邮件测试通过。 |
| 9 | 执行烟测 | 登录、资源、告警、通知、工单、报表主路径通过。 |
## 4. 迁移要求
| 迁移对象 | 要求 |
| --- | --- |
| PostgreSQL 表结构 | 每个迁移文件必须可追踪版本、执行时间和执行结果。 |
| 初始化字典 | 告警级别、资源类型、通知渠道、权限码必须可重复执行。 |
| 时序库 schema | 指标命名、标签、保留策略必须与 `docs/首期数据模型与状态机.md` 一致。 |
| 样例数据 | 验收样例必须可清理,不与生产数据混淆。 |
迁移失败时不得继续执行后续部署步骤。
## 5. 回滚要求
| 对象 | 回滚策略 |
| --- | --- |
| 后端服务 | 保留上一版本二进制或镜像,配置兼容性检查通过后回退。 |
| 前端静态包 | 保留上一版本静态文件,切回后清理浏览器缓存影响。 |
| PostgreSQL | 迁移前备份,迁移失败按备份恢复或执行成对回滚脚本。 |
| 时序数据库 | 变更保留策略、降采样规则前备份元数据和关键样本。 |
| 配置文件 | 每次变更前保留上一份配置,敏感字段仍按现场安全要求保存。 |
## 6. 烟测清单
| 编号 | 检查项 | 通过标准 |
| --- | --- | --- |
| S-001 | 登录和权限 | 管理员可登录,普通用户不能访问无权限菜单。 |
| S-002 | 首页总览 | 显示资源健康、告警趋势、待处理告警,数据来自后端。 |
| S-003 | 资源列表 | 可查看主机、H3C/华三网络设备、数据库、URL/API 样例资源。 |
| S-004 | 采集状态 | 最近采集时间、失败原因、数据过期状态可见。 |
| S-005 | 原始事件 | Trap/Syslog 样例可入库,未解析事件可见。 |
| S-006 | 告警中心 | 可触发、确认、忽略、恢复和派单。 |
| S-007 | 通知记录 | 站内消息、短信、邮件记录可查,失败原因可见。 |
| S-008 | 工单管理 | 可创建、接单、转交、挂起、重启、关闭。 |
| S-009 | 报表大屏 | 基础报表可生成,大屏组件局部失败可降级。 |
| S-010 | 审计日志 | 权限变更、告警处理、工单流转可按 `traceId` 查询。 |
## 7. 验收输出
- 部署环境确认表。
- 配置项脱敏清单。
- 数据库迁移记录。
- 后端和前端版本号。
- 烟测截图、接口响应和日志。
- 回滚演练记录或回滚步骤确认单。