Pulling and Pushing Images in the Docker Client

Harbor optionally supports HTTP connections, however the Docker client always attempts to connect to registries by first using HTTPS. If Harbor is configured for HTTP, you must configure your Docker client so that it can connect to insecure registries. In your Docker client is not configured for insecure registries, you will see the following error when you attempt to pull or push images to Harbor:

Error response from daemon: Get https://myregistrydomain.com/v1/users/: dial tcp myregistrydomain.com:443 getsockopt: connection refused.

For information about how to add insecure registries to your Docker client, see Connecting to Harbor via HTTP.

You also see this error if Harbor uses HTTPS with an unknown CA certificate. In this case, obtain the registry’s CA certificate, and copy it to /etc/docker/certs.d/myregistrydomain.com/ca.crt.

Harbor only supports the Registry V2 API. You must use Docker client 1.6.0 or higher when pushing and pulling images.

Pulling Images

If the project that the image belongs to is private, you must sign in first:

docker login <harbor_address>

You can now pull an image:

docker pull <harbor_address>/library/ubuntu:14.04
You cannot pull an unsigned image if you have enabled content trust.

Pushing Images

Before you can push an image to Harbor, you must create a corresponding project in the Harbor interface. For information about how to create a project, see Create Projects.

To push Windows images to your Harbor instance, you also must set your docker daemon to allow-nondistributable-artifacts. For more information see Pushing Windows Images.

You cannot push images to a proxy cache project. See more about proxy cache projects.

First, log in from Docker client:

docker login <harbor_address>

Tag the image:

docker tag ubuntu:14.04 <harbor_address>/demo/ubuntu:14.04

Push the image:

docker push <harbor_address>/demo/ubuntu:14.04

Pushing Windows Images

If you plan to push Windows images to your Harbor instance, you must configure your docker daemon to allow pushing restricted artifacts by setting allow-nondistributable-artifacts in your daemon.json file.

"allow-nondistributable-artifacts" : ["myregistrydomain.com:5000"]

For more information on the allow-nondistributable-artifacts setting, see Docker’s documentation.

Add Descriptions to Repositories

After pushing an image, the project administrator can add information to describe the repository.

Go into the repository and select the Info tab, and click the Edit button. Enter a description and click Save to save the description.

edit info

Download the Harbor Certificate

Users can click the Registry Certificate button to download the registry certificate.

browse project

Deleting Repositories

Deleting repositories involves two steps.

First, you delete a repository in the Harbor interface. This is soft deletion. You can delete the entire repository or just one of its tags. After the soft deletion, the repository is no longer managed by Harbor, however, the repository files remain in the Harbor storage.

browse project
browse project

If both tag A and tag B refer to the same image, after deleting tag A, B will also get deleted. if you enabled content trust, you need to use notary command line tool to delete the tag’s signature before you delete an image.

Next, delete the repository files by running garbage collection in the Harbor interface.

Pulling Images from Harbor in Kubernetes

Kubernetes users can easily deploy pods with images stored in Harbor. The settings are similar to those of any other private registry. There are two issues to be aware of:

  1. When your Harbor instance is hosting HTTP and the certificate is self-signed, you must modify daemon.json on each work node of your cluster. For information, see https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry.
  2. If your pod references an image under a private project, you must create a secret with the credentials of a user who has permission to pull images from the project. For information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/.

Configure Notary Content Trust

Make sure that https is enabled in harbor.yml and the attributes ssl_cert and ssl_cert_key point to valid certificates. For more information about generating a HTTPS certificate, see Configure HTTPS Access to Harbor.

Copy the Root Certificate

If Harbor instance is hosted at, ff you are using a self-signed certificate, copy the Harbor CA root cert to /etc/docker/certs.d/ and ~/.docker/tls/ on the machine on which you run the Docker client.

Enable Docker Content Trust

You can enable content trust by setting the following environment variables on the machine on which you run the Docker client.


Set Alias for Notary (optional)

By default the local directory for storing meta files for the Notary client is different from the one for the Docker client. To simplify the use of the Notary client to manipulate the keys/meta files that are generated by Docker content trust, you can set an alias.

alias notary="notary -s -d ~/.docker/trust --tlscacert /etc/docker/certs.d/"

Lost Notary Keys

In the event that your Notary root key is deleted without backups, you can resolve orphaned images using the following steps.

  1. Remove data from the notarysigner and notaryserver database. Replace the fully qualified URI of your repository in the SQL commands below.

    docker exec -it harbor-db /bin/bash
    postgres [ / ]$ psql
    postgres=# \c notaryserver
    notaryserver=# delete from tuf_files where gun='<fully_qualified_URI_of_repository>';
    notaryserver=# \c notarysigner
    notarysigner=# delete from private_keys where gun='<fully_qualified_URI_of_repository>';
    notarysigner=# \q
  2. Restart harbor-core to clear some temporary cache.

    docker restart harbor-core