gitlab/gpt-data-generator

GPT Data Generator 镜像文档

1. 镜像概述和主要用途

GPT Data Generator 是一个专为 https://hub.docker.com/r/gitlab/gitlab-performance-tool (GPT) 设计的 Docker 镜像，用于生成性能测试所需的全套测试数据。其核心用途是在执行 GitLab 性能测试前，自动化创建标准化、可配置的测试数据集，确保 GPT 能够基于真实场景数据进行准确的性能评估。

2. 核心功能和特性

• 一站式测试数据生成：自动生成 GPT 所需的全类型测试数据（如项目、用户、分支、合并请求等），无需手动准备。
• 高度可配置：支持通过参数自定义数据规模（如项目数量、用户数、提交记录数等），适应不同性能测试场景。
• 与 GPT 无缝集成：生成的数据格式和结构完全符合 GPT 的输入要求，可直接用于性能测试流程。
• 轻量化部署：基于 Docker 容器化设计，无需复杂依赖，快速部署并执行数据生成任务。

3. 使用场景和适用范围

GPT Data Generator 主要适用于以下场景：

• GitLab 性能测试前置准备：在使用 GPT 对 GitLab 实例（自托管或 SaaS）进行性能测试前，生成标准化测试数据，确保测试环境一致性。
• 多环境数据复用：在开发、测试、预生产等不同环境中，通过统一配置快速复现相同测试数据集，便于对比性能差异。
• 高负载场景模拟：支持生成大规模数据（如千级项目、万级提交），模拟生产环境负载，验证 GitLab 在极限条件下的性能表现。

4. 使用方法和配置说明

4.1 前置条件

• 已安装 Docker 或 Docker Compose。
• 可访问的 GitLab 实例（目标测试环境）。
• 具备足够权限的 GitLab 访问令牌（需包含 api、read_user、write_repository 权限，用于创建资源）。

4.2 Docker 命令行运行示例

通过 docker run 直接启动容器，配置必要参数（环境变量或命令行参数）：

bash
docker run -it --rm \
  -e GITLAB_URL="https://gitlab.example.com" \  # 目标 GitLab 实例 URL
  -e ACCESS_TOKEN="glpat-xxxxxx" \             # 具备权限的访问令牌
  -e PROJECT_COUNT=200 \                       # 生成项目数量（默认 50）
  -e USER_COUNT=50 \                           # 生成用户数量（默认 20）
  -e GROUP_COUNT=30 \                          # 生成组数量（默认 10）
  -e DATA_OUTPUT_DIR="/data" \                 # 容器内数据输出目录（默认 /data）
  -v /local/output:/data \                     # 挂载本地目录持久化数据
  gitlab/gpt-data-generator:latest

参数说明：

• -it：交互式运行，实时查看日志输出。
• --rm：容器退出后自动删除。
• -v /local/output:/data：将容器内生成的数据挂载到本地 /local/output 目录，便于后续查看或复用。

4.3 Docker Compose 配置示例

创建 docker-compose.yml 文件，定义服务及配置：

yaml
version: '3.8'

services:
  gpt-data-generator:
    image: gitlab/gpt-data-generator:latest
    container_name: gpt-data-gen
    environment:
      GITLAB_URL: "https://gitlab.example.com"       # 目标 GitLab 实例 URL（必填）
      ACCESS_TOKEN: "glpat-xxxxxx"                  # GitLab 访问令牌（必填）
      PROJECT_COUNT: 150                             # 项目数量（默认 50）
      USER_COUNT: 30                                # 用户数量（默认 20）
      GROUP_COUNT: 20                               # 组数量（默认 10）
      BRANCH_COUNT: 8                               # 每个项目分支数（默认 5）
      COMMIT_COUNT: 50                              # 每个分支提交数（默认 20）
      VERBOSE: "true"                               # 启用详细日志（默认 false）
    volumes:
      - ./gpt-test-data:/data                       # 本地目录挂载，存储生成数据
    restart: on-failure                             # 失败时自动重启

启动服务：

bash
docker-compose up

4.4 数据生成验证

数据生成完成后，可通过以下方式验证：

1. 查看本地挂载目录（如 ./gpt-test-data）是否生成数据清单文件（如 projects.csv、users.json）。
2. 登录 GitLab 实例，通过管理界面确认生成的项目、用户、组等资源已创建。

5. 配置参数说明

5.1 环境变量配置

以下为常用环境变量，用于定义数据生成规则和连接信息（具体参数以官方文档为准）：

5.2 命令行参数覆盖

支持通过命令行参数覆盖环境变量配置（优先级更高），格式如下：

bash
docker run gitlab/gpt-data-generator:latest \
  --gitlab-url "https://gitlab.example.com" \
  --access-token "glpat-xxxxxx" \
  --project-count 300 \
  --verbose true

6. 参考文档

• 官方配置指南：GPT Data Generator 环境准备
• GitLab 访问令牌创建：个人访问令牌文档
• GitLab Performance Tool 镜像：https://hub.docker.com/r/gitlab/gitlab-performance-tool