Skip to content
Snippets Groups Projects
Unverified Commit 6a4ed618 authored by Rémy Coutable's avatar Rémy Coutable
Browse files

Document the `coordinator` and make the FAQ list unordered


Signed-off-by: default avatarRémy Coutable <remy@rymai.me>
parent 27f1d1e5
No related branches found
No related tags found
No related merge requests found
...@@ -2,12 +2,19 @@ ...@@ -2,12 +2,19 @@
Some Frequently Asked Questions about GitLab Runner. Some Frequently Asked Questions about GitLab Runner.
## 1. Where are logs stored when run as a service? ## What does `coordinator` mean?
The `coordinator` is the GitLab installation from which a job is requested.
In other words, runners are isolated (virtual) machines that pick up jobs
requested by their `coordinator`.
## Where are logs stored when run as a service?
+ If the GitLab Runner is run as service on Linux/OSX the daemon logs to syslog. + If the GitLab Runner is run as service on Linux/OSX the daemon logs to syslog.
+ If the GitLab Runner is run as service on Windows it logs to System's Event Log. + If the GitLab Runner is run as service on Windows it logs to System's Event Log.
## 2. Run in `--debug` mode ## Run in `--debug` mode
Is it possible to run GitLab Runner in debug/verbose mode. From a terminal, do: Is it possible to run GitLab Runner in debug/verbose mode. From a terminal, do:
...@@ -15,7 +22,7 @@ Is it possible to run GitLab Runner in debug/verbose mode. From a terminal, do: ...@@ -15,7 +22,7 @@ Is it possible to run GitLab Runner in debug/verbose mode. From a terminal, do:
gitlab-runner --debug run gitlab-runner --debug run
``` ```
## 3. I get a PathTooLongException during my builds on Windows ## I get a PathTooLongException during my builds on Windows
This is caused by tools like `npm` which will sometimes generate directory structures This is caused by tools like `npm` which will sometimes generate directory structures
with paths more than 260 characters in length. There are two possible fixes you can with paths more than 260 characters in length. There are two possible fixes you can
...@@ -33,11 +40,11 @@ The [NTFSSecurity](https://ntfssecurity.codeplex.com/) PowerShell module provide ...@@ -33,11 +40,11 @@ The [NTFSSecurity](https://ntfssecurity.codeplex.com/) PowerShell module provide
a *Remove-Item2* method which supports long paths. The Gitlab CI Multi Runner will a *Remove-Item2* method which supports long paths. The Gitlab CI Multi Runner will
detect it if it is available and automatically make use of it. detect it if it is available and automatically make use of it.
## 4. I'm seeing `x509: certificate signed by unknown authority` ## I'm seeing `x509: certificate signed by unknown authority`
Please [See the self-signed certificates](../configuration/tls-self-signed.md) Please [See the self-signed certificates](../configuration/tls-self-signed.md)
## 5. I get `Permission Denied` when accessing the `/var/run/docker.sock` ## I get `Permission Denied` when accessing the `/var/run/docker.sock`
If you want to use Docker executor, If you want to use Docker executor,
and you are connecting to Docker Engine installed on server. and you are connecting to Docker Engine installed on server.
...@@ -45,7 +52,7 @@ You can see the `Permission Denied` error. ...@@ -45,7 +52,7 @@ You can see the `Permission Denied` error.
The most likely cause is that your system uses SELinux (enabled by default on CentOS, Fedora and RHEL). The most likely cause is that your system uses SELinux (enabled by default on CentOS, Fedora and RHEL).
Check your SELinux policy on your system for possible denials. Check your SELinux policy on your system for possible denials.
## 6. The Docker executor gets timeout when building Java project. ## The Docker executor gets timeout when building Java project.
This most likely happens, because of the broken AUFS storage driver: This most likely happens, because of the broken AUFS storage driver:
[Java process hangs on inside container](https://github.com/docker/docker/issues/18502). [Java process hangs on inside container](https://github.com/docker/docker/issues/18502).
...@@ -55,13 +62,13 @@ to either OverlayFS (faster) or DeviceMapper (slower). ...@@ -55,13 +62,13 @@ to either OverlayFS (faster) or DeviceMapper (slower).
Check this article about [configuring and running Docker](https://docs.docker.com/engine/articles/configuring/) Check this article about [configuring and running Docker](https://docs.docker.com/engine/articles/configuring/)
or this article about [control and configure with systemd](https://docs.docker.com/engine/articles/systemd/). or this article about [control and configure with systemd](https://docs.docker.com/engine/articles/systemd/).
## 7. I get 411 when uploading artifacts. ## I get 411 when uploading artifacts.
This happens due to fact that runner uses `Transfer-Encoding: chunked` which is broken on early version of Nginx (http://serverfault.com/questions/164220/is-there-a-way-to-avoid-nginx-411-content-length-required-errors). This happens due to fact that runner uses `Transfer-Encoding: chunked` which is broken on early version of Nginx (http://serverfault.com/questions/164220/is-there-a-way-to-avoid-nginx-411-content-length-required-errors).
Upgrade your Nginx to newer version. For more information see this issue: https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/issues/1031 Upgrade your Nginx to newer version. For more information see this issue: https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/issues/1031
## 8. I can't run Windows BASH scripts; I'm getting `The system cannot find the batch label specified - buildscript`. ## I can't run Windows BASH scripts; I'm getting `The system cannot find the batch label specified - buildscript`.
You need to prepend `call` to your batch file line in .gitlab-ci.yml so that it looks like `call C:\path\to\test.bat`. Here You need to prepend `call` to your batch file line in .gitlab-ci.yml so that it looks like `call C:\path\to\test.bat`. Here
is a more complete example: is a more complete example:
...@@ -73,7 +80,7 @@ before_script: ...@@ -73,7 +80,7 @@ before_script:
Additional info can be found under issue [#1025](https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/issues/1025). Additional info can be found under issue [#1025](https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/issues/1025).
## 9. My gitlab runner is on Windows. How can I get colored output on the web terminal? ## My gitlab runner is on Windows. How can I get colored output on the web terminal?
**Short answer:** **Short answer:**
...@@ -94,7 +101,7 @@ If your program is doing the above, then you need to disable that conversion for ...@@ -94,7 +101,7 @@ If your program is doing the above, then you need to disable that conversion for
See issue [#332](https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/issues/332) for more information. See issue [#332](https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/issues/332) for more information.
## 10. "warning: You appear to have cloned an empty repository." ## "warning: You appear to have cloned an empty repository."
When running `git clone` using HTTP(s) (with GitLab Runner or manually for When running `git clone` using HTTP(s) (with GitLab Runner or manually for
tests) and you see the following output: tests) and you see the following output:
...@@ -130,13 +137,13 @@ See [an example of a user issue][1105]. ...@@ -130,13 +137,13 @@ See [an example of a user issue][1105].
[recipes]: https://gitlab.com/gitlab-org/gitlab-recipes/tree/master/web-server [recipes]: https://gitlab.com/gitlab-org/gitlab-recipes/tree/master/web-server
[1105]: https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/issues/1105 [1105]: https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/issues/1105
## 11. `"launchctl" failed: exit status 112, Could not find domain for` ## `"launchctl" failed: exit status 112, Could not find domain for`
This message may occur when you try to install GitLab Runner on OSX. Make sure This message may occur when you try to install GitLab Runner on OSX. Make sure
that you manage GitLab Runner service from the GUI Terminal application, not that you manage GitLab Runner service from the GUI Terminal application, not
the SSH connection. the SSH connection.
## 12. `Failed to authorize rights (0x1) with status: -60007.` ## `Failed to authorize rights (0x1) with status: -60007.`
If your Runner is stuck on the above message when using OSX, there are two If your Runner is stuck on the above message when using OSX, there are two
causes to why this happens: causes to why this happens:
...@@ -173,7 +180,7 @@ causes to why this happens: ...@@ -173,7 +180,7 @@ causes to why this happens:
Then you can verify that `~/Library/LaunchAgents/gitlab-runner.plist` has Then you can verify that `~/Library/LaunchAgents/gitlab-runner.plist` has
`SessionCreate` set to `false`. `SessionCreate` set to `false`.
## 13. `The service did not start due to a logon failure` error when starting service on Windows ## `The service did not start due to a logon failure` error when starting service on Windows
When installing and starting the GitLab Runner service on Windows you can When installing and starting the GitLab Runner service on Windows you can
meet with such error: meet with such error:
...@@ -226,7 +233,7 @@ and the service should be started properly. ...@@ -226,7 +233,7 @@ and the service should be started properly.
[microsoft-ntrights-download]: https://www.microsoft.com/en-us/download/details.aspx?id=17657 [microsoft-ntrights-download]: https://www.microsoft.com/en-us/download/details.aspx?id=17657
[microsoft-ntrights-usage-on-win7]: https://technet.microsoft.com/en-us/library/dd548356(WS.10).aspx [microsoft-ntrights-usage-on-win7]: https://technet.microsoft.com/en-us/library/dd548356(WS.10).aspx
## 14. `zoneinfo.zip: no such file or directory` error when using `OffPeakTimezone` ## `zoneinfo.zip: no such file or directory` error when using `OffPeakTimezone`
In `v1.11.0` we made it possible to configure the timezone in which `OffPeakPeriods` In `v1.11.0` we made it possible to configure the timezone in which `OffPeakPeriods`
are described. This feature should work on most Unix systems out of the box. However on some are described. This feature should work on most Unix systems out of the box. However on some
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment