Upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor.git synced 2024-11-18 00:05:12 +01:00
Code Issues Projects Releases Wiki Activity
fcdb212cb0
harbor/docs/installation_guide.md
Henry Zhang 2b0cf6a5e0 update install and user guide
2016-11-10 17:19:35 +08:00

16 KiB
Raw Blame History

Installation and Configuration Guide

Harbor can be installed by one of three approaches:

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

  • Offline installer: Use this installer when the host does not have an Internet connection. The installer contains pre-built images so its size is larger.

  • Virtual Appliance: If you are installing Harbor as the registry component of vSphere Integrated Containers (VIC), or using Harbor as a standalone registry on vSphere platform, download the OVA version of Harbor.

All installers can be downloaded from the official release page.

To install Harbor's virtual appliance, refer to the Harbor Installation Guide for Virtual Appliance.

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

If you run a previous version of Harbor, you may need to migrate the data to fit the new database schema. For more details, please refer to Data Migration Guide.

In addition, the deployment instructions on Kubernetes has been created by the community. Refer to set up Harbor on Kubernetes for details.

Prerequisites for the target host

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

  • Python should be version 2.7 or higher. Note that you may have to install Python on Linux distributions (Gentoo, Arch) that do not come with a Python interpreter installed by default
  • Docker engine should be version 1.10 or higher. For installation instructions, please refer to: https://docs.docker.com/engine/installation/
  • Docker Compose needs to be version 1.6.0 or higher. For installation instructions, please refer to: https://docs.docker.com/compose/install/

Installation Steps

The installation steps boil down to the following

  1. Download the installer;
  2. Configure harbor.cfg;
  3. Run install.sh to install and start Harbor;

Downloading the installer:

The binary of the installer can be downloaded from the release page. Choose either online or offline installer. Use tar command to extract the package.

Online installer:

    $ tar xvf harbor-online-installer-<version>.tgz

Offline installer:

    $ tar xvf harbor-offline-installer-<version>.tgz

Configuring Harbor

