Skip to content
Snippets Groups Projects
Unverified Commit 9306f59b authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files

Rearrange and fix markdown for autoscale docs

parent d3052a00
No related branches found
No related tags found
No related merge requests found
......@@ -92,8 +92,8 @@ There are a couple of available executors currently.
| `ssh` | run build remotely with SSH - this requires the presence of `[runners.ssh]` |
| `parallels` | run build using Parallels VM, but connect to it with SSH - this requires the presence of `[runners.parallels]` and `[runners.ssh]` |
| `virtualbox` | run build using VirtualBox VM, but connect to it with SSH - this requires the presence of `[runners.virtualbox]` and `[runners.ssh]` |
| `docker+machine` | like `docker`, but uses [auto-scaled docker machines](autoscale.md) - this requires the presence of `[runners.docker]` and `[runners.machine]` |
| `docker-ssh+machine` | like `docker-ssh`, but uses [auto-scaled docker machines](autoscale.md) - this requires the presence of `[runners.docker]` and `[runners.machine]` |
| `docker+machine` | like `docker`, but uses [auto-scaled Docker machines](autoscale.md) - this requires the presence of `[runners.docker]` and `[runners.machine]` |
| `docker-ssh+machine` | like `docker-ssh`, but uses [auto-scaled Docker machines](autoscale.md) - this requires the presence of `[runners.docker]` and `[runners.machine]` |
| `kubernetes` | run build using Kubernetes Pods - this requires the presence of `[runners.kubernetes]` |
## The SHELLS
......@@ -107,7 +107,7 @@ There are a couple of available shells that can be run on different platforms.
| `cmd` | generate Windows Batch script. All commands are executed in Batch context (default for Windows) |
| `powershell` | generate Windows PowerShell script. All commands are executed in PowerShell context |
## The [runners.docker] section
## The `[runners.docker]` section
This defines the Docker Container parameters.
......@@ -176,7 +176,7 @@ Example:
"net.ipv4.ip_forward" = "1"
```
### Volumes in the [runners.docker] section
### Volumes in the `[runners.docker]` section
You can find the complete guide of Docker volume usage
[here](https://docs.docker.com/userguide/dockervolumes/).
......@@ -300,7 +300,7 @@ which comes from your private docker registry. In that case set
allowed_images = ["my.registry.tld:5000/*:*"]
```
## The [runners.parallels] section
## The `[runners.parallels]` section
This defines the Parallels parameters.
......@@ -319,7 +319,7 @@ Example:
disable_snapshots = false
```
## The [runners.virtualbox] section
## The `[runners.virtualbox]` section
This defines the VirtualBox parameters. This executor relies on
`vboxmanage` as executable to control VirtualBox machines so you have to adjust
......@@ -341,7 +341,7 @@ Example:
disable_snapshots = false
```
## The [runners.ssh] section
## The `[runners.ssh]` section
This defines the SSH connection parameters.
......@@ -364,7 +364,7 @@ Example:
identity_file = ""
```
## The [runners.machine] section
## The `[runners.machine]` section
>**Note:**
Added in GitLab Runner v1.1.0.
......@@ -426,7 +426,7 @@ Like in the standard cron configuration file, the fields can contain single
values, ranges, lists and asterisks. A detailed description of the syntax
can be found [here][cronvendor].
## The [runners.cache] section
## The `[runners.cache]` section
>**Note:**
Added in GitLab Runner v1.1.0.
......@@ -467,7 +467,7 @@ Example:
> **Note:** If any of `ServerAddress`, `AccessKey` or `SecretKey` aren't specified then the S3 client will use the
> IAM instance profile available to the instance.
## The [runners.kubernetes] section
## The `[runners.kubernetes]` section
> **Note:**
> Added in GitLab Runner v1.6.0
......@@ -510,7 +510,7 @@ single script that deploys to multiple servers or you can create many scripts.
It depends on what you'd like to do.
[TOML]: https://github.com/toml-lang/toml
[Docker Engine]: https://www.docker.com/docker-engine
[Docker Engine]: https://docs.docker.com/engine/
[yaml-priv-reg]: https://docs.gitlab.com/ce/ci/yaml/README.html#image-and-services
[ci-build-permissions-model]: https://docs.gitlab.com/ce/user/project/new_ci_build_permissions_model.html
[secpull]: ../security/index.md#usage-of-private-docker-images-with-if-not-present-pull-policy
......
......@@ -43,6 +43,12 @@ installed. The Docker Machine driver plugin installation and configuration is
out of the scope of this documentation. For more details please read the
[Docker Machine documentation][docker-machine-docs].
## Supported cloud providers
The autoscale mechanism is based on [Docker Machine](https://docs.docker.com/machine/overview/).
All supported virtualization/cloud provider parameters, are available at the
[Docker Machine drivers documentation](https://docs.docker.com/machine/drivers/).
## Runner configuration
In this section we will describe only the significant parameters from the
......@@ -54,7 +60,7 @@ and [GitLab Runner - Advanced Configuration][runner-configuration].
| Parameter | Value | Description |
|--------------|---------|-------------|
| `concurrent` | integer | Limits how many jobs globally can be run concurrently. This is the most upper limit of number of jobs using _all_ defined runners, local and autoscale. Together with `limit` (from [`[[runners]]` section](#runners-options)) and `IdleCount` (from [`[runners.machine]` section](advanced-configuration.md#the-runnersmachine-section)) it affects the upper limit of created machines. |
| `concurrent` | integer | Limits how many jobs globally can be run concurrently. This is the most upper limit of number of jobs using _all_ defined runners, local and autoscale. Together with `limit` (from [`[[runners]]` section](#runners-options)) and `IdleCount` (from [`[runners.machine]` section][runners-machine]) it affects the upper limit of created machines. |
### `[[runners]]` options
......@@ -66,12 +72,12 @@ and [GitLab Runner - Advanced Configuration][runner-configuration].
### `[runners.machine]` options
Configuration parameters details can be found
in [GitLab Runner - Advanced Configuration - The runners.machine section](advanced-configuration.md#the-runnersmachine-section).
in [GitLab Runner - Advanced Configuration - The `[runners.machine]` section][runners-machine].
### `[runners.cache]` options
Configuration parameters details can be found
in [GitLab Runner - Advanced Configuration - The runners.cache section](advanced-configuration.md#the-runnerscache-section)
in [GitLab Runner - Advanced Configuration - The `[runners.cache]` section][runners-cache]
### Additional configuration information
......@@ -279,7 +285,7 @@ the `OffPeakPeriods` pattern is fulfilled then it switches back to
`IdleCount` and `IdleTime` settings.
More information about syntax of `OffPeakPeriods` patterns can be found
in [GitLab Runner - Advanced Configuration - The runners.machine section](advanced-configuration.md#the-runnersmachine-section).
in [GitLab Runner - Advanced Configuration - The `[runners.machine]` section][runners-machine].
## Distributed runners caching
......@@ -358,7 +364,7 @@ Read how to [install your own Docker registry server][registry-server].
## A complete example of `config.toml`
The `config.toml` below uses the `digitalocean` Docker Machine driver:
The `config.toml` below uses the [`digitalocean` Docker Machine driver](https://docs.docker.com/machine/drivers/digital-ocean/):
```bash
concurrent = 50 # All registered Runners can run up to 50 concurrent builds
......@@ -405,19 +411,14 @@ Note that the `MachineOptions` parameter contains options for the `digitalocean`
driver which is used by Docker Machine to spawn machines hosted on Digital Ocean,
and one option for Docker Machine itself (`engine-registry-mirror`).
## What are the supported cloud providers
The autoscale mechanism currently is based on Docker Machine. Advanced
configuration options, including virtualization/cloud provider parameters, are
available at the [Docker Machine documentation][docker-machine-driver].
[cache]: http://doc.gitlab.com/ce/ci/yaml/README.html#cache
[caching]: ../install/autoscaling.md#install-the-cache-server
[runner-installation]: ../install/autoscaling.md
[runner-configuration]: index.md
[docker-machine-docs]: https://docs.docker.com/machine/
[docker-machine-driver]: https://docs.docker.com/machine/drivers/
[docker-machine-installation]: https://docs.docker.com/machine/install-machine/
[runners-cache]: advanced-configuration.md#the-runnerscache-section
[runners-cache]: advanced-configuration.md#the-runners-cache-section
[runners-machine]: advanced-configuration.md#the-runners-machine-section
[registry]: https://docs.docker.com/docker-trusted-registry/overview/
[caching]: ../install/autoscaling.md#install-the-cache-server
[registry-server]: ../install/autoscaling.md#install-docker-registry
......@@ -89,7 +89,7 @@ more in [Distributed runners caching][caching].
## Configure GitLab Runner
1. Register a GitLab Runner, selecting the `docker+machine` executor (Look into [runners documentation](http://doc.gitlab.com/ce/ci/runners/README.html) to learn how to obtain a token):
1. Register a GitLab Runner, selecting the `docker+machine` executor ([learn how to obtain a token](https://docs.gitlab.com/ee/ci/runners/)):
```bash
sudo gitlab-runner register
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment