Getting Started With Artifactory as a Docker Registry
There are these main ways to get started using Docker with Artifactory:
- Artifactory SaaS account
- Artifactory On-Prem
For more details, please refer to Getting Started with Artifactory as a Docker Registry.
Configuring Docker Repositories
Artifactory supports three types of repositories when working with Docker:
- Local repositories are a place for your internal Docker images. Through Artifactory's security capabilities, these are secure private Docker registries.
- Remote repositories are used to proxy remote Docker resources such as Docker Hub.
- Virtual repositories can aggregate multiple Docker registries thus enabling a single endpoint you can use for both pushing and pulling Docker images. This enables the admin to manage the different Docker registries without the users knowing, and continue to work with the same end point.
**Make sure to go to the Advanced tab of each repository and set the Registry Port if you are using the Port method for Docker. Then, the reverse proxy generator should add a new section in for the specified port.
Do not use underscores when naming Docker repositories
Due to a limitation in the Docker client, underscores are not permitted in Docker registry names. Therefore, when naming Artifactory Docker repositories, you should not use an underscore. For example, the Docker client will not be able to communicate with a repository named
test_docker_repo, however it will work with a repository named
Local Docker Repositories
A local Docker repository is where you can deploy and host your internal Docker images. It is, in effect, a Docker registry able to host collections of tagged Docker images which are your Docker Repositories. Once your images are hosted, you can exercise fine-grained access control, and share them across your organization through replication or by being proxied by repositories in other Artifactory instances.
To define a local Docker repository:
- From the Administration module, select Repositories | Repositories | Local.
- Click New Local Repository and select Docker from the Select Package Type dialog.
Set the Repository Key, and in the Docker Settings section, select V2 as the Docker API version.
Set Max Unique Tags. This specifies the maximum number of unique tags, per repository, that should be stored for a Docker image. Once the number of tags for an image exceeds this number, older tags will be removed. Leaving the field blank (default) means all tags will be stored.
Remote Docker Repositories
With Docker, you can proxy a remote Docker registry through remote repositories. A Remote Repositories defined in Artifactory serves as a caching proxy for a registry managed at a remote URL such as https://registry-1.docker.io/
Docker images requested from a remote repository are cached on demand. You can remove downloaded images from the remote repository cache, however, you can not manually push Docker images to a remote Docker repository.
Action Required to Prevent Docker Remote Registry Restrictions
In lieu of the latest Docker remote repository limitations enforced by Docker, anonymous users will be blocked when reaching the download rate limit of 100 pulls per six hours. To prevent this from happening, you are required to authenticate with Docker Hub, by setting your Docker account user and password in your Remote Docker Repositories.
To define a remote repository to proxy a remote Docker registry follow the steps below:
- From the Administration module, select Repositories | Repositories | Remote.
- Click New Remote Repository and select Docker from the Select Package Type dialog.
- In the Basic tab, set the Repository Key value, and specify the URL to the remote registry in the URL field.
If you are proxying the Docker Hub, use
https://registry-1.docker.io/as the URL, and make sure the Enable Token Authentication checkbox is checked (these are the default settings).
- To use your Docker account type, you need to authenticate the Docker Hub pull requests, by setting your user and password in your basic Docker repository.
- Click the Advanced tab to configure the Advanced Docker Repository settings you can enable Foreign Layers Caching to allow Artifactory to download foreign layers to a Docker remote repository.
- Select the Enable Foreign Layers Caching checkbox to allow Artifactory to download foreign layers to a Docker remote repository.
- You have an option to apply Patterns Allow List by setting Include patterns to match external URLs when trying to download foreign layers.
Specify an Allow List of Ant-style path expressions that specify where foreign layers may be downloaded from. Supported expressions include (
By default, this field is set to
**which means that foreign layers may be downloaded from any external source.
For example, specifying **/github.com/** will only allow downloading foreign layers from a github.com host.
- To configure the Network settings, see Network Settings.
- Click Save and Finish.
Docker Repository Path and Domain
When accessing a remote Docker repository through Artifactory, the repository URL must be prefixed with
api/docker in the path.
Virtual Docker Repositories
Artifactory supports virtual Docker Repositories. A Virtual Repositories defined in Artifactory aggregates images from both local and remote repositories that are included in the virtual repositories.
This allows you to access images that are hosted locally on local Docker repositories, as well as remote images that are proxied by remote Docker repositories, and access all of them from a single URL defined for the virtual repository. Using virtual repositories can be very useful since users will continue to work with the virtual repository while the admin can manage the included repositories, replace the default deployment target and those changes will be transparent to the users.
To define a virtual Docker repository follow the steps below:
- From the Administration module, select Repositories | Repositories | Virtual.
- Click New Virtual Repository and select Docker from the Select Package Type dialog.
- Set the Repository Key value.
- Select the underlying local and remote Docker repositories to include under the Repositories section.
- You can optionally also configure your Default Deployment Repository. This is the repository to which Docker images uploaded to this virtual repository will be routed, and once this is configured, your virtual Docker repository is a fully-fledged Docker registry. Using the default deployment repository, you can set up your virtual repository to wrap a series of repositories that represent the stages of your pipeline, and then promote images from the default deployment repository through the pipeline to production. Any repository that represents a stage in your pipeline within this virtual repository can be configured with permissions for authenticated or unauthenticated (anonymous) access according to your needs.
Resolve Latest Docker Image
To set your virtual Docker repository to pull Docker images according to their modification time, enable Resolve Docker Tags By Latest Timestamp. This is useful in scenarios where two or more aggregated repositories contain the same tag name. For example,
When enabled, instead of fetching the image that is positioned higher in the resolution order in the virtual repository, Artifactory will return the Docker image last deployed to one of the aggregated repositories in the Virtual repository. Artifactory will first try to fetch the tag from the Local repositories according to the modification time, if not found, it will continue to try to fetch the image from the Remote repositories according to the resolution order.
This functionality is useful for multi-site environments where you create the same image on two different instances.
This can also be configured by setting the resolveDockerTagsByTimestamp parameter to true (false by default) when creating a new repository using REST API.
Reverse Proxy Settings
When accessing through a reverse proxy, if you are using the Artifactory Reverse Proxy configuration generator you can configure a Docker repository's reverse proxy settings under the Advanced settings tab. For details, please refer to Docker Reverse Proxy Settings.
Promoting Docker Images
Artifactory supports promoting Docker images from one Docker repository in Artifactory to another.
Promoting is useful when you need to move Docker images through different acceptance and testing stages, for example, from a development repository, through the different gateways all the way to production. Instead of rebuilding the image multiple times using promotion will ensure the image you will have in your production environment is the one built by your CI server and passed all the relevant tests.
Promotion can be triggered using the following endpoint with cURL:
|repoKey||Source repository key|
|targetRepo||The target repository to move or copy|
|dockerRepository||The docker repository name to promote|
|tag||An optional tag name to promote, if null - the entire docker repository will be promoted. Default: |
|targetTag||The new tag that the image should have after being promoted if you want to|
|copy||When true, a copy of the image is promoted. When false, the image is moved to the target repository|
An example for promoting the docker image
jfrog/ubuntu"] with all of it's tags from
docker-prod using cURL would be:
Notice that the above example is executed through your reverse proxy. To go directly through Artifactory, you would execute this command as follows:
The following example adds retagging with a specific version of the
jfrog/ubuntu image (4.9.0) being retagged to
latest as it gets promoted:
Pushing and Pulling Images
Set Me Up
To get the corresponding
docker push and
docker pull commands for any repository, go to Artifactory | Artifacts | Artifact Repository Browser, in the Application module, and click Set Me Up.
Pushing Multi-Architecture Docker Images to Artifactory
JFrog Artifactory supports the following methods for pushing multi-architecture Docker images to a Docker Registry:
- Pushing Docker images for each architecture one by one
- Pushing Docker images in bulk using the Docker Buildx CLI (Supported from Artifactory 7.21.2 and higher)
- Pushing Multi-Architecture Docker Images Using Docker Build from Artifactory 7.21.2 and higher.
Pushing Docker Images One by One
To learn how the standard Docker Pull REST API functions in Artifactory 7.21.2, see Pushing Multi-Architecture Docker Images Using Docker Build.
You can push multi-architecture Docker images, using a '
Manifest Lists' file, (officially referred by Docker as the
‘fat manifest file’), which references image manifests for platform-specific versions of an image. For more information, click here.
The process of pushing multi-architecture Docker images is similar to the standard Docker Push process, with a few exceptions:
- Each architecture gets a different tag.
- After all the architectures have been built and pushed, a single ‘
fat manifest file' is created and contains all of the images with the relevant tagging.
- After pushing the
manifest file', the images are published with the given tags.
Pushing Images in Bulk Using the Docker Buildx CLI
From Artifactory 7.21.2, the
Docker buildx command is supported, allowing you to create and upload Docker ‘
manifest lists’ to the Docker registry in Artifactory.
buildx allows you to build and push multi-architecture images using a single command instead of having to build and push each of the architecture images separately. For more information, see Working with buildx.
To support the
Docker buildx, Artifactory saves each architecture of the image under the following path structure with the tag that includes the originally published tag, the image operating system, and the image architecture.
The following example shows the Docker BuildX API usage.
Pushing Multi-Architecture Docker Images Using Docker Build
From Artifactory version 7.21.2 and higher, if you continue to push multi-architecture Docker images using
Docker build, all your pushed images will be duplicated, and the architecture tag will be automatically added to each image.
In the following example, pushing the following images using Docker Build will result in Artifactory automatically duplicating the images and adding the
linux tag to each image.
Image A is pushed during the build.
Artifactory duplicates the image and adds the
Image B si pushed during the build.
Artifactory duplicates the image and adds the '
Browsing Docker Repositories
For general information on how to browse repositories, please refer to Browsing Artifactory.
The Docker Info tab presents three sections: Tag Info, Docker Tag Visualization, and Labels.
Presents basic details about the selected tag.
|Title||The Docker tag name.|
The tag's SHA 256 digest.
|Total Size||The total size of the image|
The number of labels attached to this tag.
Click the label count to view the attached labels at the bottom of the screen.
Docker Tag Visualization
This section maps the entire set of commands used to generate the selected tag along with the digest of the corresponding layer. Essentially, you would see the same series of commands using
You can select any layer of the image to view the following properties.
|The layer ID|
|The layer size|
|The timestamp when the layer was created|
|The command that created the layer|
This section displays the labels attached to the image.
Note also, that Artifactory extracts any labels associated with a Docker image and creates corresponding properties on the
manifest.json file which you can use to specify search parameters, this can be used to easily add additional metadata to any image.
Searching for Docker Images
Listing Docker Images
Artifactory supports the following REST API endpoints related to Docker registries:
- List Docker Images provides a list of Docker images in the specified Artifactory Docker registry. This endpoint mimics the Docker
- List Docker Tags provides a list of tags for the specified Docker image.
Artifactory also supports pagination for this endpoint.
To enable fetch from cache using the ListDockerRepositories and the ListDockerTags REST APIs, set the
artifactory.docker.catalogs.tags.fallback.fetch.remote.cache system property to true (default false) in the artifactory.system.properties file:
Artifactory needs to be restarted for this change to take effect.
Deletion and Cleanup
Artifactory natively supports removing tags and repositories and complies with the Docker Hub spec.
Deletion of Docker tags and repositories automatically cleans up any orphan layers that are left (layers not used by any other tag/repository).
Currently, the Docker client does not support DELETE commands, but deletion can be triggered manually. To delete an entire Docker repository using cURL, execute the following command:
Or for a specific tag version:
For example, to remove the latest tag of an Ubuntu repository:
Any empty directories that are left following removal of a repository or tag will automatically be removed during the next folder pruning job (which occurs every 5 minutes by default).
Limiting Unique Tags
To avoid clutter and bloat in your Docker registries caused by many snapshots being uploaded for an image, set the
Max Unique Tags field in the Local Docker Repository configuration to limit the number of unique tags.
Docker Build Information
You may store exhaustive build information in Artifactory by running your Docker builds with JFrog CLI.
JFrog CLI collects build-info from your build agents and then publishes it to Artifactory. Once published, the build info can be viewed in the Build Browser under Builds.
For more details on Docker build integration using JFrog CLI, please refer to Building Docker Images in the JFrog CLI User Guide.
Migrating from Docker V1 to Docker V2
If you are still using Docker V1, we strongly recommend upgrading to Docker V2. This requires that you migrate any Docker repositories that were created for Docker V1, and is done with a simple cURL endpoint.
Using Docker V1?
This document shows how to use Artifactory with the Docker V2 . If you are using the Docker V1, please refer to Using Docker V1.