GitLab Container Registry | GitLab https://docs.gitlab.com/ee/user/packages/container_registry/index.

html

GitLab Container Registry

Version history

With the Docker Container Registry integrated into GitLab, every project can have its own space to store its Docker images.
You can read more about Docker Registry at https://docs.docker.com/registry/introduction/ .

Enable the Container Registry for your project

If you cannot find the Packages > Container Registry entry under your project’s sidebar, it is not enabled in your GitLab instance.
Ask your administrator to enable GitLab Container Registry following the administration documentation.
If you are using GitLab.com, this is enabled by default so you can start using the Registry immediately. Currently there is a soft
(10GB) size restriction for Registry on GitLab.com, as part of the repository size limit.
Once enabled for your GitLab instance, to enable Container Registry for your project:

1. Go to your project’s Settings > General page.

2. Expand the Visibility, project features, permissions section and enable the Container Registry feature on your project. For
new projects this might be enabled by default. For existing projects (prior GitLab 8.8), you will have to explicitly enable it.
3. Press Save changes for the changes to take effect. You should now be able to see the Packages > Container Registry link in
the sidebar.

Control Container Registry from within GitLab

GitLab offers a simple Container Registry management panel. Go to your project and click Packages > Container Registry in the
project menu.
This view will show you all Docker images in your project and will easily allow you to delete them.

Use images from GitLab Container Registry

To download and run a container from images hosted in GitLab Container Registry, use docker run :

For more information on running Docker containers, visit the Docker documentation .

Authenticating to the GitLab Container Registry

If you visit the Packages > Container Registry link under your project’s menu, you can see the explicit instructions to login to the
Container Registry using your GitLab credentials.
For example if the Registry’s URL is registry.example.com , then you should be able to login with:

1 of 7 21-Feb-20, 4:57 PM
GitLab Container Registry | GitLab https://docs.gitlab.com/ee/user/packages/container_registry/index.html

If a project is private, credentials will need to be provided for authorization. There are two ways to do this:

By using a personal access token.

By using a deploy token.

The minimum scope needed for both of them is read_registry .

Example of using a token:

Build and push images from your local machine

Building and publishing images should be a straightforward process. Just make sure that you are using the Registry URL with the
namespace and project name that is hosted on GitLab:

Your image will be named after the following scheme:

GitLab supports up to three levels of image repository names. The following examples of image tags are valid:

Build and push images using GitLab CI/CD

While you can build and push your images from your local machine, the true power of the Container Registry comes when you
combine it with GitLab CI/CD. You can then create workflows and automate any processes that involve testing, building, and
eventually deploying your project from the Docker image you created.
Before diving into the details, some things you should be aware of:

You must authenticate to the container registry before running any 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 in case your cache is stale. It takes slightly
longer, but it means you don’t get stuck without security patches for 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 using multiple Runners that cache images locally. Using the Git SHA in your 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 with GitLab CI/CD

There are three ways to authenticate to the Container Registry via GitLab CI/CD which depend on the visibility of your project.
Available for all projects, though more suitable for public ones:

Using the special CI_REGISTRY_USER variable: The user specified by this variable is created for you in order to push to the
Registry connected to your project. Its password is automatically set with the CI_REGISTRY_PASSWORD variable. This allows you

2 of 7 21-Feb-20, 4:57 PM
GitLab Container Registry | GitLab https://docs.gitlab.com/ee/user/packages/container_registry/index.html

to automate building and deploying 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:

For private and internal projects:

Using a personal access token: You can create and use a personal access token in case your project is private:
For read (pull) access, the scope should be read_registry .
For read/write (pull/push) access, use api .

Replace the <username> and <access_token> in the following example:

Using the GitLab Deploy Token: You can create and use a special 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:

Container Registry examples with GitLab CI/CD

If you’re using docker-in-docker on your Runners, this is how your .gitlab-ci.yml should look similar to this:

You can also make use of other variables to avoid hardcoding:

