如何在 GitLab 执行器中使用 Podman

使用 Podman 启动 GitLab 执行器有多种方法，我在本文中概述了其中两种。

GitLab 执行器Runner 是一个与 GitLab CI/CD 配合使用的应用，可在 GitLab 基础设施上的流水线中运行作业。它们通常用于在提交代码后自动编译应用或在代码库上运行测试。你可以将它们视为基于云的 Git 钩子。

主要的公共 GitLab 实例提供了许多易于访问的共享执行器，可供你在 CI 流水线中使用。你可以在 GitLab 上仓库的 设置Settings -> CI/CD -> 执行器Runners 中找到共享执行器的列表。

你可能不想依赖共享执行器，而是选择自己的执行器，原因有很多。例如，控制执行器运行的基础设施以实现额外的安全性和/或隐私、灵活的执行器配置或分配给你的 GitLab 用户帐户的有限 CI 分钟数。

GitLab 执行器依赖于 执行环境executor 工具来运行 CI 作业。执行环境有许多选项可用：Docker、Kube.NETes、VirtualBox 等。

那么，Podman 作为执行环境呢？

自 v4.2.0起，Podman 对 GitLab 执行器提供了原生支持。以下是使用 Podman 作为 GitLab 执行器的执行环境的两种方法的快速浏览。

Docker 执行环境

你可以在 GitLab 执行器中使用 Podman 作为 Docker 的直接替代品。就是这样：

本示例使用 2023 年 2 月的 centos Stream 9 环境，使用 Podman v4.4.0。它应该可以在任何具有足够新的 Podman 的 RHEL/CentOS Stream/Fedora 环境中正常工作。查看 GitLab 文档了解先决条件。

首先，安装 Podman：

$ sudo dnf -y install podman

接下来安装 gitlab-runner包：

# 添加 GitLab 执行器仓库
$ curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.rpm.sh" | sudo bash

# 安装 gitlab-runner 包
$ sudo dnf -y install gitlab-runner

最后，允许用户在注销后执行任务：

$ sudo loginctl enable-linger gitlab-runner

配置并注册执行器

使用以下步骤配置 Docker 运行环境。

安装 gitlab-runner包会创建一个gitlab-runner用户帐户，但你需要 root 访问权限才能操作该用户帐户。gitlab-runner可以在用户模式下运行，但需要一些手动干预来进行构建处理。在此示例中，我使用sudo在系统模式下运行它。它看起来是这样的：

$ sudo gitlab-runner register
Runtime platform                                    arch=amd64 os=linux pid=7978 revision=d540b510 version=15.9.1
Running in system-mode.

Enter the GitLab instance URL (for example, https://gitlab.com/):
https://gitlab.com
Enter the registration token:
xxxxxxxxxxxxxxxxx
Enter a description for the runner:
[lmandvek-c9s-gitlab-runner]:
Enter tags for the runner (comma-separated):

Enter optional mAIntenance note for the runner:

WARNING: Support for registration tokens and runner parameters in the 'register' command has been deprecated in GitLab Runner 15.6 and will be replaced with support for authentication tokens. For more information, see https://gitlab.com/gitlab-org/gitlab/-/issues/380872
Registering runner... succeeded                     runner=GR13489419oEPYcJ8
Enter an executor: custom, docker, ssh, docker-ssh+machine, docker-ssh, parallels, shell, virtualbox, docker+machine, instance, kubernetes:
docker
Enter the default Docker image (for example, ruby:2.7):
registry.gitlab.com/rhcontainerbot/pkg-builder
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!

Configuration (with the authentication token) was saved in "/etc/gitlab-runner/config.toml"

你将需要一些额外的配置才能使用 Podman。配置执行器为每个作业创建一个网络。有关更多信息，请参阅 GitLab 文档。

首先，启用 Podman 系统服务并修改
/etc/gitlab-runner/config.toml中的环境：

[[runners]]
    environment = ["FF_NETWORK_PER_BUILD=1"]
    [runners.docker]
        host = "unix:///run/user/1001/podman/podman.sock"

重启执行器以实施更改：

$ sudo gitlab-runner restart

验证新的执行器在 GitLab 项目的 设置Settings -> CI/CD -> 执行器Runners 中可见：

接下来，验证你的 CI 流水线正在使用执行器。你的 CI 任务日志将提及正在使用的执行器的名称以及任何其他配置信息，例如 执行器的执行环境的功能标志和容器镜像。

Podman-in-Podman（pipglr）

Chris Evich创建了pipglr，这是一个 Podman-in-Podman 设置，用于使用免 root 的 Podman 来支持你自己的免 root 的 GitLab 执行器。此方法不需要对.gitlab-ci.yaml配置进行任何更改，因此你可以继续按原样使用现有设置。

以下是帮助你运行此程序的快速设置指南。

配置步骤

容器镜像是从 pipglr Containerfile自动构建的，因此将镜像设置为该仓库：

$ IMAGE="registry.gitlab.com/qontainers/pipglr:latest"

接下来，使用你的 GitLab 注册令牌创建 Podman 密钥：

$ echo '

创建一个空白的 config.toml，稍后将包含你的所有执行器设置。你必须执行此步骤才能使以下podman container register runlabel $IMAGE步骤成功：

$ touch ./config.toml  # 重要:文件必须存在，即使是空的。

注册你的执行器。你可以重复此步骤来注册多个执行器。如果你想使用可能不同的标签或配置选项集并行运行多个 CI 任务，这非常有用。

$ podman container runlabel register $IMAGE

使用你选择的编辑器编辑 config.toml。这是可选的，但通常需要更改用于实际 CI 任务的容器镜像。默认情况下，镜像设置为：
registry.fedoraproject.org/fedora:latest。

$ $EDITOR ./config.toml  # if desired

最后，配置对卷的访问。容器卷内使用多个用户，因此你必须专门配置它们以允许访问。再次使用 runlabel来完成：

$ podman container runlabel setupstorage $IMAGE

$ podman container runlabel setupcache $IMAGE

测试执行器

是时候检查配置了。首先启动 GitLab 执行器容器：

$ podman container runlabel run $IMAGE

允许执行器用户在注销后运行服务：

$ sudo loginctl enable-linger $(id -u)

验证你的新执行器在 GitLab 项目的 设置Settings -> CI/CD -> 执行器Runners 中可见：

最后，验证你的 CI 流水线正在使用你的执行器：

总结

使用 Podman 启动 GitLab 执行器有多种方法，我在此处概述了其中两种。尝试一下，然后让我知道哪一个最适合你。如果 Docker 执行环境方法有任何问题，请登录并通过 Podman 上游或GitLab 支持提交问题。如果 pipglr 方法出现问题，请在 pipglr 上游提交问题。

GitLab 与 Podman 一起运行愉快