Page:
Deployment-Template
Pages
Admin-Architecture
Admin-Catalog-Integration-API
Admin-Client-API
Admin-Data-Model
Admin-Device-Registration-Guide
Admin-Getting-Started
Admin-Glossary
Admin-Quality-Security
Admin-Requirements
Admin-SQLite-to-MySQL
Admin-Shunyunbao-API
Admin-UI-Specification
Architecture-and-Code-Map
Audience-Document-Template
Business-Rules-and-Glossary
Client-Admin-API-Contract
Client-Architecture
Client-Data-Model
Client-Getting-Started
Client-Glossary
Client-Quality-Security
Client-Requirements
Client-UI-Specification
Common-Changes
Delivery-Documentation-Guide
Deployment-Template
Deployment-and-Operations
Development-Workflow
Home
Local-Development-and-Verification
Product-Requirements-Overview
Project-Profile
Task-Archive-Template
Troubleshooting
Clone
1
Deployment-Template
ila edited this page 2026-08-26 17:07:26 +08:00
部署文档模板
本页是技术栈中立的内部维护模板,不描述任何真实服务。常驻服务项目复制本结构建立自己的
Deployment-and-Operations页面;没有常驻服务时不要创建空页面。
本页用途
说明读者、环境和完成部署后应达到的可验证结果。
安全边界
- 只记录配置项名称和安全来源,不写真实密码、Token、私钥、证书内容或个人数据。
- 发布、迁移、恢复备份和删除必须写明授权条件、影响和停止位置。
- 每条命令注明执行位置、是否改变外部状态和预期结果。
服务概览
| 项目 | 内容 |
|---|---|
| 服务名 | 填写 |
| 运行账号 | 填写 |
| 代码/发布目录 | 填写 |
| 进程管理 | systemd / supervisor / 容器 / 其他 |
| 内部监听 | 填写 |
| 外部入口 | 填写 |
| 数据与依赖 | 填写 |
| 日志入口 | 填写 |
环境要求
列出操作系统、运行时、数据库、反向代理、构建机和命令版本,以及可复制的检查命令和预期结果。
配置与凭据来源
用表格写配置名称、用途、非敏感来源路径和是否敏感。敏感值只说明从哪个受控位置取得。
首次部署
按“创建账号与目录 → 安装服务和接入层 → 放置受控配置 → 备份 → 迁移 → 启动 → 健康检查”的真实顺序编写。
日常发布
记录固定提交、构建、上传、备份、预检、切换、验证和证据;发布脚本存在时以脚本为唯一日常入口,不复制一套手工命令造成分叉。
健康检查与日志
列出进程、内部 HTTP、外部 HTTPS、数据库版本和后台任务检查,以及服务日志、接入层日志和发布日志入口。
数据库迁移、备份与恢复
说明迁移授权、备份格式、完整性检查、保留位置、恢复前停止条件和恢复后的核对。代码回退与数据库恢复必须分开描述。
回退
说明自动回退范围、人工回退前置条件和无法安全回退时的停止位置。
已知限制
必须填写实际未演练或不支持的范围;没有就写“无”,不得保留占位文字。