Here, $CI_REGISTRY_IMAGE would be resolved to the address of the registry tied 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 , combining the two to save us some typing in the script section.

Here’s a more elaborate example that splits up 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 image when needed. Changes to master also get

3 of 7 21-Feb-20, 4:57 PM
GitLab Container Registry | GitLab https://docs.gitlab.com/ee/user/packages/container_registry/index.html

tagged as latest and deployed using an application-specific deploy script:

4 of 7 21-Feb-20, 4:57 PM
GitLab Container Registry | GitLab https://docs.gitlab.com/ee/user/packages/container_registry/index.html

Using a docker-in-docker image from your 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 section:

1. Update the image and service to point to your registry.

2. Add a service alias.

Below is an example of what your .gitlab-ci.yml should look like:

If you forget to set the service alias, the docker:19.03.1 image won’t find the dind service, and an error like the following will be
thrown:

Expiration policy
Introduced in GitLab 12.8.

It is possible to create a per-project expiration policy, so that you can make sure that older tags and images are regularly removed
from the Container Registry.
The expiration policy algorithm starts by collecting all the tags for a given repository in a list, then goes through a process of
excluding tags from it until only the ones to be deleted remain:

1. Collect all the tags for a given repository in a list.

2. Excludes the tag named latest from the list.
3. Evaluates the name_regex , excluding non-matching names from the list.
4. Excludes any tags that do not have a manifest (not part of the options).
5. Orders the remaining tags by created_date .
6. Excludes from the list the N tags based on the keep_n value (Expiration latest).
7. Excludes from the list the tags older than the older_than value (Expiration interval).
8. Finally, the remaining tags in the list are deleted from the Container Registry.

Managing project expiration policy through the API

You can set, update, and disable the expiration policies using the GitLab API.
Examples:

Select all tags, keep at least 1 tag per image, expire any tag older than 14 days, run once a month, and the policy is enabled:

Select only tags with a name that contains stable , keep at least 50 tag per image, expire any tag older than 7 days, run every
day, and the policy is enabled:

5 of 7 21-Feb-20, 4:57 PM
GitLab Container Registry | GitLab https://docs.gitlab.com/ee/user/packages/container_registry/index.html

See the API documentation for further details: Edit project.

Managing project expiration policy through the UI

To manage project expiration policy, navigate to Settings > CI/CD > Container Registry tag expiration policy.

The UI allows you to configure the following:

Expiration policy: enable or disable the expiration policy.

Expiration interval: how long tags are exempt from being deleted.
Expiration schedule: how often the cron job checking the tags should run.
Expiration latest: how many tags to always keep for each image.
Docker tags with names matching this regex pattern will expire: the regex used to determine what tags should be expired.
To qualify all tags for expiration, use the default value of .* .

Limitations
Moving or renaming existing Container Registry repositories is not supported once you have pushed images, because the images are
signed, and the signature includes the repository name. To move or rename a repository with a Container Registry, you will have to
delete all existing images.

Troubleshooting the GitLab Container Registry

Docker connection error

A Docker connection error can occur when there are special characters in either the group, project or branch name. Special
characters can include:

Leading underscore

6 of 7 21-Feb-20, 4:57 PM
GitLab Container Registry | GitLab https://docs.gitlab.com/ee/user/packages/container_registry/index.html

Trailing hyphen/dash

To get around this, you can change the group path, change the project path or change the branch name.

Troubleshoot as a GitLab server admin

Troubleshooting the GitLab Container Registry, most of the times, requires administration access to the GitLab server.
Read how to troubleshoot the Container Registry.

Help and feedback

DOCS FEEDBACK PRODUCT FEEDBACK GET HELP GET MORE FEATURES

If you spot an error or a need for improvement and would like to fix it yourself in a
merge request

If you would like to suggest an improvement to this doc

If you want to give quick and simple feedback on this doc

7 of 7 21-Feb-20, 4:57 PM