fidelityinternational/ci-tools

Ubuntu 基础 CI 工具镜像文档

1. 镜像概述和主要用途

本镜像是一个基于 Ubuntu 操作系统的 CI（持续集成）工具镜像，旨在为自动化构建、测试和部署流程提供标准化的运行环境。通过整合 Ubuntu 的稳定基础与 CI 流程常用工具，简化持续集成任务的环境配置，确保跨项目、跨平台的一致性。

2. 核心功能和特性

2.1 基础环境

• 基于 Ubuntu 稳定版：采用官方 Ubuntu 镜像作为基础，确保系统级稳定性和兼容性。
• 多架构支持：通常提供 amd64、arm64 等主流架构版本，适配不同硬件环境。

2.2 预装 CI 常用工具

通常包含以下工具（具体版本依镜像标签而定）：

• 版本控制：Git、SVN
• 构建工具：Make、CMake、Maven、Gradle
• 容器化工具：Docker CLI、Docker Compose
• 网络工具：curl、wget、rsync
• 系统工具：sudo、bash、zsh、tar、gzip
• 编程语言依赖：Python、Node.js、OpenJDK（基础版本）

2.3 轻量级设计

在保证功能完整性的前提下，通过精简非必要组件和采用多阶段构建，控制镜像体积，提升运行效率。

2.4 可扩展性

支持通过自定义脚本或配置文件扩展工具链，满足特定项目的个性化需求。

3. 使用场景和适用范围

3.1 自动化构建流程

作为 CI 管道的执行环境，用于代码拉取、依赖安装、编译打包等构建任务。

3.2 测试环境

提供标准化的运行时环境，执行单元测试、集成测试、性能测试等自动化测试用例。

3.3 持续集成任务

适配 Jenkins、GitLab CI/CD、GitHub Actions 等主流 CI 平台，作为任务执行容器。

3.4 多阶段 CI/CD 管道

在复杂流水线中作为中间环节，完成代码检查、静态分析、镜像构建等特定步骤。

4. 使用方法和配置说明

4.1 基本使用（docker run）

4.1.1 交互式运行

bash
docker run -it --rm [镜像名称]:[标签] /bin/bash

• -it：交互式终端模式，支持命令行操作。
• --rm：退出后自动删除容器，避免残留。
• [镜像名称]:[标签]：替换为实际镜像名称（如 ubuntu-ci-tooling）和版本标签（如 latest、22.04）。

4.1.2 执行自动化任务

挂载本地项目目录并运行构建脚本：

bash
docker run --rm -v $(pwd):/app -w /app [镜像名称]:[标签] sh -c "git pull && make build && make test"

• -v $(pwd):/app：将当前目录挂载到容器内 /app 路径，实现项目文件共享。
• -w /app：设置工作目录为 /app。
• sh -c "..."：执行构建和测试命令序列。

4.2 Docker Compose 配置示例

适用于多服务协同的 CI 场景（如依赖数据库、缓存服务）：

yaml
version: '3.8'
services:
  ci-task:
    image: [镜像名称]:[标签]
    volumes:
      - ./project:/workspace  # 挂载项目代码
      - /var/run/docker.sock:/var/run/docker.sock  # 共享宿主机 Docker 守护进程（如需容器内构建镜像）
    environment:
      - CI_PROJECT_DIR=/workspace  # 定义项目目录环境变量
      - BUILD_ENV=production  # 传递构建环境参数
    command: sh -c "cd /workspace && ./ci/pipeline.sh"  # 执行自定义 CI 脚本
    depends_on:
      - db  # 依赖的其他服务（如数据库）

  db:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=root
      - MYSQL_DATABASE=test_db

4.3 配置说明

4.3.1 环境变量

4.3.2 卷挂载建议

• 项目代码：挂载本地代码目录至容器内工作目录（如 /app、/workspace），避免镜像内固化代码。
• 工具缓存：挂载 ~/.m2（Maven）、~/.npm（npm）等缓存目录，加速依赖安装。
• Docker 守护进程：如需在容器内构建 Docker 镜像，挂载 /var/run/docker.sock（需注意权限安全）。

4.3.3 自定义工具安装

如需补充工具，可通过 Dockerfile 基于本镜像扩展：

dockerfile
FROM [镜像名称]:[标签]
RUN apt-get update && apt-get install -y \
    golang \  # 安装 Go 语言环境
    && rm -rf /var/lib/apt/lists/*  # 清理 apt 缓存

5. 注意事项

• 镜像标签：建议使用具体版本标签（如 22.04）而非 latest，避免因基础镜像更新导致环境变更。
• 权限管理：默认以 root 用户运行，生产环境可通过 USER 指令切换为非特权用户，增强安全性。
• 工具版本：预装工具版本可能随镜像更新变化，如需固定版本，建议在使用前通过 [工具名] --version 验证。