Getting Started with Artifactory as a Docker Registry

Getting Started with Artifactory SaaS

Using Docker repositories withArtifactory SaaSis quick and easy to use.

Since, with Artifactory SaaS, you are using Artifactory as a hosted service, there is no need to configure Artifactory with a reverse proxy.

The example at the end of this section shows a complete process of creating a Docker repository, logging in, pulling an image and pushing an image.

Using Docker Client with Artifactory SaaS

To use the Docker client with one of your Artifactory SaaS Docker repositories, you can use the native Docker client to login to each Docker repository, pull, and push images as shown in the following example:

• Login to your repository use the following command with your Artifactory SaaS credentials

  docker login ${server-name}-{repo-name}.jfrog.io

• Pull an image using the following command

  docker pull ${server-name}-{repo-name}.jfrog.io/

• To push an image, first tag it and then use the push command

  docker tag  ${server-name}-{repo-name}.jfrog.io/ docker push ${server-name}-{repo-name}.jfrog.io/

Test Your Setup

您可以测试您的设置与这个例子的屁股umes you are using an Artifactory SaaS server named "acme".

The scenario it demonstrates is:

• Pulling the "hello-world" Docker image
• Logging into your virtual Docker repository
• Retagging the "hello-world" image, and then pushing it into your virtual Docker repository

Start by creating avirtual Docker repositorycalleddockerv2-virtual.

• Pull the "hello-world" image

  docker pull hello-world

• Login to repository dockerv2-virtual

  docker login acme-dockerv2-virtual.jfrog.io

• Tag the "hello-world" image

  docker tag hello-world acme-dockerv2-virtual.jfrog.io/hello-world

• Push the tagged "hello-world" image to dockerv2-virtual

  docker push acme-dockerv2-virtual.jfrog.io/hello-world

Using Docker Compose - 1 Minute Setup

Artifactory may easily be installed as a Docker registry running in Docker. This is the easiest way to use Artifactory as a Docker registry on-premises. The installation spins up the following three containers:

• Artifactory Pro
• NGINX proxy that uses a self-signed certificate and is configured for access using the sub-domain method
• A Postgres database

To spin up this installation run the following command:

curl -L 'https://bintray.com/api/v1/content/jfrog/run/art-compose/$latest/art-compose?bt_package=art-compose' | sudo bash

Complete the Setup

To complete the setup, invoke theonboarding wizardbyrunning Artifactory in your browser athttp:///artifactory.

• Activate Artifactory with your license key. If you do not have a license you can get aFree Trial License.
• You may set the Admin password or skip to accept the default
• If necessary, configure your network proxy or just skip this step (you mayconfigure a proxy serverat any time later)
• AtCreate Repositories,selectDockerand continue to complete the wizard

Finally, follow the steps below:

1. You need to add the following to your DNS or/etc/hostsfile:

    docker-local.artifactory docker-remote.artifactory docker-virtual.artifactory docker.artifactory artifactory

2. Since the certificate is self-signed, you need to import it to your Docker certificate trust store as described in theDocker documentation. Alternatively, you can configure the Docker client to work with an insecure registry by adding the following line to your/etc/default/dockerfile (you may need to create the file if it does not already exist):
   

   DOCKER_OPTS="$DOCKER_OPTS --insecure-registry docker-local.artifactory --insecure-registry docker-remote.artifactory --insecure-registry docker-virtual.artifactory --insecure-registry docker.artifactory"

3. Restart your Docker daemon/engine to apply the insecure registry flag (if self-signed certificate is imported, you do not need to restart the Docker daemon/engine).

Test Your Setup

You can test your setup with this example .

The scenario it demonstrates is:

• Pulling the "hello-world" Docker image
• Logging into your virtual Docker repository
• Retagging the "hello-world" image, and the pushing it into your virtual Docker repository

The Artifactory Docker registry is already configured with a virtual repository calleddocker.artifactory.

• Pull the "hello-world" image

  docker pull hello-world

• Login to repository "docker.artifactory"

  docker login docker.artifactory

• Tag the "hello-world" image

  docker tag hello-world docker.artifactory/hello-world

• Push the tagged "hello-world" image to docker.artifactory

  docker push docker.artifactory/hello-world

