using_docker_build.md 26 KB
Newer Older
Evan Read's avatar
Evan Read committed
1 2 3 4
---
type: concepts, howto
---

5
# Building Docker images with GitLab CI/CD
6

7
GitLab CI/CD allows you to use Docker Engine to build and test docker-based projects.
8

9
One of the new trends in Continuous Integration/Deployment is to:
10

Evan Read's avatar
Evan Read committed
11 12 13 14
1. Create an application image.
1. Run tests against the created image.
1. Push image to a remote registry.
1. Deploy to a server from the pushed image.
15

16 17
It's also useful when your application already has the `Dockerfile` that can be
used to create and test an image:
18

19
```bash
20
docker build -t my-image dockerfiles/
21
docker run my-image /script/to/run/tests
22 23
docker tag my-image my-registry:5000/my-image
docker push my-registry:5000/my-image
24 25
```

26 27
This requires special configuration of GitLab Runner to enable `docker` support
during jobs.
28

29 30
## Runner Configuration

Evan Read's avatar
Evan Read committed
31 32 33 34 35 36 37 38 39 40
There are three methods to enable the use of `docker build` and `docker run`
during jobs; each with their own tradeoffs.

An alternative to using `docker build` is to [use kaniko](using_kaniko.md).
This avoids having to execute Runner in privileged mode.

