极狐GitLab Runner
Tier: 基础版,专业版,旗舰版
Offering: JihuLab.com,私有化部署
极狐GitLab Runner 是一个与极狐GitLab CI/CD 配合使用、在流水线中运行作业的应用程序。
当开发者将代码推送到极狐GitLab 时,他们可以在 .gitlab-ci.yml 文件中定义自动化任务。这些任务可能包括运行测试、构建应用程序或部署代码。极狐GitLab Runner 就是在计算基础设施上执行这些任务的应用程序。
作为管理员,您负责提供并管理这些 CI/CD 作业运行所在的基础设施。这包括安装极狐GitLab Runner 应用程序、对其进行配置,并确保它们具备足够的容量来处理您组织的 CI/CD 工作负载。
极狐GitLab Runner 的功能
极狐GitLab Runner 连接到您的极狐GitLab 实例并等待 CI/CD 作业。当流水线运行时,极狐GitLab 会将作业发送给可用的 runner。runner 执行该作业,并将结果报告回极狐GitLab。
极狐GitLab Runner 具有以下功能。
- 并发运行多个作业。
- 在多个服务器上使用多个令牌(甚至可以按项目使用)。
- 限制每个令牌的并发作业数。
- 作业可以在以下环境中运行:
- 本地。
- 使用 Docker 容器。
- 使用 Docker 容器并通过 SSH 执行作业。
- 使用 Docker 容器,并在不同云平台和虚拟化 hypervisor 上自动扩缩。
- 连接到远程 SSH 服务器。
- 使用 Go 编写,以单个二进制文件分发,无其他依赖要求。
- 支持 Bash、PowerShell Core 和 Windows PowerShell。
- 可在 GNU/Linux、macOS 和 Windows 上运行(几乎任何能运行 Docker 的地方都可以)。
- 允许自定义作业运行环境。
- 无需重启即可自动重新加载配置。
- 无缝设置,支持 Docker、Docker-SSH、Parallels 或 SSH 运行环境。
- 支持 Docker 容器缓存。
- 可作为服务无缝安装到 GNU/Linux、macOS 和 Windows。
- 内置 Prometheus 指标 HTTP 服务器。
- Referee 工作进程,用于监控 Prometheus 指标和其他作业特定数据并将其传递给极狐GitLab。
Runner 执行流程
此图展示了 runner 如何注册,以及作业如何被请求和处理。它还展示了哪些操作使用注册令牌和认证令牌以及作业令牌。
Rendering chart...
Runner 部署选项
极狐GitLab 托管的 runner
极狐GitLab 托管的 runner 由极狐GitLab 管理,可在 JihuLab.com 上使用。 您无需安装或维护这些 runner——极狐GitLab 将其作为服务提供。但是,您对执行环境的控制有限,无法自定义基础设施。
私有化部署的 runner
私有化部署的 runner 是您在自己的基础设施中安装、配置和管理的极狐GitLab Runner 实例。您可以在所有极狐GitLab 安装上安装并注册私有化部署的 runner。作为管理员,您通常使用私有化部署的 runner。
与由极狐GitLab 托管和管理的极狐GitLab 托管 runner 不同,您对私有化部署的 runner 拥有完全控制权。
极狐GitLab Runner 版本
出于兼容性考虑,极狐GitLab Runner 的 major.minor 版本 应与极狐GitLab 的主版本号和次版本号保持同步。较旧的 runner 仍可与较新的极狐GitLab 版本配合使用,反之亦然。但是,如果存在版本差异,某些功能可能不可用或无法正常工作。
次版本更新之间保证向后兼容。但是,有时极狐GitLab 的次版本更新会引入新功能,要求极狐GitLab Runner 处于相同的次版本。
如果您自行托管 runner,但将代码仓库托管在 JihuLab.com 上, 请将极狐GitLab Runner 更新到最新版本,因为 JihuLab.com 会 持续更新。
故障排除
了解如何排查常见问题。
术语表
- 极狐GitLab Runner:在目标计算平台上执行来自极狐GitLab 流水线的 CI/CD 作业的应用程序。
- Runner:极狐GitLab Runner 的一个已配置实例,可以执行作业。根据执行器的类型, 此机器可以是 Runner Manager 本地的(shell 或 docker 执行器),也可以是由自动扩缩器 创建的远程机器(docker-autoscaler 或 kubernetes)。
- Runner 配置:config.toml中的单个 [[runner]] 条目,在 UI 中显示为一个 runner。
- Runner Manager:读取 config.toml 文件并并发运行所有 runner 配置和作业执行的进程。
- 机器:runner 运行所在的虚拟机(VM)或 pod。 极狐GitLab Runner 会自动生成唯一的持久机器 ID,这样当多台机器使用相同的 runner 配置时, 作业可以分别路由,但 runner 配置会在 UI 中分组显示。
- 执行器:极狐GitLab Runner 用于执行作业的方法(Docker、Shell、Kubernetes 等)。
- 流水线:当代码推送到极狐GitLab 时自动运行的一组作业。
- 作业:流水线中的单个任务,例如运行测试或构建应用程序。
- Runner 令牌:允许 runner 向极狐GitLab 进行身份验证的唯一标识符。
- 标签:分配给 runner 的标签,用于确定它们可以执行哪些作业。
- 并发作业:runner 可以同时执行的作业数。
- 私有化部署的 runner:在您自己的基础设施上安装和管理的 runner。
- 极狐GitLab 托管的 runner:由极狐GitLab 提供和管理的 runner。
变更日志
查看 CHANGELOG 以了解最近的变更。
许可证
此代码在 MIT 许可证下分发。查看 LICENSE 文件。