Getting Started with Artifactory Pro On-Prem

The Docker client has the following two limitations:

1. You cannot use a context path when providing the registry path (e.glocalhost:8081/artifactoryis not valid)
2. Docker will only send basic HTTP authentication when working against an HTTPS host

Artifactory offers solutions to these limitations allowing you to create and use any number of Docker registries.

• Using a reverse proxy
  When used, a reverse proxy, maps Docker commands to one of the multiple Docker registries in Artifactory
• Without a reverse proxy
  From version 5.8, Artifactory supports using Docker without the use of a reverse proxy allowing you to create and use multiple Docker registries in Artifactory out-of-the-box.

Using a Reverse Proxy

With the ports method, a port number is mapped to each Artifactory Docker registry. While this is an easy way to get started, you will need to modify your reverse proxy configuration and add a new mapping for each new Docker registry you define in Artifactory. In addition, firewalls and other restrictions by your IT department may restrict port numbers making the ports method not feasible.

With the subdomain method, you only need to configure your reverse proxy once, and from then on, the mapping from Docker commands to Docker registries in Artifactory is dynamic and requires no further modification of your reverse proxy configuration.

We recommend to use the subdomain method since it will require one time effort.

The Subdomain Method

Getting started with Docker and your on-prem Artifactory Pro installation using the subdomain method involves four basic steps:

1. Configuring Artifactory

2. Configuring your reverse proxy

3. Configuring your Docker client

4. Testing your setup

Configuring Artifactory

To configure Artifactory and your reverse proxy using the subdomain method, carry out the following steps:

1. Make sure Artifactory isup and running, and isactivated with a valid license.
2. Create yourvirtual Docker repository(as well as a local and remote Docker repository that it should aggregate). In our example below we will use a repository nameddocker-virtual.
3. Make sure you have a reverse proxy server up and running.

4. Obtain awildcardSSL certificate or use a wildcard self-signed certificate. ( To create a self-signed certificate, you can followthese instructions for Ubuntu).
   

   Make sure your certificate matches theArtifactory hostnameused in your reverse proxy configuration. In our example below we will useart.local.

Configuring your reverse proxy

Artifactory's can generate your complete reverse proxy configuration file for supported servers.

Go toReverse Proxy Configuration Generatorand fill in the fields in according to how your reverse proxy is set up while making sure to:

1. Use the correctArtifactory hostnamein thePublic Server Namefield (in our example this will beart.local)
2. SelectSubdomainas theReverse Proxy Methodunder码头工人反向代理设置
   

NGINX
Copy the code snippet generated by theconfiguration generatorinto yourartifactory-nginx.conffile, and place it in your/etc/nginx/sites-availabledirectory.
Create the following symbolic link.

sudo ln -s /etc/nginx/sites-available/artifactory-nginx.conf /etc/nginx/sites-enabled/artifactory-nginx.conf

Apache HTTPD

Copy the code snippet generated by theconfiguration generatorinto yourartifactory-apache.conffile and place it in you/etc/apache2/sites-availabledirectory.

Create the following symbolic link:

sudo ln -s /etc/apache2/sites-available/artifactory-apache.conf /etc/apache2/sites-enabled/artifactory-apache.conf

Configuring Your Docker Client

To configure your Docker client, carry out the following steps

1. Add the following to your DNS or to the client's/etc/hostsfile:

    docker-virtual.art.local

2. Since the certificate is self-signed, you need to import it to your Docker certificate trust store as described in theDocker documentation. Alternatively, you can configure the Docker client to work with an insecure registry as described in theDocker documentation.

3. Restart your Docker daemon/engine to apply the insecure registry flag (if self-signed certificate is imported, you do not need to restart the Docker daemon/engine).

Test Your Setup

curl -I -k -v https:///api/system/ping

// Make sure the following results in return code 200 curl -I -k -v https:///api/system/ping

// Pull the "hello-world" image docker pull hello-world // Login to repository docker-virtual docker login art-local:5001 // Tag the "hello-world" image docker tag hello-world art-local:5001/hello-world // Push the tagged "hello-world" image to docker-virtual docker push art-local:5001/hello-world

curl - i - k - v http://10.1.16.114:8081/artifactory/api/system/ping