69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
---
|
|
name: edge-deployment-writer
|
|
description: edge_collector 部署手册与上线方案编写规范。用于整理边缘侧、云平台、82/97/94/87 主机、runtime 同步、systemd 服务、回滚和验证步骤时,生成可执行部署文档。
|
|
---
|
|
|
|
# edge_collector 部署文档
|
|
|
|
## 固定项目约定
|
|
|
|
- 云平台部署优先使用 `deploy_cloud.sh`。
|
|
- 边缘打包使用 `package.sh`。
|
|
- 边缘同步使用 `scripts/migrate_edge.sh`。
|
|
- 用户明确要求执行 `install_all.sh` 时才执行;不要每次同步都运行。
|
|
- 同主机编译部署也要使用 `scripts/migrate_edge.sh`。
|
|
|
|
## 部署文档结构
|
|
|
|
```text
|
|
目标与范围
|
|
目标主机与账号
|
|
前置条件
|
|
构建步骤
|
|
同步/部署步骤
|
|
服务重启步骤
|
|
验证步骤
|
|
回滚方案
|
|
风险与注意事项
|
|
```
|
|
|
|
## 必须写清
|
|
|
|
- 源主机、目标主机、目标目录。
|
|
- 是否会覆盖运行配置。
|
|
- 是否需要重启 `edge`、`cloud-server` 或独立 agent。
|
|
- 是否需要执行 `install_all.sh`。
|
|
- 验证命令和预期输出。
|
|
|
|
## 常用验证
|
|
|
|
边缘:
|
|
|
|
```bash
|
|
systemctl is-active edge
|
|
curl -s http://127.0.0.1/api/status
|
|
```
|
|
|
|
云端:
|
|
|
|
```bash
|
|
systemctl is-active cloud-server
|
|
curl -s http://127.0.0.1:<port>/api/health
|
|
```
|
|
|
|
脚本:
|
|
|
|
```bash
|
|
bash -n scripts/<name>.sh
|
|
```
|
|
|
|
## 回滚说明
|
|
|
|
文档必须说明:
|
|
|
|
- 上一个 runtime/edge 或发布包位置。
|
|
- 如何恢复二进制和 web 资源。
|
|
- 哪些配置不能回滚覆盖。
|
|
- 回滚后如何重启服务和验证。
|
|
|