Commit dc226fa2 authored by Steve Azzopardi's avatar Steve Azzopardi

Merge branch 'docs/fix-lists-surrounded-by-new-lines' into 'master'

Add new lines around lists for renderer

See merge request gitlab-org/gitlab-runner!1278
parents f9d0d7ab c32b4c5b
......@@ -149,17 +149,19 @@ on these kinds of environment variables.
## Proxy settings when using dind service
When using the [docker-in-docker executor](https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#use-docker-in-docker-executor) (dind),
it can be necessary to specify `docker:2375,docker:2376` in the `NO_PROXY`
When using the [docker-in-docker executor](https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#use-docker-in-docker-executor) (dind),
it can be necessary to specify `docker:2375,docker:2376` in the `NO_PROXY`
environment variable. This is because the proxy intercepts the TCP connection between:
- `dockerd` from the dind container.
- `docker` from the client container.
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/),
`dockerd` from dind is initially started as a client on the host system by root,
(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`.
For example:
......@@ -182,9 +184,9 @@ 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`,
will look for the proxy settings in `$HOME/.docker/config.json`,
which is now inside the executor container (and initally empty).
Therefore, `docker run` or `docker build` executions will have no proxy settings. In order to pass on the settings,
a `$HOME/.docker/config.json` needs to be created in the executor container. For example:
......@@ -196,7 +198,7 @@ before_script:
```
Because it is confusing to add additional lines in a `.gitlab-ci.yml` file that are only needed in case of a proxy,
it is better to move the creation of the `$HOME/.docker/config.json` into the
it is better to move the creation of the `$HOME/.docker/config.json` into the
configuration of the `gitlab-runner` (`/etc/gitlab-runner/config.toml`) that is actually affected:
```toml
......@@ -210,8 +212,8 @@ JSON file with a shell specified as a single string inside a TOML file.
Because it is not YAML anymore, do not escape the `:`.
Note that if the `NO_PROXY` list needs to be extended, wildcards `*` only work for suffixes
but not for prefixes or CIDR notation.
For more information, see
<https://github.com/moby/moby/issues/9145>
and
but not for prefixes or CIDR notation.
For more information, see
<https://github.com/moby/moby/issues/9145>
and
<https://unix.stackexchange.com/questions/23452/set-a-network-range-in-the-no-proxy-environment-variable>.
......@@ -126,6 +126,7 @@ systems. If a binary is not installed tests requiring this binary will be
skipped.
These are the binaries that you can install:
1. [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and [Vagrant](https://www.vagrantup.com/downloads.html)
1. [kubectl](https://kubernetes.io/docs/user-guide/prereqs/) with
[Minikube](https://github.com/kubernetes/minikube)
......@@ -167,6 +168,7 @@ This error happens due to missing executors/docker/bindata.go file that is gener
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
......
......@@ -154,7 +154,7 @@ variables:
```
NOTE: **Note:**
You must specify [`pod_annotations_overwrite_allowed`](#the-keywords) to override pod annotations via the `.gitlab-ci.yml` file.
You must specify [`pod_annotations_overwrite_allowed`](#the-keywords) to override pod annotations via the `.gitlab-ci.yml` file.
## Define keywords in the config toml
......@@ -374,11 +374,13 @@ This will disallow other pods from scheduling on the same nodes as the
build pods without extra configuration for the other pods.
### Using kaniko
Another approach for building Docker images inside a Kubernetes cluster is using [kaniko](https://github.com/GoogleContainerTools/kaniko).
kaniko:
- Allows you to build images without privileged access.
- Works without the Docker daemon.
For more information, see [Building images with kaniko and GitLab CI/CD](https://docs.gitlab.com/ee/ci/docker/using_kaniko.html).
[k8s-host-path-volume-docs]: https://kubernetes.io/docs/concepts/storage/volumes/#hostpath
......
......@@ -34,7 +34,7 @@ the `[[runners]]` section in
1. If Windows VM, see [Checklist for Windows VMs](#checklist-for-windows-vms)
1. Install the OpenSSH server
1. Install all other dependencies required by your build
1. If you want to upload job artifacts, install `gitlab-runner` inside the VM
1. If you want to upload job artifacts, install `gitlab-runner` inside the VM
1. Log out and shutdown the virtual machine
It's completely fine to use automation tools like Vagrant to provision the
......@@ -66,6 +66,7 @@ When a new build is started:
1. The Runner stops or shutdowns the virtual machine
## Checklist for Windows VMs
* Install [Cygwin]
* Install sshd and git from Cygwin (do not use *Git For Windows*, you will get lots of path issues!)
* Install Git LFS
......
......@@ -181,11 +181,9 @@ Some distributions (CentOS, RedHat, Fedora) use SELinux by default to enhance th
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.
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.
1. Make sure that persistent directory is created on host: `mkdir -p /srv/gitlab-runner/config`.
1. Run docker with `:Z` on volumes:
```bash
......
......@@ -5,9 +5,10 @@ last_updated: 2017-10-09
# Install GitLab Runner on Windows
To install and run GitLab Runner on Windows you need:
* Git installed
* A password for your user account, if you want to run it under your user
account rather than the Built-in System Account
- Git installed.
- A password for your user account, if you want to run it under your user
account rather than the Built-in System Account.
## Installation
......
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