Installation and Configuration Guide

There are two possibilities when installing Harbor.

• Online installer: The online installer downloads the Harbor images from Docker hub. For this reason, the installer is very small in size.

• Offline installer: Use the offline installer if the host to which are are deploying Harbor does not have a connection to the Internet. The offline installer contains pre-built images so it is larger than the online installer.

You download the installers from the official release page.

This guide describes how to install and configure Harbor by using either the online or offline installer. The installation processes are almost the same.

If you are upgrading from a previous version of Harbor, you might need to update the configuration file and migrate your data to fit the database schema of the later version. For information about upgrading, see the Harbor Upgrade and Migration Guide.

In addition, the Harbor community created instructions describing how to deploy Harbor on Kubernetes. If you want to deploy Harbor to Kubernetes, see Harbor on Kubernetes.

Harbor Components

The table below lists the components that are deployed when you deploy Harbor.

Deployment Prerequisites for the Target Host

Harbor is deployed as several Docker containers. You can therefore deploy it on any Linux distribution that supports Docker. The target host requires Docker, and Docker Compose to be installed.

Hardware

The following table lists the minimum and recommended hardware configurations for deploying Harbor.

Software

The following table lists the software versions that must be installed on the target host.

Network ports

Harbor requires that the following ports be open on the target host.

Installation Procedure

The installation procedure involves the following steps:

1. Download the installer.
2. Configure the harbor.yml file.
3. Run the install.sh script with the appropriate options to install and start Harbor.

Download the Installer

1. Go to the Harbor releases page.

2. Select either the online or offline installer for the version you want to install.

3. Use tar to extract the installer package:

   • Online installer:

     bash $ tar xvf harbor-online-installer-version.tgz

   • Offline installer:

     bash $ tar xvf harbor-offline-installer-version.tgz

Configure Harbor

You set system level parameters for Harbor in the harbor.yml file that is contained in the installer package. These parameters take effect when you run the install.sh script to install or reconfigure Harbor.

After the initial deployment and after you have started Harbor, you perform additional configuration in the Harbor Web Portal.

Required Parameters

The table below lists the parameters that must be set when you deploy Harbor. By default, all of the required parameters are uncommented in the harbor.yml file. The optional parameters are commented with #. You do not necessarily need to change the values of the required parameters from the defaults that are provided, but these parameters must remain uncommented. At the very least, you must update the hostname parameter.

IMPORTANT: Harbor does not ship with any certificates. In versions up to and including 1.9.x, by default Harbor uses HTTP to serve registry requests. This is acceptable only in air-gapped test or development environments. In production environments, always use HTTPS. If you enable Content Trust with Notary to properly sign all images, you must use HTTPS.

You can use certificates that are signed by a trusted third-party CA, or you can use self-signed certificates. For information about how to create a CA, and how to use a CA to sign a server certificate and a client certificate, see Configuring Harbor with HTTPS Access.

Optional parameters

The following table lists the additional, optional parameters that you can set to configure your Harbor deployment beyond the minimum required settings. To enable a setting, you must uncomment it in harbor.yml by deleting the leading # character.

Configuring a Storage Backend

By default Harbor uses local storage for the registry, but you can optionally configure the storage_service setting so that Harbor uses external storage. For information about how to configure the storage backend of a registry for different storage providers, see the Registry Configuration Reference in the Docker documentation. For example, if you use Openstack Swift as your storage backend, the parameters might resemble the following:

storage_service:
  ca_bundle:
  swift:
    username: admin
    password: ADMIN_PASS
    authurl: http://keystone_addr:35357/v3/auth
    tenant: admin
    domain: default
    region: regionOne
    container: docker_images"
  redirect:
    disable: false

Installating and starting Harbor

