s3nafps/cloudops-rescue-kit
GitHub: s3nafps/cloudops-rescue-kit
面向 Cloud/DevOps 支持工作的小型 VPS/Docker 运维工具包，提供诊断、监控、备份恢复验证和交接文档的可复现工作流。
Stars: 0 | Forks: 0
# CloudOps 救援工具包
[](https://github.com/s3nafps/cloudops-rescue-kit/actions/workflows/shell-syntax.yml)
[](https://github.com/s3nafps/cloudops-rescue-kit/actions/workflows/demo-lab.yml)
CloudOps Rescue Kit 是一个针对 Cloud/DevOps 支持工作的实用作品集项目。它可以帮助诊断小型 VPS/Docker 部署、添加轻量级监控、创建备份、测试恢复，并以客户或招聘经理可检查的方式记录结果。
该工具包围绕常见的运维故障点构建：
- “我的 Docker 应用宕机了。”
- “我不知道这台 VPS 上在运行什么。”
- “我们没有经过测试的备份。”
- “我们只能从用户那里发现停机。”
- “前任开发者没有留下任何交接文档。”
## 包含内容
- `scripts/collect-diagnostics.sh` - 生成 VPS/Docker 诊断报告。
- `scripts/health-check.sh` - 从简单的文本文件检查 endpoint 状态。
- `scripts/backup-compose-volumes.sh` - 备份 Docker Compose 管理的卷。
- `scripts/restore-volume-backup.sh` - 在明确确认后将备份归档恢复到 Docker 卷中。
- `scripts/docker-compose-preflight.sh` - 验证 Compose 文件并记录预检输出。
- `scripts/run-demo-lab.sh` - 运行完整的 Docker 演示证据工作流。
- `monitoring/docker-compose.uptime-kuma.yml` - 轻量级的 uptime 监控栈。
- `docs/` - 运行手册、截图清单、案例研究模板和安全说明。
- `examples/` - 面向客户的交付样本和可复用模板。
## 预期用途
- Linux VPS 或 Docker Compose 环境
- 面向小型支持的基础设施审查
- 用于 Cloud/DevOps 支持工作的可复现作品集证据
- 交接文档和经过恢复验证的工作流
## 环境要求
- Linux VPS、本地 Linux 虚拟机或 WSL Ubuntu
- Bash
- Docker 和 Docker Compose 插件
- curl
- 可选：用于监控仪表盘截图的 Uptime Kuma
## 快速开始
克隆仓库：
```
git clone https://github.com/s3nafps/cloudops-rescue-kit.git
cd cloudops-rescue-kit
chmod +x scripts/*.sh
```
生成诊断报告：
```
./scripts/collect-diagnostics.sh
```
检查 endpoint：
```
./scripts/health-check.sh monitoring/endpoints.example.txt
```
验证 Compose 文件：
```
./scripts/docker-compose-preflight.sh monitoring/docker-compose.uptime-kuma.yml
```
## 演示实验室
演示实验室在不触碰线上客户端系统的情况下创建可发布的证据：
```
docker compose -p cloudops-demo -f demo/docker-compose.demo.yml up -d
./scripts/collect-diagnostics.sh
./scripts/health-check.sh monitoring/endpoints.demo.txt
./scripts/backup-compose-volumes.sh cloudops-demo
```
完整演练：`docs/08-demo-lab.md`
GitHub Actions 也会自动运行演示并上传证据产物：
```
docs/09-ci-evidence.md
```
已发布的案例研究：
```
docs/case-studies/ci-demo-lab.md
```
交付样本案例研究：
```
docs/case-studies/sample-client-deliverables.md
```
启动 Uptime Kuma：
```
docker compose -f monitoring/docker-compose.uptime-kuma.yml up -d
```
备份项目的 Docker Compose 卷：
```
./scripts/backup-compose-volumes.sh myproject
```
恢复到测试卷中：
```
RESTORE_CONFIRM=YES ./scripts/restore-volume-backup.sh backups/myproject-20260703T120000Z/myproject_db-data.tar.gz myproject_restore_test
```
## 安全说明
- 私钥、密码、API token 和生产环境的 `.env` 文件绝不应出现在 issue、报告、截图或聊天中。
- 诊断脚本默认不收集环境变量或完整的 Docker inspect 输出。
- 容器日志可能包含敏感信息；`--include-logs` 仅适用于经过风险评估后的批准用途。
- 恢复验证专为一次性测试卷设计。
- 在停止高写入频率的服务后再进行备份是最安全的。
## 建议的证据
典型的案例研究证据包括：
1. 生成的诊断报告文件夹。
2. 修复前的 Docker 容器。
3. 隐藏了敏感信息的错误日志摘录。
4. 健康检查失败。
5. 应用修复。
6. 健康检查通过。
7. 备份归档和校验和。
8. 恢复到一次性测试卷的测试。
9. Uptime Kuma 仪表盘。
10. 最终事件报告。
参考资料可在 `docs/00-case-study-template.md` 和 `docs/01-screenshots-checklist.md` 中找到。
## 交付样本
公开的交接材料示例：
- `examples/sample-incident-report.md`
- `examples/sample-handover-note.md`
- `examples/incident-report.md`（模板）
- `examples/client-intake-form.md`（模板）
- `screenshots/public/README.md`（公开截图清单）
- `screenshots/public/captions.md`（案例研究说明）
## 仓库状态
本项目特意保持小巧且专注。未来的改进应反映真实的支持案例、面试问题或反复出现的运维缺口。
标签：Docker, Shell脚本, VPS, 安全防御评估, 应用安全, 数据备份, 版权保护, 监控, 系统诊断, 请求拦截, 运维工具