Tuxmint-Open-Source/misp-docker-lifecycle-manager
GitHub: Tuxmint-Open-Source/misp-docker-lifecycle-manager
该工具为官方 MISP Docker 单服务器部署提供非侵入式的全生命周期管理,涵盖安装、备份、更新与回滚等运维流程。
Stars: 1 | Forks: 0
# MISP Docker 生命周期管理器
官方 `MISP/misp-docker` 单服务器 Docker 部署的非侵入式生命周期管理器。
当前管理器版本:`1.0.0-rc.2`
MISP Docker 生命周期管理器可帮助运维人员安装、配置、验证、更新、备份、恢复以及安全移除 MISP Docker 部署,同时确保生成的部署仍然是一个标准的官方上游检出。
## 它是什么
本项目是官方 `MISP/misp-docker` 的一个运维封装。
它新增了:
- 安装与主机准备辅助工具;
- 生成的 `.env` 值与 Compose override;
- 确定性的组件标签处理;
- 健康、状态、登录与凭证检查;
- 备份、恢复、更新以及基于恢复的回滚工作流;
- 带有安全检查的重置/移除辅助工具;
- 兼容性与验证文档。
它**不会** fork、vendor 或复制 MISP。它**不会**替代上游的 `MISP/misp-docker`。它不是 Kubernetes、高可用或多节点编排层。
没有任何供应商锁定:成功安装后,`/opt/misp-docker` 依然是一个标准的官方 `MISP/misp-docker` 检出,可以使用 Docker Compose 手动进行管理。
## 从这里开始
| 如果你想... | 阅读此文档 |
| --- | --- |
| 熟悉项目概览 | [`docs/README.md`](docs/README.md) |
| 进行首次测试安装 | [`docs/getting-started.md`](docs/getting-started.md) |
| 遵循常规的运维生命周期 | [`docs/operator-guide.md`](docs/operator-guide.md) |
| 确认项目是否符合你的用例 | [`docs/support-matrix.md`](docs/support-matrix.md) |
| 规划正式的生产部署 | [`docs/production-deployment.md`](docs/production-deployment.md) |
| 了解备份、恢复与回滚 | [`docs/backup-restore-and-rollback.md`](docs/backup-restore-and-rollback.md) |
| 检查已验证的 MISP 组件集 | [`docs/compatibility.md`](docs/compatibility.md) |
| 对故障进行排查 | [`docs/troubleshooting.md`](docs/troubleshooting.md) |
| 查阅每个命令的详情 | [`docs/shell-scripts.md`](docs/shell-scripts.md) |
| 报告安全漏洞 | [`SECURITY.md`](SECURITY.md) |
## 快速测试路径
若要进行首次候选版本(RC)测试,请阅读 [`docs/getting-started.md`](docs/getting-started.md)。其精简流程为:
```
git clone https://github.com/Tuxmint-Open-Source/misp-docker-lifecycle-manager.git
cd misp-docker-lifecycle-manager
git checkout v1.0.0-rc.2
sudo ./installer/prepare-host-rocky.sh
sudo ./installer/install.sh \
--install-dir /opt/misp-docker \
--upstream-ref master \
--base-url https://misp.example.com \
--admin-email admin@example.com \
--admin-org ExampleOrg \
--timezone Europe/Zurich \
--exposure reverse-proxy
```
安装完成后:
```
sudo ./installer/doctor.sh --install-dir /opt/misp-docker
sudo ./installer/login-check.sh --install-dir /opt/misp-docker
sudo ./installer/admin-credentials.sh --install-dir /opt/misp-docker
```
针对生产规划、反向代理详情、恢复、更新和限制条件,请参考文档导图,不要仅将此快速路径视为完整指南。
## 兼容性状态
兼容性以明确的配对形式进行追踪:
```
manager release/ref × official MISP Docker component set = status
```
| 管理器发布/引用 | MISP core | MISP modules | MISP guard | 状态 |
| --- | ---: | ---: | ---: | --- |
| `v1.0.0-rc.2` 候选发布标签 | `v2.5.43` | `v3.0.8` | `v1.2` | ✅ 验证兼容 |
| `v1.0.0-rc.1` 候选发布标签 | `v2.5.43` | `v3.0.8` | `v1.2` | ✅ 验证兼容 |
| `v0.3.3` 发布标签 | `v2.5.43` | `v3.0.8` | `v1.2` | ✅ 验证兼容 |
| `v0.3.2` 发布标签 | `v2.5.43` | `v3.0.8` | `v1.2` | ❌ 验证失败 |
有关状态定义、详细报告和限制条件,请参阅 [`docs/compatibility.md`](docs/compatibility.md) 和 [`docs/validation/matrix.md`](docs/validation/matrix.md)。
## 版本模型
这里包含三个独立的版本概念:
| 概念 | 受控于 | 用途 |
| --- | --- | --- |
| 生命周期管理器版本 | 本仓库的 `VERSION`、Git 标签、GitHub Releases | 这些辅助脚本和文档的版本 |
| 上游检出 | `--upstream-ref` | `/opt/misp-docker` 中使用的官方 `MISP/misp-docker` 分支/commit |
| 运行时组件镜像 | `CORE_RUNNING_TAG`, `MODULES_RUNNING_TAG`, `GUARD_RUNNING_TAG` | Docker Compose 使用的实际 MISP 容器镜像标签 |
检查当前的上游组件版本:
```
./installer/get-current-misp-versions.sh
```
将本地安装与上游进行比较:
```
./installer/get-current-misp-versions.sh --install-dir /opt/misp-docker
```
有关更新策略和版本详情,请参阅 [`docs/upgrade-path.md`](docs/upgrade-path.md) 和 [`docs/versioning.md`](docs/versioning.md)。
## 设计原则
1. 保持官方上游干净整洁。
2. 优先使用生成的 `.env` 和 `docker-compose.override.yml`,而不是修改上游文件补丁。
3. 锁定运行时组件标签,而不是依赖 Docker 隐式的 `latest` 行为。
4. 更新前进行备份,并使用基于恢复的方式进行回滚演练。
5. 在声明登录就绪之前,等待应用自身的就绪状态。
6. 确保生产声明与精确的发布标签验证保持一致。
## 发布就绪状态
`v1.0.0-rc.2` 已验证与文档中记载的 MISP Docker 组件集兼容,但在最终的 `v1.0.0` 被单独标记并验证之前,该项目仍会保留公开的生产环境警告。
请参阅 [`docs/production-readiness.md`](docs/production-readiness.md)。
## 贡献
欢迎贡献代码。请从 [`CONTRIBUTING.md`](CONTRIBUTING.md) 开始,了解公共安全规则、PR 工作流、验证命令以及兼容性声明的要求。
请确保对公开示例进行脱敏处理,避免提交生成的密钥、运行时的 `.env` 文件、原始日志、私有基础设施详情或特定于部署的凭证。
有用的项目文档:
- [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [`AGENTS.md`](AGENTS.md)
- [`QA.md`](QA.md)
- [`CHANGELOG.md`](CHANGELOG.md)
- [`docs/release/release-process.md`](docs/release/release-process.md)
标签:Cutter, Docker, 威胁情报, 安全防御评估, 开发者工具, 版权保护, 生命周期管理, 请求拦截, 运维工具, 部署工具