Commit b59db2bd authored by Steve Azzopardi's avatar Steve Azzopardi

Merge branch 'docs/add-no-bare-url-mdl-rule' into 'master'

Disallow bare URLs from project

See merge request !1425
parents a35c654a 9a700846
......@@ -291,8 +291,8 @@ docs lint:
- cd /tmp/gitlab-docs
# Lint Markdown
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
- bundle exec mdl content/runner/**/*.md --rules \
MD032
- bundle exec mdl content/$DOCS_GITLAB_REPO_SUFFIX/**/*.md --rules \
MD032,MD034
# Build HTML from Markdown
- bundle exec nanoc
# Check the internal links
......
......@@ -160,7 +160,7 @@ The ports can be required because otherwise `docker push` will be blocked
as it originates from the IP mapped to docker. However, in that case, it is meant to go through the proxy.
When testing the communication between `dockerd` from dind and a `docker` client locally
(as described here: https://hub.docker.com/_/docker/),
(as described here: <https://hub.docker.com/_/docker/>),
`dockerd` from dind is initially started as a client on the host system by root,
and the proxy variables are taken from `/root/.docker/config.json`.
......@@ -184,7 +184,8 @@ These are available as environment variables as is (in contrast to `.docker/conf
in the dind containers running `dockerd` as a service and `docker` client executing `.gitlab-ci.yml`.
In `.gitlab-ci.yml`, the environment variables will be picked up by any program honouring the proxy settings from default environment variables. For example,
`wget`, `apt`, `apk`, `docker info` and `docker pull` (but not by `docker run` or `docker build` as per:
https://github.com/moby/moby/issues/24697#issuecomment-366680499).
<https://github.com/moby/moby/issues/24697#issuecomment-366680499>).
`docker run` or `docker build` executed inside the container of the docker executor
will look for the proxy settings in `$HOME/.docker/config.json`,
which is now inside the executor container (and initially empty).
......
......@@ -383,9 +383,9 @@ be sure to check on the current pricing based on the region you picked.
To learn more about Amazon EC2 Spot instances, visit the following links:
- https://aws.amazon.com/ec2/spot/
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html
- https://aws.amazon.com/blogs/aws/focusing-on-spot-instances-lets-talk-about-best-practices/
- <https://aws.amazon.com/ec2/spot/>
- <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html>
- <https://aws.amazon.com/blogs/aws/focusing-on-spot-instances-lets-talk-about-best-practices/>
### Caveats of Spot instances
......
......@@ -3,6 +3,7 @@
## 1. Install dependencies and Go runtime
### For Debian/Ubuntu
```bash
apt-get install -y mercurial git-core wget make
wget https://storage.googleapis.com/golang/go1.8.7.linux-amd64.tar.gz
......@@ -10,23 +11,27 @@ sudo tar -C /usr/local -xzf go*-*.tar.gz
```
### For OSX using binary package
```bash
wget https://storage.googleapis.com/golang/go1.8.7.darwin-amd64.tar.gz
sudo tar -C /usr/local -xzf go*-*.tar.gz
```
### For OSX if you have brew.sh
```
brew install go
```
### For OSX using installation package
```
wget https://storage.googleapis.com/golang/go1.8.7.darwin-amd64.pkg
open go*-*.pkg
```
### For FreeBSD
```
pkg install go-1.8.7 gmake git mercurial
```
......@@ -38,15 +43,15 @@ The Docker Engine is required to create pre-built image that is embedded into ru
Make sure that on machine that is running your Docker Engine you have a `binfmt_misc`.
This is required to be able to build ARM images that are embedded into GitLab Runner binary.
* For Debian/Ubuntu it's sufficient to execute:
- For Debian/Ubuntu it's sufficient to execute:
```
apt-get install binfmt-support qemu-user-static
```
* For Docker for MacOS/Windows `binfmt_misc` is enabled by default.
- For Docker for MacOS/Windows `binfmt_misc` is enabled by default.
* For CoreOS (but also works on Debian and Ubuntu) you need to execute the following script on system start:
- For CoreOS (but also works on Debian and Ubuntu) you need to execute the following script on system start:
```
#!/bin/sh
......@@ -184,7 +189,7 @@ Which virtual machine to use depends on your use case:
Running `vagrant up windows_10` will start the Windows 10 machine for
you. To:
- ssh inside of the Windows 10 machine, run `vagrant ssh windows_10`.
- ssh inside of the Windows 10 machine, run `vagrant ssh windows_10`.
- Access the GUI for the Windows 10, you can connect via
RDP by running `vagrant rdp windows_10`, which will connect to the
machine using a locally installed RDP program.
......@@ -208,6 +213,6 @@ Which is especially tricky on Windows.
Try to execute: `make deps docker`, if it doesn't help you can do that in steps:
1. Execute `go get -u github.com/jteeuwen/go-bindata/...`
2. Download https://gitlab-runner-downloads.s3.amazonaws.com/master/docker/prebuilt-x86_64.tar.xz and save to out/docker/prebuilt-x86_64.tar.xz
3. Download https://gitlab-runner-downloads.s3.amazonaws.com/master/docker/prebuilt-arm.tar.xz and save to out/docker/prebuilt-arm.tar.xz
4. Execute `make docker` or check the Makefile how this command looks like
1. Download <https://gitlab-runner-downloads.s3.amazonaws.com/master/docker/prebuilt-x86_64.tar.xz and save to out/docker/prebuilt-x86_64.tar.xz>
1. Download <https://gitlab-runner-downloads.s3.amazonaws.com/master/docker/prebuilt-arm.tar.xz and save to out/docker/prebuilt-arm.tar.xz>
1. Execute `make docker` or check the Makefile how this command looks like
......@@ -37,7 +37,7 @@ To open the report:
1. Find the Pipeline related to the change that we want to review. It may be the latest Pipeline for the
Merge Requests or a Pipeline for the tag. For example, we can look at this one:
https://gitlab.com/gitlab-org/gitlab-runner/pipelines/48686952, which released the `v11.8.0` version of Runner.
<https://gitlab.com/gitlab-org/gitlab-runner/pipelines/48686952>, which released the `v11.8.0` version of Runner.
1. In the pipeline, find the `stable S3` (for tagged releases), `bleeding edge S3` (for `master` and RC tagged releases),
or `development S3` (for regular commits) job which should be present at the `release` stage. In our example
......
......@@ -64,9 +64,9 @@ or this article about [control and configure with systemd](https://docs.docker.c
## 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-runner/issues/1031
Upgrade your Nginx to newer version. For more information see this issue: <https://gitlab.com/gitlab-org/gitlab-runner/issues/1031>
## I can't run Windows BASH scripts; I'm getting `The system cannot find the batch label specified - buildscript`.
......@@ -161,7 +161,7 @@ causes to why this happens:
---
2. Make sure that your Runner service doesn't use `SessionCreate = true`.
1. Make sure that your Runner service doesn't use `SessionCreate = true`.
Previously, when running GitLab Runner as a service, we were creating
`LaunchAgents` with `SessionCreate`. At that point (**Mavericks**), this was
the only solution to make Code Signing work. That changed recently with
......
......@@ -182,7 +182,7 @@ The special care must be taken when dealing with such configuration.
1. If you want to use Docker executor to run builds in containers you need to access the `/var/run/docker.sock`.
However, if you have a SELinux in enforcing mode, you will see the `Permission denied` when accessing the `/var/run/docker.sock`.
Install the `selinux-dockersock` and to resolve the issue: https://github.com/dpw/selinux-dockersock.
Install the `selinux-dockersock` and to resolve the issue: <https://github.com/dpw/selinux-dockersock>.
1. Make sure that persistent directory is created on host: `mkdir -p /srv/gitlab-runner/config`.
1. Run docker with `:Z` on volumes:
......@@ -194,4 +194,4 @@ docker run -d --name gitlab-runner --restart always \
```
More information about the cause and resolution can be found here:
http://www.projectatomic.io/blog/2015/06/using-volumes-with-docker-can-cause-problems-with-selinux/
<http://www.projectatomic.io/blog/2015/06/using-volumes-with-docker-can-cause-problems-with-selinux/>
......@@ -28,4 +28,4 @@ curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-ci-multi-
## Downloading the binaries manually
For manual installations, the old GitLab Runner binaries can be found under
https://gitlab-ci-multi-runner-downloads.s3.amazonaws.com/latest/index.html.
<https://gitlab-ci-multi-runner-downloads.s3.amazonaws.com/latest/index.html>.
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