kibatic/gitlab-runner

GitLab CI Runner 介绍

1. 什么是 GitLab CI Runner？

GitLab CI Runner 是 GitLab CI/CD（持续集成/持续部署）系统的「执行器」，负责接收并运行 GitLab 服务器下发的 CI/CD 任务（如代码构建、自动化测试、应用部署等）。它独立于 GitLab 服务器，可部署在本地服务器、云主机、容器或物理机中，支持分布式执行任务。

2. 核心作用

• 解耦任务与 GitLab 服务器：避免 GitLab 服务器因运行任务占用资源，提升系统稳定性。
• 多环境适配：可在 Linux、Windows、macOS 等系统，或 Docker、Kubernetes 等容器环境中部署，满足跨平台任务需求（如多系统构建）。
• 灵活扩展：通过部署多个 Runner，实现任务并发执行，缩短流水线耗时。

3. 基本工作流程

1. 注册 Runner：将 Runner 注册到 GitLab 项目/实例（需 GitLab 提供的 URL 和注册令牌），建立通信连接。
2. 监听任务队列：Runner 持续向 GitLab 服务器查询待执行任务。
3. 执行任务：接收任务后，拉取代码仓库，按 .gitlab-ci.yml 配置的脚本（如测试、构建命令）运行，实时反馈日志。
4. 返回结果：任务完成后，将执行状态（成功/失败）及产物（如构建包）返回给 GitLab，随后等待下一个任务。

4. 配置与使用步骤

4.1 安装 Runner

根据部署环境选择安装方式：

• Linux：通过包管理器安装（如 Ubuntu：sudo apt-get install gitlab-runner；CentOS：sudo yum install gitlab-runner）。
• Windows/macOS：从 GitLab 官网 下载安装包，按向导完成安装。
• 容器：用 Docker 运行（示例命令）：

  bash
  docker run -d --name gitlab-runner --restart always \
    -v /srv/gitlab-runner/config:/etc/gitlab-runner \
    -v /var/run/docker.sock:/var/run/docker.sock \
    gitlab/gitlab-runner:latest
  

4.2 注册 Runner 到 GitLab

1. 获取注册信息：
   进入 GitLab 项目 → 设置 → CI/CD → Runners，展开「Runner 详情」，复制 GitLab URL（如 `[***] 注册令牌（Registration token）。
2. 执行注册命令：
   在 Runner 所在机器运行 gitlab-runner register，按提示输入：
   • GitLab URL 和注册令牌
   • Runner 描述（如「测试环境 Runner」）
   • 标签（用于匹配任务，如 test-linux，多个标签用逗号分隔）
   • 执行器类型（如 shell、docker、kubernetes，根据任务需求选择）。
3. 验证注册：注册后，在 GitLab 项目的「Runners」页面可看到 Runner 状态为「活跃」，表示通信正常。

4.3 配置 Runner 参数（可选）

注册后，Runner 配置文件（通常路径：Linux /etc/gitlab-runner/config.toml，Windows C:\GitLab-Runner\config.toml）可调整参数：

• concurrent：允许同时运行的任务数（默认 1，根据机器资源调整）。
• tags：修改 Runner 标签，用于 .gitlab-ci.yml 中指定任务使用该 Runner。
• 执行器配置：如 Docker 执行器可指定默认镜像（docker-image = "alpine:latest"）。

4.4 运行 CI/CD 任务

1. 定义任务：在项目根目录创建 .gitlab-ci.yml 文件，配置任务步骤（如测试、构建），并通过 tags 指定 Runner（示例）：
   CODE_TOKEN_1
2. 触发流水线：提交代码到 GitLab 仓库，或在项目「CI/CD → 流水线」页面手动触发，GitLab 会自动分配任务给匹配的 Runner。
3. 查看结果：在 GitLab 流水线页面，可实时查看任务日志、执行状态及产物（如测试报告、构建包）。

5. 常见使用场景

• 自动化测试：Runner 拉取代码后，自动运行单元测试（如 pytest、jest），快速反馈代码质量。
• 多环境部署：通过不同标签的 Runner（如 dev-runner、prod-runner），分别处理开发、生产环境部署，隔离风险。
• 定时任务：在 .gitlab-ci.yml 中用 schedule 配置定时触发（如每天凌晨运行数据备份脚本），由 Runner 执行。
• 跨平台构建：在 Linux Runner 构建后端服务，Windows Runner 构建桌面应用，实现一套代码多平台输出。

6. 注意事项

• 权限配置：Runner 所在机器需具备任务依赖（如 Git、构建工具、部署目标访问权限）。
• 资源隔离：用 Docker/K8s 执行器时，通过容器隔离任务环境，避免依赖冲突。
• 版本兼容：定期更新 Runner 版本，确保与 GitLab 服务器版本匹配（可通过 gitlab-runner --version 查看）。

通过以上步骤，可快速部署并使用 GitLab CI Runner，实现自动化、高效的 CI/CD 流程。