From 1a9ae286fab605f897f26644d76ef60d03be17e3 Mon Sep 17 00:00:00 2001 From: Dylan Griffith Date: Mon, 19 Mar 2018 11:16:18 +1100 Subject: Add documentation for runner IP address (#44232) --- .../44232-docs-for-runner-ip-address.yml | 5 ++++ doc/ci/runners/README.md | 33 +++++++++++++++++++++ doc/ci/runners/img/shared_runner_ip_address.png | Bin 0 -> 69821 bytes doc/ci/runners/img/specific_runner_ip_address.png | Bin 0 -> 42055 bytes 4 files changed, 38 insertions(+) create mode 100644 changelogs/unreleased/44232-docs-for-runner-ip-address.yml create mode 100644 doc/ci/runners/img/shared_runner_ip_address.png create mode 100644 doc/ci/runners/img/specific_runner_ip_address.png diff --git a/changelogs/unreleased/44232-docs-for-runner-ip-address.yml b/changelogs/unreleased/44232-docs-for-runner-ip-address.yml new file mode 100644 index 00000000000..82485d31b24 --- /dev/null +++ b/changelogs/unreleased/44232-docs-for-runner-ip-address.yml @@ -0,0 +1,5 @@ +--- +title: Add documentation for runner IP address (#44232) +merge_request: 17837 +author: +type: other diff --git a/doc/ci/runners/README.md b/doc/ci/runners/README.md index f879ed62010..9f2538b9c9f 100644 --- a/doc/ci/runners/README.md +++ b/doc/ci/runners/README.md @@ -280,3 +280,36 @@ We're always looking for contributions that can mitigate these [register]: http://docs.gitlab.com/runner/register/ [protected branches]: ../../user/project/protected_branches.md [protected tags]: ../../user/project/protected_tags.md + +## Determining the IP address of a Runner + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17286) in GitLab 10.6. + +It may be useful to know the IP address of a Runner so you can troubleshoot +issues with that Runner. GitLab stores and displays the IP address by viewing +the source of the HTTP requests it makes to GitLab when polling for jobs. The +IP address is always kept up to date so if the Runner IP changes it will be +automatically updated in GitLab. + +The IP address for shared Runners and specific Runners can be found in +different places. + +### Shared Runners + +To view the IP address of a shared Runner you must have admin access to +the GitLab instance. To determine this: + +1. Visit **Admin area ➔ Overview ➔ Runners** +1. Look for the Runner in the table and you should see a column for "IP Address" + +![shared Runner IP address](img/shared_runner_ip_address.png) + +### Specific Runners + +You can find the IP address of a Runner for a specific project by: + +1. Visit your project's **Settings ➔ CI/CD** +1. Find the Runner and click on it's ID which links you to the details page +1. On the details page you should see a row for "IP Address" + +![specific Runner IP address](img/specific_runner_ip_address.png) diff --git a/doc/ci/runners/img/shared_runner_ip_address.png b/doc/ci/runners/img/shared_runner_ip_address.png new file mode 100644 index 00000000000..3b1542d59d3 Binary files /dev/null and b/doc/ci/runners/img/shared_runner_ip_address.png differ diff --git a/doc/ci/runners/img/specific_runner_ip_address.png b/doc/ci/runners/img/specific_runner_ip_address.png new file mode 100644 index 00000000000..3b4c3e9f2eb Binary files /dev/null and b/doc/ci/runners/img/specific_runner_ip_address.png differ -- cgit v1.2.1