Help us learn about your current experience with the documentation. Take the survey.

开始使用 GitLab Runner

GitLab Runner 管理涵盖了管理您的 CI/CD 作业执行基础设施的完整生命周期:

  • 部署和注册 runner
  • 为特定工作负载配置 executor
  • 扩展容量以匹配组织增长

管理 runner 的过程是更大工作流程的一部分:

Workflow

您通过 scope 和 tag 管理 runner 访问,监控性能,并维护 runner 队列。

第 1 步:安装 runner

安装 GitLab Runner 以创建执行 CI/CD 作业的应用程序。

安装涉及在目标基础设施上下载和设置 GitLab Runner。安装过程因目标操作系统而异。GitLab 为 Linux、Windows、macOS 和 z/OS 提供了二进制文件和安装说明。根据您的平台和需求选择安装方法。

更多信息,请参阅 安装 GitLab Runner

第 2 步:注册 runner

注册您的 runner 以建立您的 GitLab 实例与安装 GitLab Runner 的机器之间的认证通信。注册使用认证令牌将单个 runner 连接到您的 GitLab 实例。注册期间,您指定 runner 的 scope、executor 类型和其他配置参数,这些参数决定了 runner 的运行方式。

在注册 runner 之前,您应该确定是否要将其限制到特定的 GitLab group 或 project。您可以在注册期间配置具有不同访问 scope 的 self-managed runner,以确定它们可用于哪些项目:

  • Instance runner:可用于您 GitLab 实例上的所有项目
  • Group runner:可用于特定 group 及其子 group 中的所有项目
  • Project runner:仅可用于特定项目

注册 runner 时,为其添加 tag 以将作业路由到适当的 runner。分配有意义的 tag 并在您的 .gitlab-ci.yml 文件中引用它们,以确保作业在具有所需能力的 runner 上运行。

当 CI/CD 作业运行时,它会通过查看分配的 tag 来知道使用哪个 runner。Tag 是筛选作业可用 runner 列表的唯一方式。

更多信息,请参阅:

第 3 步:选择 executor

GitLab Runner executor 是 GitLab Runner 可以用来执行 CI/CD 作业的不同环境和方法。它们决定了您的 pipeline 作业实际运行的方式和位置。正确的配置确保作业在适当的环境中运行,并具有正确的安全边界。

注册 runner 时,您必须选择一个 executor。GitLab Runner 使用 executor 系统来确定作业运行的位置和方式。executor 决定了每个作业运行的环境。选择与您的基础设施和作业需求匹配的 executor。

例如:

  • 如果您希望 CI/CD 作业运行 PowerShell 命令,您可以在 Windows 服务器上安装 GitLab Runner,然后注册一个使用 shell executor 的 runner。
  • 如果您希望 CI/CD 作业在自定义 Docker 容器中运行命令,您可以在 Linux 服务器上安装 GitLab Runner,然后注册一个使用 Docker executor 的 runner。

这些示例只是几种可能的配置。您可以在虚拟机上安装 GitLab Runner,并让它使用另一个虚拟机作为 executor。

更多信息,请参阅 executor

第 4 步:配置 runner 并开始运行作业

您可以通过编辑 config.toml 文件来配置 GitLab Runner,该文件在您安装和注册 runner 时会自动生成。在此文件中,您可以编辑特定 runner 或所有 runner 的设置。配置它以设置并发限制、日志级别、缓存设置、CPU 限制和 executor 特定参数。在您的 runner 队列中使用一致的配置。

在 runner 配置好并可用于您的项目后,您的 CI/CD 作业就可以使用该 runner。Runner 通常在您安装 GitLab Runner 的同一台机器上处理作业。但是,您也可以让 runner 在容器、Kubernetes 集群或云中的自动扩展实例中处理作业。

更多信息,请参阅:

第 5 步:继续配置、扩展和优化您的 runner

高级 runner 功能提高作业执行效率,并为复杂的 CI/CD 工作流程提供专门的功能。这些优化通过自动扩展、性能监控、队列管理和专门配置来减少作业运行时间并增强开发人员体验。

自动扩展根据作业需求自动调整 runner 容量,而性能优化确保高效的资源利用。这些功能帮助您处理可变工作负载,同时控制基础设施成本。队列管理为多个 runner 提供集中控制和监控,支持企业级 runner 部署。队列扩展涉及协调多个 runner 的容量并实施运营最佳实践。

使用内置的 Prometheus 指标来帮助您监控 runner 的健康和性能。您可以跟踪关键指标,如活动作业数、CPU 利用率、内存使用率、作业成功率和队列长度,以确保您的 runner 高效运行。

更多信息,请参阅: