summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDylan Griffith <dyl.griffith@gmail.com>2018-05-08 10:53:26 +0200
committerDylan Griffith <dyl.griffith@gmail.com>2018-05-08 11:24:09 +0200
commitaf503c8d106806814619821cd3521c0476b61f1d (patch)
treea46c5762df78234c0dcd126a4365a34ec3e27af9
parente4a0499614b2aa6746e149c0e12ccd6e7af2ff63 (diff)
downloadgitlab-ce-af503c8d106806814619821cd3521c0476b61f1d.tar.gz
Add simple docs for group runners
-rw-r--r--doc/ci/runners/README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/ci/runners/README.md b/doc/ci/runners/README.md
index 5aa80af8e0d..ec1b6fa1dcb 100644
--- a/doc/ci/runners/README.md
+++ b/doc/ci/runners/README.md
@@ -11,7 +11,7 @@ Ideally, the GitLab Runner should not be installed on the same machine as GitLab
Read the [requirements documentation](../../install/requirements.md#gitlab-runner)
for more information.
-## Shared vs specific Runners
+## Shared, specific and group Runners
After [installing the Runner][install], you can either register it as shared or
specific. You can only register a shared Runner if you have admin access to
@@ -32,6 +32,9 @@ are:
Runners. For example, if you want to deploy a certain project, you can setup
a specific Runner to have the right credentials for this. The [usage of tags](#using-tags)
may be useful in this case. Specific Runners process jobs using a [FIFO] queue.
+- **Group Runners** are useful when you have multiple projects under one group
+ and would like all projects to have access to a set of runners. Group Runners
+ process jobs using a [FIFO] queue.
A Runner that is specific only runs for the specified project(s). A shared Runner
can run jobs for every project that has enabled the option **Allow shared Runners**
@@ -79,6 +82,14 @@ visit the project you want to make the Runner work for in GitLab:
1. Go to **Settings > CI/CD** to obtain the token
1. [Register the Runner][register]
+## Registering a group Runner
+
+Creating a group Runner requires Master permissions for the group. To create a
+group Runner visit the group you want to make the Runner work for in GitLab:
+
+1. Go to **Settings > CI/CD** to obtain the token
+1. [Register the Runner][register]
+
### Making an existing shared Runner specific
If you are an admin on your GitLab instance, you can turn any shared Runner into