Build and push container images to the Container Registry (FREE)
Before you can build and push container images, you must authenticate with the Container Registry.
Use Docker commands
You can use Docker commands to build and push container images to your Container Registry:
-
Authenticate with the Container Registry.
-
Run the Docker command to build or push. For example:
-
To build:
docker build -t registry.example.com/group/project/image .
-
To push:
docker push registry.example.com/group/project/image
-
.gitlab-ci.yml
file
Configure your You can configure your .gitlab-ci.yml
file to build and push container images to the Container Registry.
-
If multiple jobs require authentication, put the authentication command in the
before_script
. -
Before building, use
docker build --pull
to fetch changes to base images. It takes slightly longer, but it ensures your image is up-to-date. -
Before each
docker run
, do an explicitdocker pull
to fetch the image that was just built. This step is especially important if you are using multiple runners that cache images locally.If you use the Git SHA in your image tag, each job is unique and you should never have a stale image. However, it's still possible to have a stale image if you rebuild a given commit after a dependency has changed.
-
Don't build directly to the
latest
tag because multiple jobs may be happening simultaneously.
Use GitLab CI/CD
You can use GitLab CI/CD to build and push container images to the Container Registry. You can use CI/CD to test, build, and deploy your project from the container image you created.
Use a Docker-in-Docker container image from your Container Registry
You can use your own container images for Docker-in-Docker.
- Set up Docker-in-Docker.
- Update the
image
andservice
to point to your registry. - Add a service alias.
Your .gitlab-ci.yml
should look similar to this:
build:
image: $CI_REGISTRY/group/project/docker:20.10.16
services:
- name: $CI_REGISTRY/group/project/docker:20.10.16-dind
alias: docker
stage: build
script:
- docker build -t my-docker-image .
- docker run my-docker-image /script/to/run/tests
If you forget to set the service alias, the container image can't find the dind
service,
and an error like the following is shown:
error during connect: Get http://docker:2376/v1.39/info: dial tcp: lookup docker on 192.168.0.1:53: no such host
Use a Docker-in-Docker container image with Dependency Proxy
You can use your own container images with Dependency Proxy.
- Set up Docker-in-Docker.
- Update the
image
andservice
to point to your registry. - Add a service alias.
Your .gitlab-ci.yml
should look similar to this:
build:
image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/docker:20.10.16
services:
- name: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/docker:18.09.7-dind
alias: docker
stage: build
script:
- docker build -t my-docker-image .
- docker run my-docker-image /script/to/run/tests
If you forget to set the service alias, the container image can't find the dind
service,
and an error like the following is shown:
error during connect: Get http://docker:2376/v1.39/info: dial tcp: lookup docker on 192.168.0.1:53: no such host
Container Registry examples with GitLab CI/CD
If you're using Docker-in-Docker on your runners, your .gitlab-ci.yml
file should look similar to this:
build:
image: docker:20.10.16
stage: build
services:
- docker:20.10.16-dind
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
You can use CI/CD variables in your .gitlab-ci.yml
file. For example:
build:
image: docker:20.10.16
stage: build
services:
- docker:20.10.16-dind
variables:
IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
script:
- docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
- docker build -t $IMAGE_TAG .
- docker push $IMAGE_TAG
In this example, $CI_REGISTRY_IMAGE
resolves to the address of the registry tied
to this project. $CI_COMMIT_REF_NAME
resolves to the branch or tag name, which
can contain forward slashes. Image tags can't contain forward slashes. Use
$CI_COMMIT_REF_SLUG
as the image tag. You can declare the variable, $IMAGE_TAG
,
combining $CI_REGISTRY_IMAGE
and $CI_COMMIT_REF_NAME
to save some typing in the
script
section.
This example splits the tasks into 4 pipeline stages, including two tests that run in parallel. The build
is stored in the container
registry and used by subsequent stages, downloading the container image when needed. Changes to main
also get tagged as
latest
and deployed using an application-specific deploy script:
image: docker:20.10.16
services:
- docker:20.10.16-dind
stages:
- build
- test
- release
- deploy
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"
CONTAINER_TEST_IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
CONTAINER_RELEASE_IMAGE: $CI_REGISTRY_IMAGE:latest
before_script:
- docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
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:
- main
deploy:
stage: deploy
script:
- ./deploy.sh
only:
- main
environment: production
NOTE:
This example explicitly calls docker pull
. If you prefer to implicitly pull the container image using image:
,
and use either the Docker or Kubernetes executor,
make sure that pull_policy
is set to always
.