Once you have configured harbor.yml optionally set up a storage backend, you install and start Harbor by using the install.sh script. Note that it might take some time for the online installer to download all of the `Harbor images from Docker hub.

You can install Harbor in different configurations:

• Just Harbor, without Notary, Clair, or Chart Repository Service
• Harbor with Notary
• Harbor with Clair
• Harbor with Chart Repository Service
• Harbor with two or all three of Notary, Clair, and Chart Repository Service

Default installation without Notary, Clair, or Chart Repository Service

The default Harbor installation does not include Notary or Clair service.

    $ sudo ./install.sh

If the installation succeeds, you can open a browser to visit the Harbor Portal at http://reg.yourdomain.com, changing reg.yourdomain.com to the hostname that you configured in harbor.yml. If you did not change them, the default administrator username and password are admin and Harbor12345.

Log in to the admin portal and create a new project, for example, myproject. You can then use docker commands to log in and push images to Harbor. By default, the registry server listens on port 80:

$ docker login reg.yourdomain.com
$ docker push reg.yourdomain.com/myproject/myrepo:mytag

IMPORTANT: If your installation of Harbor uses HTTP, you must add the option --insecure-registry to your client's Docker daemon and restart the Docker service.

Installation with Notary

To install Harbor with the Notary service, add the --with-notary parameter when you run install.sh:

    $ sudo ./install.sh --with-notary

Note: For installation with Notary, you must use Harbor with HTTPS.

For more information about Notary and Docker Content Trust, see Content Trust in the Docker documentation.

Installation with Clair

To install Harbor with Clair service, add the --with-clair parameter when you run install.sh:

    $ sudo ./install.sh --with-clair

For more information about Clair, see the Clair documentation.

Installation with Chart Repository Service

To install Harbor with chart repository service, add the --with-chartmuseum parameter when you run install.sh:

    $ sudo ./install.sh --with-chartmuseum

Installation with Notary, Clair, and Chart Repository Service

If you want to install all three of Notary, Clair and chart repository service, you must specify all of the parameters in the same command:

    $ sudo ./install.sh --with-notary --with-clair --with-chartmuseum

Using Harbor

For information on how to use Harbor, see the Harbor User Guide .

Managing Harbor Lifecycle

You can use docker-compose to manage the lifecycle of Harbor. Some useful commands are listed below. You must run the commands in the same directory as docker-compose.yml.

Stop Harbor:

$ sudo docker-compose stop
Stopping nginx              ... done
Stopping harbor-portal      ... done
Stopping harbor-jobservice  ... done
Stopping harbor-core        ... done
Stopping registry           ... done
Stopping redis              ... done
Stopping registryctl        ... done
Stopping harbor-db          ... done
Stopping harbor-log         ... done

Restart Harbor after Stopping:

$ sudo docker-compose start
Starting log         ... done
Starting registry    ... done
Starting registryctl ... done
Starting postgresql  ... done
Starting core        ... done
Starting portal      ... done
Starting redis       ... done
Starting jobservice  ... done
Starting proxy       ... done

Reconfigure Harbor

To reconfigure Harbor, stop the existing Harbor instance and update harbor.yml. Then run prepare script to populate the configuration. Finally re-create and start the Harbor instance.

$ sudo docker-compose down -v
$ vim harbor.yml
$ sudo prepare
$ sudo docker-compose up -d

Other Commands

Remove Harbor's containers while keeping the image data and Harbor's database files on the file system:

$ sudo docker-compose down -v

Remove Harbor's database and image data for a clean re-installation:

$ rm -r /data/database
$ rm -r /data/registry

Managing the Harbor Lifecycle with Notary, Clair and Chart Repository Service

If you want to install Notary, Clair and chart repository service together, you should include all the components in the prepare commands:

$ sudo docker-compose down -v
$ vim harbor.yml
$ sudo prepare --with-notary --with-clair --with-chartmuseum
$ sudo docker-compose up -d

Please check the Docker Compose command-line reference for more on docker-compose.

Persistent Data and Log Files

By default, registry data is persisted in the host's /data/ directory. This data remains unchanged even when Harbor's containers are removed and/or recreated. You can edit the data_volume in harbor.yml file to change this directory.

In addition, Harbor uses rsyslog to collect the logs for each container. By default, these log files are stored in the directory /var/log/harbor/ on the target host. You can change the log directory in harbor.yml.

Configuring Harbor to Listen on a Customized Port

By default, Harbor listens on port 443(HTTPS) and 80(HTTP, if configured) for both Harbor portal and Docker commands. You can reconfigure the default ports in harbor.yml

Configure Harbor with an External Database

Currently, Harbor only supports PostgreSQL database. To user an external database, uncomment the external_database section in harbor.yml and fill the necessary information. You must create four databases for Harbor core, Clair, Notary server, and Notary signer. And the tables are generated automatically when Harbor starts up.

Manage User Settings

User settings are handled separately system settings. All user settings are configured in the Harbor portal or by HTTP requests at the command line. For information about using HTTP requests to configure user settings, see Configure User Settings at the Command Line to config user settings.

Performance Tuning

By default, Harbor limits the CPU usage of the Clair container to 150000 to avoid it using up all CPU resources. This is defined in the docker-compose.clair.yml file. You can modify this file based on your hardware configuration.

Troubleshooting

Harbor Doesn't Start or Functions Incorrectly

When Harbor does not function correctly, run the following commands to find out if all of Harbor's containers in UP status:

    $ sudo docker-compose ps
        Name                     Command               State                    Ports
  -----------------------------------------------------------------------------------------------------------------------------
  harbor-core         /harbor/start.sh                 Up
  harbor-db           /entrypoint.sh postgres          Up      5432/tcp
  harbor-jobservice   /harbor/start.sh                 Up
  harbor-log          /bin/sh -c /usr/local/bin/ ...   Up      127.0.0.1:1514->10514/tcp
  harbor-portal       nginx -g daemon off;             Up      80/tcp
  nginx               nginx -g daemon off;             Up      0.0.0.0:443->443/tcp, 0.0.0.0:4443->4443/tcp, 0.0.0.0:80->80/tcp
  redis               docker-entrypoint.sh redis ...   Up      6379/tcp
  registry            /entrypoint.sh /etc/regist ...   Up      5000/tcp
  registryctl         /harbor/start.sh                 Up

If a container is not in the Up state, check the log file for that container in /var/log/harbor. For example, if the harbor-core container is not running, look at the core.log log file.

Using nginx or Load Balancing

When setting up Harbor behind an nginx proxy or elastic load balancing, look for the following line in common/config/nginx/nginx.conf and, if the proxy already has similar settings, remove it from the sections location /, location /v2/ and location /service/.

proxy_set_header X-Forwarded-Proto $scheme;

Then re-deploy Harbor per the instructions in "Managing Harbor Lifecycle.