akiunlocks/deployer

CD Deployer 镜像文档

镜像概述

CD Deployer是一款专注于持续部署（Continuous Deployment）自动化的Docker镜像，旨在简化应用从构建完成到生产环境上线的全流程。通过标准化部署流程、集成主流CI/CD工具及提供灵活的配置能力，帮助团队实现高效、可靠的自动化部署，减少人工操作成本并降低部署风险。

核心功能与特性

• 自动化部署流程：支持从代码构建产物到目标环境的全流程自动化，无需人工干预
• 多环境部署支持：可配置开发、测试、预发、生产等多环境部署目标，统一管理环境差异
• CI/CD工具集成：兼容Jenkins、GitLab CI、GitHub Actions、GitLab Runner等主流CI工具，支持触发式部署
• 部署状态监控：实时采集部署进度、资源占用等指标，通过日志输出部署详情，支持部署状态回调通知
• 失败回滚机制：支持配置部署失败自动回滚策略，保障业务连续性
• 自定义部署逻辑：允许挂载外部部署脚本，满足复杂业务场景下的个性化部署需求（如数据库迁移、服务预热等）

使用场景与适用范围

• DevOps团队自动化部署：标准化部署流程，实现"代码提交即部署"的CI/CD闭环
• 多环境应用发布：统一管理开发、测试、生产环境的部署配置，避免环境差异导致的部署问题
• 高频迭代项目：支持快速、频繁的应用发布，适配敏捷开发模式下的短周期迭代需求
• 复杂架构应用部署：兼容微服务、单体应用、容器化/非容器化等多种架构的部署场景
• 跨平台部署需求：支持云服务器、Kubernetes集群、Serverless平台等多种部署目标

使用方法与配置说明

快速启动（docker run）

通过docker run命令可快速启动部署任务，示例如下：

bash
docker run -d \
  --name cd-deployer-prod \
  -e DEPLOY_TARGET="https://k8s-prod.example.com/api" \  # 生产环境部署目标API地址
  -e API_KEY="prod-ci-cd-token-12345" \                  # 目标环境认证密钥
  -e SCRIPT_PATH="/deploy/scripts/prod-deploy.sh" \      # 自定义部署脚本路径（容器内）
  -e ROLLBACK_ON_FAILURE="true" \                        # 启用失败回滚
  -e LOG_LEVEL="debug" \                                 # 调试模式日志输出
  -v /local/deploy-scripts:/deploy/scripts \             # 挂载本地部署脚本目录
  cd-deployer:latest

Docker Compose 配置示例

对于长期运行的部署服务（如监听CI触发事件），可通过docker-compose配置持久化部署环境：

yaml
version: '3.8'
services:
  cd-deployer:
    image: cd-deployer:latest
    container_name: cd-deployer-service
    restart: unless-stopped
    environment:
      - DEPLOY_TARGET="https://k8s-test.example.com/api"  # 测试环境部署目标
      - API_KEY="test-ci-cd-token-67890"                  # 测试环境认证密钥
      - SCRIPT_PATH="/deploy/scripts/test-deploy.sh"       # 测试环境部署脚本
      - TIMEOUT="600"                                     # 部署超时时间（10分钟）
      - ROLLBACK_ON_FAILURE="true"                        # 启用失败回滚
    volumes:
      - ./test-deploy-scripts:/deploy/scripts             # 本地测试脚本目录挂载
      - ./deploy-logs:/var/log/cd-deployer                # 部署日志持久化
    networks:
      - ci-cd-network                                     # 接入CI工具所在网络

networks:
  ci-cd-network:
    external: true

核心配置参数（环境变量）

部署流程说明

1. 初始化阶段：容器启动后加载环境变量，校验DEPLOY_TARGET和API_KEY等必填参数
2. 环境预检查：测试与部署目标的网络连通性，验证认证密钥有效性
3. 脚本执行：根据SCRIPT_PATH加载部署脚本（内置或外部挂载），按脚本逻辑执行部署操作
4. 状态监控：实时输出部署日志，记录关键节点状态（如"开始部署"、"服务重启中"、"部署完成"）
5. 结果处理：部署成功时返回状态码0并触发NOTIFY_WEBHOOK（若配置）；失败时执行回滚逻辑（若启用）并返回非零状态码

注意事项

• 挂载外部部署脚本时，需确保脚本具有可执行权限（可通过chmod +x预先处理）
• 生产环境建议通过API_KEY使用最小权限账户，避免密钥泄露导致的安全风险
• 部署超时时间（TIMEOUT）需根据应用规模调整，大型应用建议设置较长超时（如10-15分钟）
• 失败回滚功能依赖目标环境支持版本回退能力（如K8s Deployment历史版本、应用版本管理系统）