GitLab Runner 注册与使用教程

GitLab Runner 注册与使用教程(17.7)

注意:jdk,mvn,node等请自行安装配置,可以使用全局 或 指定路径的方式

1. 安装 GitLab Runner

在服务器上安装 GitLab Runner，以下步骤适用于 Linux 系统（例如 Ubuntu/Debian）。其他操作系统可以参考 GitLab 官方文档进行安装。

1.1 更新软件包并安装依赖

sudo apt-get update
sudo apt-get install -y curl

1.2 添加 GitLab Runner 存储库

curl -L --output /tmp/gitlab-runner.deb https://gitlab-runner-downloads.s3.amazonaws.com/latest/deb/gitlab-runner_amd64.deb
sudo dpkg -i /tmp/gitlab-runner.deb

1.3 检查安装是否成功

gitlab-runner --version

确认显示安装的版本号。

---

2. GitLab Runner 注册

2.1 获取 GitLab 注册 Token

在 GitLab 项目的 Settings > CI / CD 页面下，找到 Runners 部分，点击 Expand 展开。复制该页面下的 Registration Token。

2.2 注册 GitLab Runner

在服务器上执行以下命令进行 Runner 注册：

sudo gitlab-runner register --url https://gitlab.aabg.net --token <your-token>

• --url：指定 GitLab 实例的 URL（如 https://gitlab.aabg.net）。
• --token：从 GitLab 项目的 CI / CD 设置 页面获取的 注册 Token。

2.3 注册过程

1. 输入 GitLab 实例的 URL

   • 如果未指定 --url 参数，则提示输入 GitLab 实例的 URL。
   • 输入您的 GitLab 实例地址（例如：https://gitlab.aabg.net）。

2. 输入 GitLab Token

   • 输入 Registration Token，该 Token 用于将 Runner 注册到特定项目。

3. 输入 Runner 名称

   • 为 Runner 配置一个描述性名称，方便您管理和识别。例如：runner01。

4. 选择执行器类型

   • GitLab 提供了多种执行器类型（如 shell、docker 等）。
   • 如果选择 shell，表示该 Runner 会在本地机器上运行 shell 命令。
   • 输入 shell 或其他您所需的执行器类型。

5. 注册完成

   • 完成后，您会看到类似如下的输出，表示注册成功：

Runner registered successfully. Feel free to start it, but be aware that it is inactive until you configure it.

---

3. 配置 GitLab Runner

注册成功后，GitLab Runner 会保存相关配置文件。您可以根据需要修改配置文件来进行进一步的定制化设置。

3.1 配置文件路径

GitLab Runner 的配置文件位于：

/etc/gitlab-runner/config.toml

配置文件中会包含 Runner 的 URL、Token、执行器等信息。

3.2 配置 Runner 标签

在 config.toml 文件中，您可以为 Runner 配置多个标签。标签用于选择在 .gitlab-ci.yml 文件中使用的 Runner。

[[runners]]
  name = "runner01"
  url = "https://gitlab.aabg.net"
  token = "glrt-xxxxxxxxxx"
  executor = "shell"
  [runners.custom_build_dir]
  [runners.cache]
    MaxUploadedArchiveSize = 0

3.3 修改标签(请使用web管理)

如果需要为 Runner 添加标签，可以在 Web 端 配置，也可以手动在 config.toml 文件中配置。例如：

[runners]
  name = "runner01"
  url = "https://gitlab.aabg.net"
  token = "glrt-xxxxxxxxxx"
  executor = "shell"
  tags = ["linux", "docker", "high-memory"]

---

4. 启动 GitLab Runner

在注册和配置完成后，您可以通过以下命令启动 Runner：

sudo gitlab-runner start

此命令会启动 Runner，使其可以开始接受和执行 GitLab CI/CD 作业。

---

5. 在 GitLab CI/CD 配置文件中使用 Runner 标签

在 .gitlab-ci.yml 文件中，您可以为作业指定多个标签。GitLab 会根据 标签匹配 来选择 Runner 执行作业。

5.1 示例 .gitlab-ci.yml 配置

stages:
  - build
  - test
  - deploy

build-job:
  stage: build
  script:
    - echo "Compiling the application..."
    - mvn clean install -DskipTests
  tags:
    - linux  # 使用标签为 'linux' 的 Runner 执行该作业

unit-test-job:
  stage: test
  script:
    - echo "Running unit tests..."
    - mvn test
  tags:
    - linux
    - docker  # 必须使用同时具有 'linux' 和 'docker' 标签的 Runner

5.2 多个标签匹配规则

• 多个标签要求 Runner 同时具备所有标签。
• 例如，如果作业配置了标签 linux 和 docker，则只有同时具有这两个标签的 Runner 才能执行作业。

5.3 查看作业运行的 Runner

在 GitLab Web 界面 的 CI/CD 页面中，您可以查看作业执行的 Runner。如果没有找到合适的 Runner 或 Runner 被拒绝执行，确保标签设置正确，并且 Runner 已正确配置。

---

6. 常见问题与排查

6.1 标签匹配失败

• 确保您为 Runner 配置的标签与 .gitlab-ci.yml 中的标签完全匹配。
• 确保 Runner 已正确启动，并且其状态是 active。

6.2 查看 Runner 状态

可以通过以下命令检查 Runner 是否正常工作：

sudo gitlab-runner status

6.3 重启 GitLab Runner

如果遇到问题，可以尝试重启 Runner：

sudo gitlab-runner restart

6.4 更新 GitLab Runner

如果您需要更新 GitLab Runner，请执行以下命令：

sudo apt-get update
sudo apt-get upgrade gitlab-runner