diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-30 06:07:59 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-30 06:07:59 +0000 |
commit | 7421e6f9f2b5889b05738af7eba568af6ae3fcbc (patch) | |
tree | 0c7f9656565ae4ef09611345248ea518c4deb5b8 /doc/ci/runners/README.md | |
parent | bf32dbaad2b059a3bf3e880c08cb0a026effc158 (diff) | |
download | gitlab-ce-7421e6f9f2b5889b05738af7eba568af6ae3fcbc.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/ci/runners/README.md')
-rw-r--r-- | doc/ci/runners/README.md | 27 |
1 files changed, 10 insertions, 17 deletions
diff --git a/doc/ci/runners/README.md b/doc/ci/runners/README.md index 3b9e30e2b96..deefd2f0e73 100644 --- a/doc/ci/runners/README.md +++ b/doc/ci/runners/README.md @@ -17,7 +17,7 @@ for more information. ## Shared, specific and group Runners -After [installing the Runner][install], you can either register it as shared or +After [installing the Runner](https://docs.gitlab.com/runner/install/), you can either register it as shared or specific. You can only register a shared Runner if you have admin access to the GitLab instance. The main differences between a shared and a specific Runner are: @@ -35,10 +35,10 @@ are: up the specific Runner with this in mind, while not having to do this for all Runners. For example, if you want to deploy a certain project, you can set up 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. + may be useful in this case. Specific Runners process jobs using a [FIFO](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)) 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. + process jobs using a [FIFO](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)) 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** @@ -64,7 +64,7 @@ You can only register a shared Runner if you are an admin of the GitLab instance ![Shared Runners Admin Area](img/shared_runners_admin.png) -1. [Register the Runner][register] +1. [Register the Runner](https://docs.gitlab.com/runner/register/) Shared Runners are enabled by default as of GitLab 8.2, but can be disabled with the **Disable shared Runners** button which is present under each project's @@ -84,7 +84,7 @@ To create a specific Runner without having admin rights to the GitLab instance, 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] +1. [Register the Runner](https://docs.gitlab.com/runner/register/) ## Registering a group Runner @@ -92,7 +92,7 @@ Creating a group Runner requires Owner 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] +1. [Register the Runner](https://docs.gitlab.com/runner/register/) ### Making an existing shared Runner specific @@ -111,7 +111,7 @@ From now on, the shared Runner will be specific to those projects. You can configure a Runner to assign it exclusively to a project. When a Runner is locked this way, it can no longer be enabled for other projects. -This setting can be enabled the first time you [register a Runner][register] and +This setting can be enabled the first time you [register a Runner](https://docs.gitlab.com/runner/register/) and can be changed afterwards under each Runner's settings. To lock/unlock a Runner: @@ -160,7 +160,7 @@ An admin can enable/disable a specific Runner for projects: You can protect Runners from revealing sensitive information. Whenever a Runner is protected, the Runner picks only jobs created on -[protected branches] or [protected tags], and ignores other jobs. +[protected branches](../../user/project/protected_branches.md) or [protected tags](../../user/project/protected_tags.md), and ignores other jobs. To protect/unprotect Runners: @@ -245,7 +245,7 @@ the appropriate dependencies to run Rails test suites. ### Allowing Runners with tags to pick jobs without tags -When you [register a Runner][register], its default behavior is to **only pick** +When you [register a Runner](https://docs.gitlab.com/runner/register/), its default behavior is to **only pick** [tagged jobs](../yaml/README.md#tags). NOTE: **Note:** @@ -305,7 +305,7 @@ Example 2: ### Setting maximum job timeout for a Runner For each Runner you can specify a _maximum job timeout_. Such timeout, -if smaller than [project defined timeout], will take the precedence. This +if smaller than [project defined timeout](../pipelines/settings.md#timeout), will take the precedence. This feature can be used to prevent Shared Runner from being appropriated by a project by setting a ridiculous big timeout (for example, one week). @@ -416,10 +416,3 @@ You can find the IP address of a Runner for a specific project by: 1. On the details page you should see a row for "IP Address" ![specific Runner IP address](img/specific_runner_ip_address.png) - -[install]: https://docs.gitlab.com/runner/install/ -[fifo]: https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics) -[register]: https://docs.gitlab.com/runner/register/ -[protected branches]: ../../user/project/protected_branches.md -[protected tags]: ../../user/project/protected_tags.md -[project defined timeout]: ../pipelines/settings.md#timeout |