TIP: **Tip:**
To see how Docker and Runner are configured for shared Runners on
GitLab.com, see [GitLab.com Shared
Runners](../../user/gitlab_com/index.md#shared-runners).
41 42

### Use shell executor
43 44

The simplest approach is to install GitLab Runner in `shell` execution mode.
45
GitLab Runner then executes job scripts as the `gitlab-runner` user.
46

47
1. Install [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner/#installation).
48

49
1. During GitLab Runner installation select `shell` as method of executing job scripts or use command:
50

51 52 53 54 55 56 57
   ```bash
   sudo gitlab-runner register -n \
     --url https://gitlab.com/ \
     --registration-token REGISTRATION_TOKEN \
     --executor shell \
     --description "My Runner"
   ```
58

59
1. Install Docker Engine on server.
60

61 62
   For more information how to install Docker Engine on different systems
   checkout the [Supported installations](https://docs.docker.com/engine/installation/).
63

64
1. Add `gitlab-runner` user to `docker` group:
65

66 67 68
   ```bash
   sudo usermod -aG docker gitlab-runner
   ```
69

70
1. Verify that `gitlab-runner` has access to Docker:
71

72 73 74
   ```bash
   sudo -u gitlab-runner -H docker info
   ```
75

76
   You can now verify that everything works by adding `docker info` to `.gitlab-ci.yml`:
77

78 79 80
   ```yaml
   before_script:
     - docker info
81

82 83 84 85 86
   build_image:
     script:
       - docker build -t my-docker-image .
       - docker run my-docker-image /script/to/run/tests
   ```
87

88
1. You can now use `docker` command (and **install** `docker-compose` if needed).
89

90 91
NOTE: **Note:**
By adding `gitlab-runner` to the `docker` group you are effectively granting `gitlab-runner` full root permissions.
Mark Pundsack's avatar
Mark Pundsack committed
92
For more information please read [On Docker security: `docker` group considered harmful](https://www.andreas-jung.com/contents/on-docker-security-docker-group-considered-harmful).
93

94
### Use docker-in-docker workflow with Docker executor
95

96 97
The second approach is to use the special docker-in-docker (dind)
[Docker image](https://hub.docker.com/_/docker/) with all tools installed
98
(`docker`) and run the job script in context of that
Evan Read's avatar
Evan Read committed
99
image in privileged mode.
100

101 102 103 104
NOTE: **Note:**
`docker-compose` is not part of docker-in-docker (dind). To use `docker-compose` in your
CI builds, follow the `docker-compose`
[installation instructions](https://docs.docker.com/compose/install/).
105

106 107 108 109 110 111 112 113 114 115 116 117 118 119
DANGER: **Danger:**
By enabling `--docker-privileged`, you are effectively disabling all of
the security mechanisms of containers and exposing your host to privilege
escalation which can lead to container breakout. For more information, check
out the official Docker documentation on
[Runtime privilege and Linux capabilities][docker-cap].

Docker-in-Docker works well, and is the recommended configuration, but it is
not without its own challenges:

- When using docker-in-docker, each job is in a clean environment without the past
  history. Concurrent jobs work fine because every build gets it's own
  instance of Docker engine so they won't conflict with each other. But this
  also means jobs can be slower because there's no caching of layers.
120 121 122 123
- By default, Docker 17.09 and higher uses `--storage-driver overlay2` which is
  the recommended storage driver. See [Using the overlayfs driver](#using-the-overlayfs-driver)
  for details.
- Since the `docker:19.03.1-dind` container and the Runner container don't share their
124 125 126 127
  root filesystem, the job's working directory can be used as a mount point for
  child containers. For example, if you have files you want to share with a
  child container, you may create a subdirectory under `/builds/$CI_PROJECT_PATH`
  and use it as your mount point (for a more thorough explanation, check [issue
128
  #41227](https://gitlab.com/gitlab-org/gitlab-foss/issues/41227)):
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154

    ```yaml
    variables:
      MOUNT_POINT: /builds/$CI_PROJECT_PATH/mnt

    script:
      - mkdir -p "$MOUNT_POINT"
      - docker run -v "$MOUNT_POINT:/mnt" my-docker-image
    ```

An example project using this approach can be found here: <https://gitlab.com/gitlab-examples/docker>.

In the examples below, we are using Docker images tags to specify a
specific version, such as `docker:19.03.1`. If tags like `docker:stable`
are used, you have no control over what version is going to be used and this
can lead to unpredictable behavior, especially when new versions are
released.

#### TLS enabled

NOTE: **Note**
This requires GitLab Runner 11.11 or higher.

The Docker daemon supports connection over TLS and it's done by default
for Docker 19.03.1 or higher. This is the **suggested** way to use the
docker-in-docker service and
155
[GitLab.com Shared Runners](../../user/gitlab_com/index.md#shared-runners)
156
support this.
157

158 159
1. Install [GitLab Runner](https://docs.gitlab.com/runner/install/).

160 161
1. Register GitLab Runner from the command line to use `docker` and `privileged`
   mode:
162

163 164 165 166 167 168
   ```bash
   sudo gitlab-runner register -n \
     --url https://gitlab.com/ \
     --registration-token REGISTRATION_TOKEN \
     --executor docker \
     --description "My Docker Runner" \
169 170 171
     --docker-image "docker:19.03.1" \
     --docker-privileged \
     --docker-volumes "/certs/client"
172 173 174
   ```

   The above command will register a new Runner to use the special
175 176
   `docker:19.03.1` image, which is provided by Docker. **Notice that it's
   using the `privileged` mode to start the build and service
177
   containers.** If you want to use [docker-in-docker](https://www.docker.com/blog/docker-can-now-run-within-docker/) mode, you always
178 179 180 181 182 183
   have to use `privileged = true` in your Docker containers.

   This will also mount `/certs/client` for the service and build
   container, which is needed for the docker client to use the
   certificates inside of that directory. For more information how
   Docker with TLS works check <https://hub.docker.com/_/docker/#tls>.
184 185 186 187 188 189 190 191 192 193

   The above command will create a `config.toml` entry similar to this:

   ```toml
   [[runners]]
     url = "https://gitlab.com/"
     token = TOKEN
     executor = "docker"
     [runners.docker]
       tls_verify = false
194
       image = "docker:19.03.1"
195 196
       privileged = true
       disable_cache = false
197
       volumes = ["/certs/client", "/cache"]
198
     [runners.cache]
199 200 201
       [runners.cache.s3]
       [runners.cache.gcs]
    ```
202

203
1. You can now use `docker` in the build script (note the inclusion of the
204
   `docker:19.03.1-dind` service):
205

206
   ```yaml
207
   image: docker:19.03.1
208 209

   variables:
210 211 212 213 214 215
     # When using dind service, we need to instruct docker, to talk with
     # the daemon started inside of the service. The daemon is available
     # with a network connection instead of the default
     # /var/run/docker.sock socket. docker:19.03.1 does this automatically
     # by setting the DOCKER_HOST in
     # https://github.com/docker-library/docker/blob/d45051476babc297257df490d22cbd806f1b11e4/19.03.1/docker-entrypoint.sh#L23-L29
216 217
     #
     # The 'docker' hostname is the alias of the service container as described at
218
     # https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#accessing-the-services.
219
     #
220
     # Note that if you're using the Kubernetes executor, the variable
221
     # should be set to tcp://localhost:2376 because of how the
222
     # Kubernetes executor connects services to the job container
223
     # DOCKER_HOST: tcp://localhost:2376
224
     #
225 226 227 228 229
     # Specify to Docker where to create the certificates, Docker will
     # create them automatically on boot, and will create
     # `/certs/client` that will be shared between the service and job
     # container, thanks to volume mount from config.toml
     DOCKER_TLS_CERTDIR: "/certs"
230 231

   services:
232
     - docker:19.03.1-dind
233 234 235 236 237 238 239 240 241 242

   before_script:
     - docker info

   build:
     stage: build
     script:
       - docker build -t my-docker-image .
       - docker run my-docker-image /script/to/run/tests
   ```
243

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
#### TLS disabled

Sometimes there are legitimate reasons why you might want to disable TLS.
For example, you have no control over the GitLab Runner configuration
that you are using.

Assuming that the Runner `config.toml` is similar to:

```toml
[[runners]]
  url = "https://gitlab.com/"
  token = TOKEN
  executor = "docker"
  [runners.docker]
    tls_verify = false
    image = "docker:19.03.1"
    privileged = true
    disable_cache = false
    volumes = ["/cache"]
  [runners.cache]
    [runners.cache.s3]
    [runners.cache.gcs]
```
267

268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
You can now use `docker` in the build script (note the inclusion of the
`docker:19.03.1-dind` service):

```yaml
image: docker:19.03.1

variables:
  # When using dind service we need to instruct docker, to talk with the
  # daemon started inside of the service. The daemon is available with
  # a network connection instead of the default /var/run/docker.sock socket.
  #
  # The 'docker' hostname is the alias of the service container as described at
  # https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#accessing-the-services
  #
  # Note that if you're using the Kubernetes executor, the variable should be set to
283
  # tcp://localhost:2375 because of how the Kubernetes executor connects services
284
  # to the job container
285
  # DOCKER_HOST: tcp://localhost:2375
286
  #
287 288
  # For non-Kubernetes executors, we use tcp://docker:2375
  DOCKER_HOST: tcp://docker:2375
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
  #
  # This will instruct Docker not to start over TLS.
  DOCKER_TLS_CERTDIR: ""

services:
  - docker:19.03.1-dind

before_script:
  - docker info

build:
  stage: build
  script:
    - docker build -t my-docker-image .
    - docker run my-docker-image /script/to/run/tests
```
305

306
### Use Docker socket binding
307

308 309 310 311 312 313
The third approach is to bind-mount `/var/run/docker.sock` into the
container so that Docker is available in the context of that image.

NOTE: **Note:**
If you bind the Docker socket [when using GitLab Runner 11.11 or
newer](https://gitlab.com/gitlab-org/gitlab-runner/merge_requests/1261),
314
you can no longer use `docker:19.03.1-dind` as a service because volume bindings
315
are done to the services as well, making these incompatible.
316

Mark Pundsack's avatar
Mark Pundsack committed
317
In order to do that, follow the steps:
318

319 320
1. Install [GitLab Runner](https://docs.gitlab.com/runner/install/).

Mark Pundsack's avatar
Mark Pundsack committed
321
1. Register GitLab Runner from the command line to use `docker` and share `/var/run/docker.sock`:
322

323 324 325 326 327 328
   ```bash
   sudo gitlab-runner register -n \
     --url https://gitlab.com/ \
     --registration-token REGISTRATION_TOKEN \
     --executor docker \
     --description "My Docker Runner" \
329
     --docker-image "docker:19.03.1" \
330 331 332 333
     --docker-volumes /var/run/docker.sock:/var/run/docker.sock
   ```

   The above command will register a new Runner to use the special
334 335 336
   `docker:19.03.1` image which is provided by Docker. **Notice that it's using
   the Docker daemon of the Runner itself, and any containers spawned by Docker
   commands will be siblings of the Runner rather than children of the Runner.**
337 338 339 340 341 342 343 344 345 346 347
   This may have complications and limitations that are unsuitable for your workflow.

   The above command will create a `config.toml` entry similar to this:

   ```toml
   [[runners]]
     url = "https://gitlab.com/"
     token = REGISTRATION_TOKEN
     executor = "docker"
     [runners.docker]
       tls_verify = false
348
       image = "docker:19.03.1"
349 350 351 352 353 354
       privileged = false
       disable_cache = false
       volumes = ["/var/run/docker.sock:/var/run/docker.sock", "/cache"]
     [runners.cache]
       Insecure = false
   ```
355

356
1. You can now use `docker` in the build script (note that you don't need to
357 358
   include the `docker:19.03.1-dind` service as when using the Docker in Docker
   executor):
359

360
   ```yaml
361
   image: docker:19.03.1
362

363 364
   before_script:
     - docker info
365

366 367 368 369 370 371
   build:
     stage: build
     script:
       - docker build -t my-docker-image .
       - docker run my-docker-image /script/to/run/tests
   ```
372

373 374 375 376 377 378 379 380 381 382 383 384
While the above method avoids using Docker in privileged mode, you should be
aware of the following implications:

- By sharing the docker daemon, you are effectively disabling all
  the security mechanisms of containers and exposing your host to privilege
  escalation which can lead to container breakout. For example, if a project
  ran `docker rm -f $(docker ps -a -q)` it would remove the GitLab Runner
  containers.
- Concurrent jobs may not work; if your tests
  create containers with specific names, they may conflict with each other.
- Sharing files and directories from the source repo into containers may not
  work as expected since volume mounting is done in the context of the host
Evan Read's avatar
Evan Read committed
385
  machine, not the build container. For example:
386

387 388 389
   ```sh
   docker run --rm -t -i -v $(pwd)/src:/home/app/src test-image:latest run_app_tests
   ```
Mark Pundsack's avatar
Mark Pundsack committed
390

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
## Making docker-in-docker builds faster with Docker layer caching

When using docker-in-docker, Docker will download all layers of your image every
time you create a build. Recent versions of Docker (Docker 1.13 and above) can
use a pre-existing image as a cache during the `docker build` step, considerably
speeding up the build process.

### How Docker caching works

When running `docker build`, each command in `Dockerfile` results in a layer.
These layers are kept around as a cache and can be reused if there haven't been
any changes. Change in one layer causes all subsequent layers to be recreated.

You can specify a tagged image to be used as a cache source for the `docker build`
command by using the `--cache-from` argument. Multiple images can be specified
as a cache source by using multiple `--cache-from` arguments. Keep in mind that
any image that's used with the `--cache-from` argument must first be pulled
(using `docker pull`) before it can be used as a cache source.

### Using Docker caching

Here's a simple `.gitlab-ci.yml` file showing how Docker caching can be utilized:

```yaml
415
image: docker:19.03.1
416 417

services:
418
  - docker:19.03.1-dind
419 420

variables:
421 422 423
  # Use TLS https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#tls-enabled
  DOCKER_HOST: tcp://docker:2376
  DOCKER_TLS_CERTDIR: "/certs"
424 425

before_script:
Evan Read's avatar
Evan Read committed
426
  - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
427 428 429 430

build:
  stage: build
  script:
Evan Read's avatar
Evan Read committed
431 432 433 434
    - docker pull $CI_REGISTRY_IMAGE:latest || true
    - docker build --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA --tag $CI_REGISTRY_IMAGE:latest .
    - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
    - docker push $CI_REGISTRY_IMAGE:latest
435 436 437 438 439 440 441
```

The steps in the `script` section for the `build` stage can be summed up to:

1. The first command tries to pull the image from the registry so that it can be
   used as a cache for the `docker build` command.
1. The second command builds a Docker image using the pulled image as a
Evan Read's avatar
Evan Read committed
442
   cache (notice the `--cache-from $CI_REGISTRY_IMAGE:latest` argument) if
443 444 445 446
   available, and tags it.
1. The last two commands push the tagged Docker images to the container registry
   so that they may also be used as cache for subsequent builds.

447 448
## Using the OverlayFS driver

449 450 451
NOTE: **Note:**
The shared Runners on GitLab.com use the `overlay2` driver by default.

452
By default, when using `docker:dind`, Docker uses the `vfs` storage driver which
Evan Read's avatar
Evan Read committed
453
copies the filesystem on every run. This is a disk-intensive operation
454
which can be avoided if a different driver is used, for example `overlay2`.
455

456 457
### Requirements

458 459 460
1. Make sure a recent kernel is used, preferably `>= 4.2`.
1. Check whether the `overlay` module is loaded:

461 462 463
   ```sh
   sudo lsmod | grep overlay
   ```
464

465
   If you see no result, then it isn't loaded. To load it use:
466

467 468 469
   ```sh
   sudo modprobe overlay
   ```
470

471 472 473
   If everything went fine, you need to make sure module is loaded on reboot.
   On Ubuntu systems, this is done by editing `/etc/modules`. Just add the
   following line into it:
474

475 476 477
   ```text
   overlay
   ```
478

479
### Use driver per project
480

481 482
You can enable the driver for each project individually by editing the project's `.gitlab-ci.yml`:

Evan Read's avatar
Evan Read committed
483
```yaml
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
variables:
  DOCKER_DRIVER: overlay2
```

### Use driver for every project

To enable the driver for every project, you can set the environment variable for every build by adding `environment` in the `[[runners]]` section of `config.toml`:

```toml
environment = ["DOCKER_DRIVER=overlay2"]
```

If you're running multiple Runners you will have to modify all configuration files.

> **Notes:**
499 500 501 502
>
> - More information about the Runner configuration is available in the [Runner documentation](https://docs.gitlab.com/runner/configuration/).
> - For more information about using OverlayFS with Docker, you can read
>   [Use the OverlayFS storage driver](https://docs.docker.com/engine/userguide/storagedriver/overlayfs-driver/).
503

504 505
## Using the GitLab Container Registry

506
> **Notes:**
Evan Read's avatar
Evan Read committed
507
>
508 509 510 511
> - This feature requires GitLab 8.8 and GitLab Runner 1.2.
> - Starting from GitLab 8.12, if you have [2FA] enabled in your account, you need
>   to pass a [personal access token][pat] instead of your password in order to
>   login to GitLab's Container Registry.
512

513
Once you've built a Docker image, you can push it up to the built-in
514
[GitLab Container Registry](../../user/packages/container_registry/index.md).
515 516 517 518 519 520 521 522 523 524
Some things you should be aware of:

- You must [log in to the container registry](#authenticating-to-the-container-registry)
  before running commands. You can do this in the `before_script` if multiple
  jobs depend on it.
- Using `docker build --pull` fetches any changes to base
  images before building just in case your cache is stale. It takes slightly
  longer, but means you don’t get stuck without security patches to base images.
- Doing an explicit `docker pull` before each `docker run` fetches
  the latest image that was just built. This is especially important if you are
525
  using multiple runners that cache images locally. Using the Git SHA in your
526 527 528 529 530 531 532 533 534 535 536 537 538
  image tag makes this less necessary since each job will be unique and you
  shouldn't ever have a stale image. However, it's still possible to have a
  stale image if you re-build a given commit after a dependency has changed.
- You don't want to build directly to `latest` tag in case there are multiple jobs
  happening simultaneously.

### Authenticating to the Container Registry

There are three ways to authenticate to the Container Registry via GitLab CI/CD
and depend on the visibility of your project.

For all projects, mostly suitable for public ones:

Evan Read's avatar
Evan Read committed
539
- **Using the special `$CI_REGISTRY_USER` variable**: The user specified by this variable is created for you in order to
540
  push to the Registry connected to your project. Its password is automatically
Evan Read's avatar
Evan Read committed
541
  set with the `$CI_REGISTRY_PASSWORD` variable. This allows you to automate building and deploying
542 543 544
  your Docker images and has read/write access to the Registry. This is ephemeral,
  so it's only valid for one job. You can use the following example as-is:

545 546 547
  ```sh
  docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
  ```
548 549 550 551 552 553

For private and internal projects:

- **Using a personal access token**: You can create and use a
  [personal access token](../../user/profile/personal_access_tokens.md)
  in case your project is private:
Evan Read's avatar
Evan Read committed
554 555 556 557

  - For read (pull) access, the scope should be `read_registry`.
  - For read/write (pull/push) access, use `api`.

558 559
  Replace the `<username>` and `<access_token>` in the following example:

560 561 562
  ```sh
  docker login -u <username> -p <access_token> $CI_REGISTRY
  ```
563 564 565 566 567 568 569

- **Using the GitLab Deploy Token**: You can create and use a
  [special deploy token](../../user/project/deploy_tokens/index.md#gitlab-deploy-token)
  with your private projects. It provides read-only (pull) access to the Registry.
  Once created, you can use the special environment variables, and GitLab CI/CD
  will fill them in for you. You can use the following example as-is:

570 571 572
  ```sh
  docker login -u $CI_DEPLOY_USER -p $CI_DEPLOY_PASSWORD $CI_REGISTRY
  ```
573

574 575 576 577 578
### Using docker-in-docker image from Container Registry

If you want to use your own Docker images for docker-in-docker there are a few things you need to do in addition to the steps in the [docker-in-docker](#use-docker-in-docker-workflow-with-docker-executor) section:

1. Update the `image` and `service` to point to your registry.
Marcel Amirault's avatar
Marcel Amirault committed
579
1. Add a service [alias](../yaml/README.md#servicesalias).
580

581 582
Below is an example of what your `.gitlab-ci.yml` should look like,
assuming you have it configured with [TLS enabled](#tls-enabled):
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601

```yaml
 build:
   image: $CI_REGISTRY/group/project/docker:19.03.1
   services:
     - name: $CI_REGISTRY/group/project/docker:19.03.1-dind
       alias: docker
   variables:
     # Specify to Docker where to create the certificates, Docker will
     # create them automatically on boot, and will create
     # `/certs/client` that will be shared between the service and
     # build container.
     DOCKER_TLS_CERTDIR: "/certs"
   stage: build
   script:
     - docker build -t my-docker-image .
     - docker run my-docker-image /script/to/run/tests
```

602
If you forget to set the service alias, the `docker:19.03.1` image won't find the
603 604 605 606 607 608 609
`dind` service, and an error like the following is thrown:

```sh
$ docker info
error during connect: Get http://docker:2376/v1.39/info: dial tcp: lookup docker on 192.168.0.1:53: no such host
```

610 611 612
### Container Registry examples

If you're using docker-in-docker on your Runners, this is how your `.gitlab-ci.yml`
613
could look like:
614 615

```yaml
616 617 618 619 620 621 622 623 624 625 626 627 628
build:
  image: docker:19.03.1
  stage: build
  services:
    - docker:19.03.1-dind
  variables:
    # Use TLS https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#tls-enabled
    DOCKER_HOST: tcp://docker:2376
    DOCKER_TLS_CERTDIR: "/certs"
  script:
    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
    - docker build -t $CI_REGISTRY/group/project/image:latest .
    - docker push $CI_REGISTRY/group/project/image:latest
629 630
```

631 632 633 634
You can also make use of [other variables](../variables/README.md) to avoid hardcoding:

```yaml
build:
635
  image: docker:19.03.1
636
  stage: build
637 638 639 640 641 642 643
  services:
    - docker:19.03.1-dind
  variables:
    # Use TLS https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#tls-enabled
    DOCKER_HOST: tcp://docker:2376
    DOCKER_TLS_CERTDIR: "/certs"
    IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
644
  script:
645
    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
646 647 648 649 650
    - docker build -t $IMAGE_TAG .
    - docker push $IMAGE_TAG
```

Here, `$CI_REGISTRY_IMAGE` would be resolved to the address of the registry tied
651 652 653 654
to this project. Since `$CI_COMMIT_REF_NAME` resolves to the branch or tag name,
and your branch-name can contain forward slashes (e.g., feature/my-feature), it is
safer to use `$CI_COMMIT_REF_SLUG` as the image tag. This is due to that image tags
cannot contain forward slashes. We also declare our own variable, `$IMAGE_TAG`,
655 656
combining the two to save us some typing in the `script` section.

657
Here's a more elaborate example that splits up the tasks into 4 pipeline stages,
658
including two tests that run in parallel. The `build` is stored in the container
659 660 661 662 663
registry and used by subsequent stages, downloading the image
when needed. Changes to `master` also get tagged as `latest` and deployed using
an application-specific deploy script:

```yaml
664
image: docker:19.03.1
665
services:
666
  - docker:19.03.1-dind
667 668

stages:
Cam's avatar
Cam committed
669 670 671 672
  - build
  - test
  - release
  - deploy
673 674

variables:
675 676 677
  # Use TLS https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#tls-enabled
  DOCKER_HOST: tcp://docker:2376
  DOCKER_TLS_CERTDIR: "/certs"
678 679
  CONTAINER_TEST_IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
  CONTAINER_RELEASE_IMAGE: $CI_REGISTRY_IMAGE:latest
680 681

before_script:
Evan Read's avatar
Evan Read committed
682
  - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718

build:
  stage: build
  script:
    - docker build --pull -t $CONTAINER_TEST_IMAGE .
    - docker push $CONTAINER_TEST_IMAGE

test1:
  stage: test
  script:
    - docker pull $CONTAINER_TEST_IMAGE
    - docker run $CONTAINER_TEST_IMAGE /script/to/run/tests

test2:
  stage: test
  script:
    - docker pull $CONTAINER_TEST_IMAGE
    - docker run $CONTAINER_TEST_IMAGE /script/to/run/another/test

release-image:
  stage: release
  script:
    - docker pull $CONTAINER_TEST_IMAGE
    - docker tag $CONTAINER_TEST_IMAGE $CONTAINER_RELEASE_IMAGE
    - docker push $CONTAINER_RELEASE_IMAGE
  only:
    - master

deploy:
  stage: deploy
  script:
    - ./deploy.sh
  only:
    - master
```

719 720 721 722 723 724 725
NOTE: **Note:**
This example explicitly calls `docker pull`. If you prefer to implicitly pull the
built image using `image:`, and use either the [Docker](https://docs.gitlab.com/runner/executors/docker.html)
or [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes.html) executor,
make sure that [`pull_policy`](https://docs.gitlab.com/runner/executors/docker.html#how-pull-policies-work)
is set to `always`.

726
[docker-cap]: https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities
727 728
[2fa]: ../../user/profile/account/two_factor_authentication.md
[pat]: ../../user/profile/personal_access_tokens.md
Evan Read's avatar
Evan Read committed
729

730
## Troubleshooting
Evan Read's avatar
Evan Read committed
731

732
### docker: Cannot connect to the Docker daemon at tcp://docker:2375. Is the docker daemon running?
Evan Read's avatar
Evan Read committed
733

734 735 736 737 738 739 740 741 742 743 744
This is a common error when you are using
[Docker in Docker](#use-docker-in-docker-workflow-with-docker-executor)
v19.03 or higher.

This occurs because Docker starts on TLS automatically, so you need to do some set up.
If:

- This is the first time setting it up, carefully read
  [using Docker in Docker workflow](#use-docker-in-docker-workflow-with-docker-executor).
- You are upgrading from v18.09 or earlier, read our
  [upgrade guide](https://about.gitlab.com/blog/2019/07/31/docker-in-docker-with-docker-19-dot-03/).