Configuration parameters are located in the file harbor.cfg. The parameters are described below - note that at the very least, you will need to change the hostname attribute.

  • hostname: The target host's hostname, which is used to access the UI and the registry service. It should be the IP address or the fully qualified domain name (FQDN) of your target machine, e.g., 192.168.1.10 or reg.yourdomain.com. Do NOT use localhost or 127.0.0.1 for the hostname - the registry service needs to be accessible by external clients!

  • ui_url_protocol: (http or https. Default is http) The protocol used to access the UI and the token/notification service. By default, this is http. To set up the https protocol, refer to Configuring Harbor with HTTPS Access.

  • Email settings: These parameters are needed for Harbor to be able to send a user a "password reset" email, and are only necessary if that functionality is needed. Also, do note that by default SSL connectivity is not enabled - if your SMTP server requires SSL, but does not support STARTTLS, then you should enable SSL by setting email_ssl = true.

  • harbor_admin_password: The administrator's initial password. This password only takes effect for the first time Harbor launches. After that, this setting is ignored and the administrator's password should be set in the UI. Note that the default username/password are admin/Harbor12345 .

  • auth_mode: The type of authentication that is used. By default, it is db_auth, i.e. the credentials are stored in a database. For LDAP authentication, set this to ldap_auth.

  • ldap_url: The LDAP endpoint URL (e.g. ldaps://ldap.mydomain.com). Only used when auth_mode is set to ldap_auth .

  • ldap_searchdn: The DN of a user who has the permission to search an LDAP/AD server (e.g. uid=admin,ou=people,dc=mydomain,dc=com).

  • ldap_search_pwd: The password of the user specified by ldap_searchdn.

  • ldap_basedn: The base DN to look up a user, e.g. ou=people,dc=mydomain,dc=com. Only used when auth_mode is set to ldap_auth .

  • ldap_filter:The search filter for looking up a user, e.g. (objectClass=person).

  • ldap_uid: The attribute used to match a user during a LDAP search, it could be uid, cn, email or other attributes.

  • ldap_scope: The scope to search for a user, 1-LDAP_SCOPE_BASE, 2-LDAP_SCOPE_ONELEVEL, 3-LDAP_SCOPE_SUBTREE. Default is 3.

  • db_password: The root password for the MySQL database used for db_auth. Change this password for any production use!

  • self_registration: (on or off. Default is on) Enable / Disable the ability for a user to register themselves. When disabled, new users can only be created by the Admin user, only an admin user can create new users in Harbor. NOTE: When auth_mode is set to ldap_auth, self-registration feature is always disabled, and this flag is ignored.

  • use_compressed_js: (on or off. Default is on) For production use, turn this flag to on. In development mode, set it to off so that js files can be modified separately.

  • max_job_workers: (default value is 3) The maximum number of replication workers in job service. For each image replication job, a worker synchronizes all tags of a repository to the remote destination. Increasing this number allows more concurrent replication jobs in the system. However, since each worker consumes a certain amount of network/CPU/IO resources, please carefully pick the value of this attribute based on the hardware resource of the host.

  • secret_key: The key to encrypt or decrypt the password of a remote registry in a replication policy, its length has to be 16 characters. Change this key before any production use. NOTE: After changing this key, previously encrypted password of a policy can not be decrypted.

  • token_expiration: The expiration time (in minutes) of a token created by token service, default is 30 minutes.

  • verify_remote_cert: (on or off. Default is on) This flag determines whether or not to verify SSL/TLS certificate when Harbor communicates with a remote registry instance. Setting this attribute to off bypasses the SSL/TLS verification, which is often used when the remote instance has a self-signed or untrusted certificate.

  • customize_crt: (on or off. Default is on) When this attribute is on, the prepare script creates private key and root certificate for the generation/verification of the registry's token.

  • The following attributes:crt_country, crt_state, crt_location, crt_organization, crt_organizationalunit, crt_commonname, crt_email are used as parameters for generating the keys. Set this attribute to off when the key and root certificate are supplied by external sources. Refer to Customize Key and Certificate of Harbor Token Service for more info.

Configuring storage backend (optional)

By default, Harbor stores images on your local filesystem. In a production environment, you may consider using other storage backend instead of the local filesystem, like S3, Openstack Swift, Ceph, etc. What you need to update is the section of storage in the file templates/registry/config.yml. For example, if you use Openstack Swift as your storage backend, the section may look like this:

storage:
  swift:
    username: admin
    password: ADMIN_PASS
    authurl: http://keystone_addr:35357/v3/auth
    tenant: admin
    domain: default
    region: regionOne
    container: docker_images

NOTE: For detailed information on storage backend of a registry, refer to Registry Configuration Reference .

Finishing installation and starting Harbor

Once harbord.cfg and storage backend (optional) are configured, install and start Harbor using the install.sh script. Note that it may take some time for the online installer to download Harbor images from Docker hub.

    $ sudo ./install.sh

If everything worked properly, you should be able to open a browser to visit the admin portal at http://reg.yourdomain.com (change reg.yourdomain.com to the hostname configured in your harbor.cfg). Note that the default administrator username/password are admin/Harbor12345 .

Log in to the admin portal and create a new project, e.g. myproject. You can then use docker commands to login and push images (By default, the registry server listens on port 80):

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

IMPORTANT: The default installation of Harbor uses HTTP - as such, you will need to add the option --insecure-registry to your client's Docker daemon and restart the Docker service.

For information on how to use Harbor, please refer to User Guide of Harbor .

Configuring Harbor with HTTPS access

Harbor does not ship with any certificates, and, by default, uses HTTP to serve requests. While this makes it relatively simple to set up and run - especially for a development or testing environment - it is not recommended for a production environment. To enable HTTPS, please refer to Configuring Harbor with HTTPS Access.

Managing Harbor's lifecycle

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

Stopping Harbor:

$ sudo docker-compose stop
Stopping nginx ... done
Stopping harbor-jobservice ... done
Stopping harbor-ui ... done
Stopping harbor-db ... done
Stopping registry ... done
Stopping harbor-log ... done

Restarting Harbor after stopping:

$ sudo docker-compose start
Starting log ... done
Starting ui ... done
Starting mysql ... done
Starting jobservice ... done
Starting registry ... done
Starting proxy ... done

To change Harbor's configuration, first stop existing Harbor instance, update harbor.cfg, and then run install.sh again:

$ sudo docker-compose down

$ vim harbor.cfg

$ sudo install.sh

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

$ sudo docker-compose rm
Going to remove nginx, harbor-jobservice, registry, harbor-ui, harbor-db, harbor-log
Are you sure? [yN] y
Removing nginx ... done
Removing harbor-jobservice ... done
Removing registry ... done
Removing harbor-ui ... done
Removing harbor-db ... done
Removing harbor-log ... done

Removing Harbor's database and image data (for a clean re-installation):

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

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 target host's /data/ directory. This data remains unchanged even when Harbor's containers are removed and/or recreated.

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

Configuring Harbor listening on a customized port

By default, Harbor listens on port 80(HTTP) and 443(HTTPS, if configured) for both admin portal and docker commands, you can configure it with a customized one.

For HTTP protocol

1.Modify docker-compose.yml
Replace the first "80" to a customized port, e.g. 8888:80.

proxy:
    image: library/nginx:1.11.5
    restart: always
    volumes:
      - ./config/nginx:/etc/nginx
    ports:
      - 8888:80
      - 443:443
    depends_on:
      - mysql
      - registry
      - ui
      - log
    logging:
      driver: "syslog"
      options:  
        syslog-address: "tcp://127.0.0.1:1514"
        tag: "proxy"

2.Modify templates/registry/config.yml
Add the customized port, e.g. ":8888", after "$ui_url".

auth:
  token:
    issuer: registry-token-issuer
    realm: $ui_url:8888/service/token
    rootcertbundle: /etc/registry/root.crt
    service: token-service

3.Run install.sh to update and start Harbor.

$ sudo docker-compose down
$ sudo install.sh

For HTTPS protocol

1.Enable HTTPS in Harbor by following this guide.
2.Modify docker-compose.yml
Replace the first "443" to a customized port, e.g. 4443:443.

proxy:
    image: library/nginx:1.11.5
    restart: always
    volumes:
      - ./config/nginx:/etc/nginx
    ports:
      - 80:80
      - 4443:443
    depends_on:
      - mysql
      - registry
      - ui
      - log
    logging:
      driver: "syslog"
      options:  
        syslog-address: "tcp://127.0.0.1:1514"
        tag: "proxy"

3.Modify templates/registry/config.yml
Add the customized port, e.g. ":4443", after "$ui_url".

auth:
  token:
    issuer: registry-token-issuer
    realm: $ui_url:4443/service/token
    rootcertbundle: /etc/registry/root.crt
    service: token-service

4.Run install.sh to update and start Harbor.

$ sudo docker-compose down
$ sudo install.sh

Troubleshooting

  1. When Harbor does not work properly, run the below commands to find out if all containers of Harbor are in UP status:
    $ sudo docker-compose ps
        Name                     Command               State                    Ports                   
  -----------------------------------------------------------------------------------------------------
  harbor-db           docker-entrypoint.sh mysqld      Up      3306/tcp                                 
  harbor-jobservice   /harbor/harbor_jobservice        Up                                               
  harbor-log          /bin/sh -c crond && rsyslo ...   Up      0.0.0.0:1514->514/tcp                    
  harbor-ui           /harbor/harbor_ui                Up                                               
  nginx               nginx -g daemon off;             Up      0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp 
  registry            /entrypoint.sh serve /etc/ ...   Up      5000/tcp

If a container is not in UP state, check the log file of that container in directory /var/log/harbor. For example, if the container harbor_ui_1 is not running, you should look at the log file docker_ui.log.

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

proxy_set_header X-Forwarded-Proto $scheme;