RSHOP Pipeline Docker镜像文档

1. 镜像概述

RSHOP Pipeline Docker镜像是一个专为RSHOP电商系统设计的CI/CD流水线工具容器化解决方案。该镜像封装了构建、测试和部署RSHOP应用所需的全套工具链和配置，旨在简化开发流程并确保环境一致性。

2. 核心功能和特性

• 集成化工具链：包含构建、测试、打包RSHOP应用所需的全部依赖组件
• 环境隔离：提供独立的构建环境，避免开发环境与生产环境冲突
• 标准化流程：固化最佳实践的构建部署流程，确保团队协作一致性
• 可定制化：支持通过配置参数调整流水线行为以适应不同项目需求
• 多阶段构建：内置多阶段构建能力，优化最终部署产物大小

3. 使用场景和适用范围

• RSHOP电商系统的日常开发构建流程
• 自动化测试和质量检查执行
• 持续集成/持续部署流程集成
• 多环境部署（开发、测试、预生产、生产）
• 版本发布管理和 artifact 生成

4. 使用方法和配置说明

4.1 基本使用

docker run -it --rm rshop/pipeline:latest

4.2 常用命令

# 执行完整构建流程
docker run --rm -v $(pwd):/app rshop/pipeline:latest build

# 仅执行单元测试
docker run --rm -v $(pwd):/app rshop/pipeline:latest test

# 生成部署包
docker run --rm -v $(pwd):/app rshop/pipeline:latest package

# 部署到测试环境
docker run --rm -v $(pwd):/app -e DEPLOY_ENV=test rshop/pipeline:latest deploy

4.3 Docker Compose配置

version: '3'
services:
  rshop-pipeline:
    image: rshop/pipeline:latest
    volumes:
      - ./:/app
      - ~/.ssh:/root/.ssh
      - ~/.m2:/root/.m2
    environment:
      - PROJECT_NAME=my-rshop-project
      - BUILD_PROFILE=production
      - DEPLOY_ENV=staging
      - DB_HOST=db
      - DB_USER=test
      - DB_PASSWORD=secret
    depends_on:
      - db
      
  db:
    image: mysql:5.7
    environment:
      - MYSQL_ROOT_PASSWORD=secret
      - MYSQL_DATABASE=rshop_test

4.4 环境变量配置

4.5 高级配置

通过挂载自定义配置文件覆盖默认行为：

docker run --rm \
  -v $(pwd):/app \
  -v $(pwd)/custom-pipeline.yml:/etc/rshop/pipeline.yml \
  rshop/pipeline:latest build

5. 自定义流水线配置

创建pipeline.yml文件自定义流水线阶段：

stages:
  - name: prepare
    commands:
      - echo "Preparing build environment"
      - npm install
  
  - name: compile
    commands:
      - mvn compile
  
  - name: test
    commands:
      - mvn test
    ignore_failure: false
  
  - name: package
    commands:
      - mvn package -DskipTests
  
  - name: deploy
    commands:
      - ./deploy.sh
    only:
      - master

6. 注意事项

• 确保挂载的宿主机目录具有适当的读写权限
• 敏感信息建议通过环境变量或密钥管理服务注入，避免硬编码
• 首次运行可能需要较长时间下载依赖，后续运行将利用缓存加速
• 生产环境部署建议使用特定版本标签而非latest，确保构建一致性

7. 故障排除

• 构建失败：检查日志输出，确认依赖是否完整，网络连接是否正常
• 权限问题：确保挂载目录权限正确，可尝试添加-u $(id -u):$(id -g)参数
• 缓存问题：如需清理缓存，可添加--no-cache参数或删除挂载的缓存目录
• 配置错误：使用--debug标志运行以获取详细调试信息

docker run --rm -v $(pwd):/app rshop/pipeline:latest --debug build