Commit f5cf7000 authored by Aric Buerer's avatar Aric Buerer Committed by Achilleas Pipinellis

Updating runner docs to add specific runner to projects from the admin area-doc

parent 7b047094
...@@ -35,7 +35,7 @@ are: ...@@ -35,7 +35,7 @@ are:
A Runner that is specific only runs for the specified project(s). A shared Runner 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** can run jobs for every project that has enabled the option **Allow shared Runners**
under **Settings CI/CD**. under **Settings > CI/CD**.
Projects with high demand of CI activity can also benefit from using specific Projects with high demand of CI activity can also benefit from using specific
Runners. By having dedicated Runners you are guaranteed that the Runner is not Runners. By having dedicated Runners you are guaranteed that the Runner is not
...@@ -76,7 +76,7 @@ Registering a specific can be done in two ways: ...@@ -76,7 +76,7 @@ Registering a specific can be done in two ways:
To create a specific Runner without having admin rights to the GitLab instance, 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: visit the project you want to make the Runner work for in GitLab:
1. Go to **Settings CI/CD** to obtain the token 1. Go to **Settings > CI/CD** to obtain the token
1. [Register the Runner][register] 1. [Register the Runner][register]
### Making an existing shared Runner specific ### Making an existing shared Runner specific
...@@ -85,7 +85,7 @@ If you are an admin on your GitLab instance, you can turn any shared Runner into ...@@ -85,7 +85,7 @@ If you are an admin on your GitLab instance, you can turn any shared Runner into
a specific one, but not the other way around. Keep in mind that this is a one a specific one, but not the other way around. Keep in mind that this is a one
way transition. way transition.
1. Go to the Runners in the admin area **Overview Runners** (`/admin/runners`) 1. Go to the Runners in the admin area **Overview > Runners** (`/admin/runners`)
and find your Runner and find your Runner
1. Enable any projects under **Restrict projects for this Runner** to be used 1. Enable any projects under **Restrict projects for this Runner** to be used
with the Runner with the Runner
...@@ -101,7 +101,7 @@ can be changed afterwards under each Runner's settings. ...@@ -101,7 +101,7 @@ can be changed afterwards under each Runner's settings.
To lock/unlock a Runner: To lock/unlock a Runner:
1. Visit your project's **Settings CI/CD** 1. Visit your project's **Settings > CI/CD**
1. Find the Runner you wish to lock/unlock and make sure it's enabled 1. Find the Runner you wish to lock/unlock and make sure it's enabled
1. Click the pencil button 1. Click the pencil button
1. Check the **Lock to current projects** option 1. Check the **Lock to current projects** option
...@@ -115,7 +115,7 @@ you can enable the Runner also on any other project where you have Master permis ...@@ -115,7 +115,7 @@ you can enable the Runner also on any other project where you have Master permis
To enable/disable a Runner in your project: To enable/disable a Runner in your project:
1. Visit your project's **Settings CI/CD** 1. Visit your project's **Settings > CI/CD**
1. Find the Runner you wish to enable/disable 1. Find the Runner you wish to enable/disable
1. Click **Enable for this project** or **Disable for this project** 1. Click **Enable for this project** or **Disable for this project**
...@@ -124,6 +124,13 @@ Consider that if you don't lock your specific Runner to a specific project, any ...@@ -124,6 +124,13 @@ Consider that if you don't lock your specific Runner to a specific project, any
user with Master role in you project can assign your runner to another arbitrary user with Master role in you project can assign your runner to another arbitrary
project without requiring your authorization, so use it with caution. project without requiring your authorization, so use it with caution.
An admin can enable/disable a specific Runner for projects:
1. Navigate to **Admin > Runners**
2. Find the Runner you wish to enable/disable
3. Click edit on the Runner
4. Click **Enable** or **Disable** on the project
## Protected Runners ## Protected Runners
> >
...@@ -136,7 +143,7 @@ Whenever a Runner is protected, the Runner picks only jobs created on ...@@ -136,7 +143,7 @@ Whenever a Runner is protected, the Runner picks only jobs created on
To protect/unprotect Runners: To protect/unprotect Runners:
1. Visit your project's **Settings CI/CD** 1. Visit your project's **Settings > CI/CD**
1. Find a Runner you want to protect/unprotect and make sure it's enabled 1. Find a Runner you want to protect/unprotect and make sure it's enabled
1. Click the pencil button besides the Runner name 1. Click the pencil button besides the Runner name
1. Check the **Protected** option 1. Check the **Protected** option
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment