GitLab 中文文档

GitLab Runner

GitLab Runner

Build Status

GitLab Runner 是一个开源项目, 它用来运行你定制的任务(jobs)并把结果返回给 GitLab。 GitLab Runner 配合GitLab CI(GitLab 内置的持续集成服务) 协调完成任务。

Requirements

GitLab Runner 是由 Go 语言开发的,可以作为一个独立的二进制程序运行, 所以它没有特定语言的环境需求。

Runner 可运行在 GNU/Linux, macOS 和 Windows 操作系统上。 如果是其他平台的操作系统,只要你编译一个 Go 的二进制程序, 也是可以运行的。

如果你想用 Docker 运行 Runer , 请确保 [Docker 的版本][dockerrepos]不低于 v1.5.0

Features

  • Allows to run:
    • 多个任务可并行运行
    • (每项目)可使用多服务器、多token
    • 限制 per-token (每个token) 并发任务的数量
  • Jobs can be run:
    • 本地运行
    • 使用 Docker 容器
    • 使用 Docker 容器并通过 SSH 执行任务
    • 在不同的云服务器和虚拟服务器上使用可自动自动伸缩的 Docker 容器
    • 连接到远程 SSH 服务器
  • Go 语言开发,以二进制文件的方式发布,对系统环境无特殊需求
  • 支持 Bash, Windows 批处理、PowerShell
  • 可运行在GNU/Linux,OS X 和 Windows 上,以及任何可运行 Docker 的环境中
  • 可自定义任务'运行时'环境
  • 配置文件自动重载
  • 易于在 Docker, Docker-SSH, Parallels 或 SSH '运行时'环境使用安装
  • 启用 Docker 容器缓存
  • 方便安装为 GNU/Linux, OSX 和 Windows 的系统服务
  • 嵌入 Prometheus 性能计算 HTTP服务

Compatibility chart 兼容性图示

Important: GitLab Runner >= 9.0 需要依赖 GitLab's API v4 ,API v4 是从 GitLab CE/EE 9.0 开始使用的。因此,GitLab Runner >= 9.0 需要 GitLab CE/EE >= 9.0 支持, 老版本的 GitLab 不支持 9.0 及以上版本的 Runner。 2017年8月开始的 GitLab 版本已经废弃 GitLab Runner 使用的旧 API 接口, v1.11.x 版本 Runner 结束生命周期。

从下面的表格可以看出 GitLab 和 GitLab Runner 之间的兼容性。

GitLab Runner / GitLab 9.x.y 10.x.y
v1.10.x
v1.11.x
v9.x.y
v10.x.y

Install GitLab Runner

GitLab Runner 可以在GNU/Linux, macOS, FreeBSD 和 Windows 上安装使用。 你可以用 Runner in Docker,或下载二进制文件, 或使用 GitLab 提供的 rpm/deb 仓库进行安装。 下面是官方推荐的安装方式:

Register GitLab Runner

GitLab Runner 安装完成后,需要把它注册到 GitLab。

了解如何 注册 GitLab Runner. [翻译进度 100%]

Using GitLab Runner

Selecting the executor

GitLab Runner 实现了许多可用于在不同场景中运行您的 build (构建)的 executors (执行器)。 如果您不确定要选择什么,请阅读 I am not sure部分。 通过 兼容性对比图示 , 查看每个 executors 支持的功能。

通过下面的列表查看每个 executor 的独立文档:

Advanced Configuration

Troubleshooting

查阅 FAQ 解决一些常见的问题。

Release process

GitLab Runner 详细发布进度请访问 release documentation

Contributing

欢迎大家参与 GitLab Runner 项目,查看 CONTRIBUTING.md 了解详细内容。

Development

See the development documentation to hack on GitLab Runner.

Changelog

访问 Changelog 查看变更记录。

License

项目代码使用 MIT 许可协议发布,查看 LICENSE 文件。


Last updated 2017-10-09