summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShinya Maeda <shinya@gitlab.com>2017-08-24 01:07:35 +0900
committerShinya Maeda <shinya@gitlab.com>2017-09-03 23:49:10 +0900
commitaf112c55e54874a37e780de6723c64e9be61b6e8 (patch)
tree2a3cf5472de6f0e101e7ff31efecc4132123fc48
parent665774b4775f9e7ae3adfccf1c36bf9867fa53a5 (diff)
downloadgitlab-ce-af112c55e54874a37e780de6723c64e9be61b6e8.tar.gz
Add doc
-rw-r--r--doc/ci/runners/README.md19
-rw-r--r--doc/ci/runners/img/protected_runners_check_box.pngbin0 -> 8584 bytes
-rw-r--r--doc/ci/runners/img/specific_runners_edit_icon.pngbin0 -> 1414 bytes
3 files changed, 19 insertions, 0 deletions
diff --git a/doc/ci/runners/README.md b/doc/ci/runners/README.md
index 76d746155eb..e5750ee6896 100644
--- a/doc/ci/runners/README.md
+++ b/doc/ci/runners/README.md
@@ -107,6 +107,23 @@ To lock/unlock a Runner:
1. Check the **Lock to current projects** option
1. Click **Save changes** for the changes to take effect
+## Protected runners
+
+>**Notes:**
+This feature requires GitLab 10.0 or higher.
+
+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 ignore other jobs.
+
+To protect/unprotect runners:
+
+1. Visit your project's **Settings ➔ Pipelines**
+1. Find a runner you want to protect/unprotect and make sure it's enabled
+1. Click a pencil button ![specific runners edit icon](img/specific_runners_edit_icon.png) resides runner name
+1. Check the **Protected** option
+1. Click **Save changes** for the changes to take effect
+
## How shared Runners pick jobs
Shared Runners abide to a process queue we call fair usage. The fair usage
@@ -218,3 +235,5 @@ We're always looking for contributions that can mitigate these
[install]: http://docs.gitlab.com/runner/install/
[fifo]: https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)
[register]: http://docs.gitlab.com/runner/register/
+[protected branches]: ../../user/project/protected_branches.md
+[protected tags]: ../../user/project/protected_tags.md
diff --git a/doc/ci/runners/img/protected_runners_check_box.png b/doc/ci/runners/img/protected_runners_check_box.png
new file mode 100644
index 00000000000..fb58498c7ce
--- /dev/null
+++ b/doc/ci/runners/img/protected_runners_check_box.png
Binary files differ
diff --git a/doc/ci/runners/img/specific_runners_edit_icon.png b/doc/ci/runners/img/specific_runners_edit_icon.png
new file mode 100644
index 00000000000..e83cf6e3858
--- /dev/null
+++ b/doc/ci/runners/img/specific_runners_edit_icon.png
Binary files differ