merjasec/docker-compose

docker-docker-compose 镜像文档

镜像概述

docker-docker-compose是一个预安装了docker-compose工具的Docker镜像，旨在简化Gitlab CI流水线中的容器化操作流程。通过集成docker-compose，该镜像可直接在CI环境中管理多容器应用，无需在CI runner中单独配置docker-compose依赖，提升CI/CD流程的便捷性和一致性。

核心功能与特性

• 内置docker-compose：镜像预安装docker-compose工具，可直接使用docker-compose命令管理多容器应用（如定义、运行、停止服务）。
• 轻量级设计：基于精简基础镜像构建，体积小巧，适合CI/CD环境中的快速启动和资源高效利用。
• CI友好：针对Gitlab CI流水线优化，可直接作为CI job的执行环境，减少runner配置复杂度。

使用场景

• Gitlab CI流水线中的多容器应用管理：在CI流程中（如构建、测试、部署阶段），通过docker-compose启动依赖服务（如数据库、缓存、中间件）或编排应用服务。
• CI环境中的容器化任务：替代在CI runner中手动安装docker-compose的步骤，统一工具版本，避免环境差异导致的问题。
• 自动化部署流程：在Gitlab CI中使用docker-compose实现多容器应用的一键部署或回滚。

使用方法与配置说明

基本使用（docker run命令）

直接通过docker run命令启动镜像，执行docker-compose操作：

bash
# 示例：运行docker-compose版本查看
docker run --rm docker.xuanyuan.run/my-docker-compose-image docker-compose --version

# 示例：在CI环境中启动服务（需挂载宿主机Docker套接字）
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock -v $(pwd):/app -w /app docker.xuanyuan.run/my-docker-compose-image docker-compose up -d

参数说明：

• -v /var/run/docker.sock:/var/run/docker.sock：挂载宿主机Docker套接字，使容器内的docker-compose能与宿主机Docker引擎通信。
• -v $(pwd):/app：挂载当前目录（含docker-compose.yml文件）到容器内/app目录。
• -w /app：设置工作目录为/app，确保docker-compose能找到配置文件。

在Gitlab CI中集成

在Gitlab CI配置文件（.gitlab-ci.yml）中，可将该镜像指定为job的执行环境，直接使用docker-compose命令：

yaml
stages:
  - test

test-service:
  stage: test
  image: docker.xuanyuan.run/my-docker-compose-image  # 替换为实际镜像名称/地址
  services:
    - docker:dind  # 如需在CI中使用Docker引擎，需添加docker-in-docker服务
  variables:
    DOCKER_HOST: tcp://docker:2376
    DOCKER_DRIVER: overlay2
  script:
    - docker-compose --version  # 验证docker-compose可用性
    - docker-compose up -d  # 启动服务（假设项目根目录存在docker-compose.yml）
    - docker-compose run app pytest  # 示例：在服务容器中执行测试命令
    - docker-compose down  # 停止并清理服务

注意事项

1. Docker权限：在CI环境中使用时，需确保CI runner或docker-in-docker服务具有足够权限，允许容器内访问Docker引擎。
2. 配置文件路径：确保项目中的docker-compose.yml文件路径正确，或通过-f参数指定配置文件位置（如docker-compose -f ./path/to/docker-compose.yml up）。
3. 镜像版本：建议指定具体镜像版本（如:v2.23.3），避免因工具版本变更导致CI流程异常。