From 74d68b6bd5dcd662721b6df69e1613723b819b95 Mon Sep 17 00:00:00 2001 From: Stuart Clements Date: Mon, 13 Jan 2020 11:19:50 +0100 Subject: [PATCH] Replaced old doc content with links to new docs --- .../administration/upgrade/upgradetest.md | 44 + docs/1.10/index.md | 2 +- docs/README.md | 44 +- docs/compile_guide.md | 177 +- docs/configure_https.md | 193 +-- docs/configure_swagger.md | 70 +- docs/configure_user_settings.md | 111 +- docs/customize_look&feel_guide.md | 37 +- docs/customize_token_service.md | 59 +- docs/demo_server.md | 20 +- docs/developer_guide_i18n.md | 57 +- docs/harbor_compatibility_list.md | 48 +- docs/import_vulnerability_data.md | 68 +- docs/installation_guide.md | 645 +------- docs/kubernetes_deployment.md | 4 +- docs/manage_role_by_ldap_group.md | 13 +- docs/migration_guide.md | 105 +- docs/permissions.md | 57 +- docs/registry_landscape.md | 31 +- docs/ui_contribution_get_started.md | 93 +- docs/upgradetest.md | 45 +- docs/use_make.md | 49 +- docs/use_notary.md | 27 +- docs/user_guide.md | 1421 +---------------- 24 files changed, 97 insertions(+), 3323 deletions(-) create mode 100644 docs/1.10/administration/upgrade/upgradetest.md diff --git a/docs/1.10/administration/upgrade/upgradetest.md b/docs/1.10/administration/upgrade/upgradetest.md new file mode 100644 index 000000000..5a6e0175b --- /dev/null +++ b/docs/1.10/administration/upgrade/upgradetest.md @@ -0,0 +1,44 @@ +This guide is for Harbor upgrade test +======= + +# Before upgrade + +## Prepare data +1. Add user usera userb userc userd usere, set usera userb as system admin. +2. Create project projecta projectc as private, create projectb as public. +3. Add usera as projecta's admin, userc as developer, and userd as guest. Do the same to projectb and projectc. +4. Login harbor as usera, push an unsigned image into projecta, then push a signed image to projecta. +5. Login harbor as userc, push an unsigned image into projecta, then push a signed image to projeca. +6. Login harbor as userd, push each image one time. +7. Repeat 4 5 6 to projectb and projectc. +8. Add one endpoint to harbor. +9. Add an immediate replication rule to projeca, a schedule rule to projectb, a manual rule to projectc, trigger each rule one time. +10. Add 5 system label syslabel1 to syslabel5 and tag syslabel1 and syslabel2 to all unsigned image. +11. In each project add 5 project label projlabela to projlabele, add projlabela projlabelb and projlabelc to signed image. +12. Trigger one scan all job to scan all images.(For clair enabled instance) +13. Update project publicly, content trust, severity and scanning settings. +14. Update Harbor email, token expire read only and scan settings. +15. Update repository info. +**NOTE**: Create user step is not needed if auth mode is LDAP. + +# Upgrade + +## Follow the upgrade guide +1. Run db migrator image to backup database. +2. Run db migrator image to migrate database. +3. Install new version harbor. + +# After upgrade + +1. Confirm users are exist and available(No need for VIC and LDAP Mode). +2. Confirm users have the correct role. +3. Confirm labels are existing and labeled correct.(No need for VIC) +4. Confirm notary signature correct. +5. Confirm endpoint exist. +6. Confirm replication rule exist and works well. +7. Confirm project level settings(publicly, content trust, scan) same as before. +8. Confirm system level settings(email token expire scan) same as before. +9. Confirm scan result the same as before upgrade. +10. Confirm access log the same as before upgrade. +11. Confirm repository info the same as before. +12. Confirm other image metadata(e.g. author, size) the same as before. diff --git a/docs/1.10/index.md b/docs/1.10/index.md index 573ca3e88..1b721898b 100644 --- a/docs/1.10/index.md +++ b/docs/1.10/index.md @@ -1,6 +1,6 @@ # Harbor Documentation -This is the main table of contents for the Harbor documentation. +This is the main table of contents for the Harbor 1.10.x documentation. ## Harbor Installation and Configuration diff --git a/docs/README.md b/docs/README.md index cec4cae51..334c97f53 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,46 +1,22 @@ -## Table of Content +# Table of Contents -### User documents +## User and Developer Documentation -**[Installation and Configuration Guide](installation_guide.md) -Read this first!** -Guide for Harbor online installer and offline installer. +The Harbor user and developer documentation has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -**[Harbor User Guide](user_guide.md)** -How to use Harbor to manage images, projects, replications and users. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. -[Configuring HTTPS for Harbor](configure_https.md) -Configure security connection between Harbor and Docker client. +See also the [Harbor Architecture Overview](https://github.com/vmware/harbor/wiki/Architecture-Overview-of-Harbor) -[Upgrade and Data Migration Guide](migration_guide.md) -Data migration may be needed when upgrading Harbor to a newer version. +## Articles from the community -[Deploy Harbor on Kubernetes](kubernetes_deployment.md) -Guide to deploy Harbor on Kubernetes. (maintained by community) +[Python SDK](../contrib/registryapi) -### Developer documents +[Harbor CLI](https://github.com/int32bit/harborclient) -[Architecture Overview of Harbor](https://github.com/vmware/harbor/wiki/Architecture-Overview-of-Harbor) -Developers read this first. +[Deploy Harbor using Docker Machine](../contrib/deploying_using_docker_machine.md) -[Build Harbor from Source](compile_guide.md) -How to build Harbor from source code. - -[Harbor API Specs by Swagger](configure_swagger.md) -Use Swagger to find out the specs of Harbor API. - -[Internationalization Guide](developer_guide_i18n.md) -How to add your local language to Harbor. - -[Python SDK](../contrib/registryapi) (by community) - -[Harbor CLI](https://github.com/int32bit/harborclient) (by community) - -[Deploy Harbor using Docker Machine](../contrib/deploying_using_docker_machine.md) ( by community) - -[Configuring Harbor as a local registry mirror](../contrib/Configure_mirror.md) (by community) - -### Articles from the community +[Configuring Harbor as a local registry mirror](../contrib/Configure_mirror.md) [Remote site replicated Docker Registries with VMware Harbor](http://www.vmtocloud.com/remote-site-replicated-docker-registries-with-vmware-harbor/) diff --git a/docs/compile_guide.md b/docs/compile_guide.md index f85ce8a32..6bb81a849 100644 --- a/docs/compile_guide.md +++ b/docs/compile_guide.md @@ -1,178 +1,5 @@ ## Introduction -This guide provides instructions for developers to build and run Harbor from source code. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -## Step 1: Prepare for a build environment for Harbor - -Harbor is deployed as several Docker containers and most of the code is written in Go language. The build environment requires Docker, Docker Compose and golang development environment. Please install the below prerequisites: - -| Software | Required Version | -| -------------- | ---------------- | -| docker | 17.05 + | -| docker-compose | 1.18.0 + | -| python | 2.7 + | -| git | 1.9.1 + | -| make | 3.81 + | -| golang\* | 1.7.3 + | - -\*optional, required only if you use your own Golang environment. - -## Step 2: Getting the source code - -```sh - $ git clone https://github.com/goharbor/harbor -``` - -## Step 3: Building and installing Harbor - -### Configuration - -Edit the file **make/harbor.yml** and make necessary configuration changes such as hostname, admin password and mail server. Refer to **[Installation and Configuration Guide](installation_guide.md#configuring-harbor)** for more info. - -```sh - $ cd harbor - $ vi make/harbor.yml -``` - -### Compiling and Running - -You can compile the code by one of the three approaches: - -#### I. Build with official Golang image - -- Get official Golang image from docker hub: - - ```sh - $ docker pull golang:1.13.4 - ``` - -- Build, install and bring up Harbor without Notary: - - ```sh - $ make install GOBUILDIMAGE=golang:1.13.4 COMPILETAG=compile_golangimage - ``` - -- Build, install and bring up Harbor with Notary: - - ```sh - $ make install GOBUILDIMAGE=golang:1.13.4 COMPILETAG=compile_golangimage NOTARYFLAG=true - ``` - -- Build, install and bring up Harbor with Clair: - - ```sh - $ make install GOBUILDIMAGE=golang:1.13.4 COMPILETAG=compile_golangimage CLAIRFLAG=true - ``` - -#### II. Compile code with your own Golang environment, then build Harbor - -- Move source code to \$GOPATH - - ```sh - $ mkdir $GOPATH/src/github.com/goharbor/ - $ cd .. - $ mv harbor $GOPATH/src/github.com/goharbor/. - ``` - -- Build, install and run Harbor without Notary and Clair: - - ```sh - $ cd $GOPATH/src/github.com/goharbor/harbor - $ make install - ``` - -- Build, install and run Harbor with Notary and Clair: - - ```sh - $ cd $GOPATH/src/github.com/goharbor/harbor - $ make install -e NOTARYFLAG=true CLAIRFLAG=true - ``` - -### Verify your installation - -If everything worked properly, you can get the below message: - -```sh - ... - Start complete. You can visit harbor now. -``` - -Refer to [Installation and Configuration Guide](installation_guide.md#managing-harbors-lifecycle) for more information about managing your Harbor instance. - -## Appendix - -- Using the Makefile - -The `Makefile` contains these configurable parameters: - -| Variable | Description | -| ------------------- | ---------------------------------------------------------------- | -| BASEIMAGE | Container base image, default: photon | -| DEVFLAG | Build model flag, default: dev | -| COMPILETAG | Compile model flag, default: compile_normal (local golang build) | -| NOTARYFLAG | Notary mode flag, default: false | -| CLAIRFLAG | Clair mode flag, default: false | -| HTTPPROXY | NPM http proxy for Clarity UI builder | -| REGISTRYSERVER | Remote registry server IP address | -| REGISTRYUSER | Remote registry server user name | -| REGISTRYPASSWORD | Remote registry server user password | -| REGISTRYPROJECTNAME | Project name on remote registry server | -| VERSIONTAG | Harbor images tag, default: dev | -| PKGVERSIONTAG | Harbor online and offline version tag, default:dev | - -- Predefined targets: - -| Target | Description | -| ---------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| all | prepare env, compile binaries, build images and install images | -| prepare | prepare env | -| compile | compile ui and jobservice code | -| compile_portal | compile portal code | -| compile_ui | compile ui binary | -| compile_jobservice | compile jobservice binary | -| build | build Harbor docker images (default: using build_photon) | -| build_photon | build Harbor docker images from Photon OS base image | -| install | compile binaries, build images, prepare specific version of compose file and startup Harbor instance | -| start | startup Harbor instance (set NOTARYFLAG=true when with Notary) | -| down | shutdown Harbor instance (set NOTARYFLAG=true when with Notary) | -| package_online | prepare online install package | -| package_offline | prepare offline install package | -| pushimage | push Harbor images to specific registry server | -| clean all | remove binary, Harbor images, specific version docker-compose file, specific version tag and online/offline install package | -| cleanbinary | remove ui and jobservice binary | -| cleanimage | remove Harbor images | -| cleandockercomposefile | remove specific version docker-compose | -| cleanversiontag | remove specific version tag | -| cleanpackage | remove online/offline install package | - -#### EXAMPLE: - -#### Push Harbor images to specific registry server - -```sh - $ make pushimage -e DEVFLAG=false REGISTRYSERVER=[$SERVERADDRESS] REGISTRYUSER=[$USERNAME] REGISTRYPASSWORD=[$PASSWORD] REGISTRYPROJECTNAME=[$PROJECTNAME] - -``` - -**Note**: need add "/" on end of REGISTRYSERVER. If REGISTRYSERVER is not set, images will be pushed directly to Docker Hub. - -```sh - $ make pushimage -e DEVFLAG=false REGISTRYUSER=[$USERNAME] REGISTRYPASSWORD=[$PASSWORD] REGISTRYPROJECTNAME=[$PROJECTNAME] - -``` - -#### Clean up binaries and images of a specific version - -```sh - $ make clean -e VERSIONTAG=[TAG] - -``` - -**Note**: If new code had been added to Github, the git commit TAG will change. Better use this command to clean up images and files of previous TAG. - -#### By default, the make process create a development build. To create a release build of Harbor, set the below flag to false. - -```sh - $ make XXXX -e DEVFLAG=false - -``` +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/configure_https.md b/docs/configure_https.md index 2487d8be2..2bd4ea8b3 100644 --- a/docs/configure_https.md +++ b/docs/configure_https.md @@ -1,194 +1,5 @@ # Configuring Harbor with HTTPS Access -In versions up to and including 1.9.x, by default Harbor uses HTTP to serve registry requests. However, using HTTP is acceptable only in air-gapped test or development environments that do not have a connection to the external internet. Using HTTP in environments that are not air-gapped exposes you to man-in-the-middle attacks. In production environments, always use HTTPS. If you enable Content Trust with Notary to properly sign all images, you must use HTTPS. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -Harbor uses an `nginx` instance as a reverse proxy for all services. You use the `prepare` script to configure `nginx` to enable HTTPS. - -You can use certificates that are signed by a trusted third-party CA, or you can use self-signed certificates. The following sections describe how to create a CA, and how to use your CA to sign a server certificate and a client certificate. - -## Getting Certificate Authority - -``` - openssl genrsa -out ca.key 4096 -``` -``` - openssl req -x509 -new -nodes -sha512 -days 3650 \ - -subj "/C=CN/ST=Beijing/L=Beijing/O=example/OU=Personal/CN=yourdomain.com" \ - -key ca.key \ - -out ca.crt -``` - -## Getting Server Certificate - -Assuming that your registry's **hostname** is **yourdomain.com**, and that its DNS record points to the host where you are running Harbor. In production environment, you first should get a certificate from a CA. In a test or development environment, you can use your own CA. The certificate usually contains a .crt file and a .key file, for example, **yourdomain.com.crt** and **yourdomain.com.key**. - - - -**1) Create your own Private Key:** - -``` - openssl genrsa -out yourdomain.com.key 4096 -``` - -**2) Generate a Certificate Signing Request:** - -If you use FQDN like **yourdomain.com** to connect your registry host, then you must use **yourdomain.com** as CN (Common Name). - -``` - openssl req -sha512 -new \ - -subj "/C=CN/ST=Beijing/L=Beijing/O=example/OU=Personal/CN=yourdomain.com" \ - -key yourdomain.com.key \ - -out yourdomain.com.csr -``` - -**3) Generate the certificate of your registry host:** - -Whether you're using FQDN like **yourdomain.com** or IP to connect your registry host, run this command to generate the certificate of your registry host which comply with Subject Alternative Name (SAN) and x509 v3 extension requirement: - -**v3.ext** - -``` -cat > v3.ext <<-EOF -authorityKeyIdentifier=keyid,issuer -basicConstraints=CA:FALSE -keyUsage = digitalSignature, nonRepudiation, keyEncipherment, dataEncipherment -extendedKeyUsage = serverAuth -subjectAltName = @alt_names - -[alt_names] -DNS.1=yourdomain.com -DNS.2=yourdomain -DNS.3=hostname -EOF -``` - -``` - - openssl x509 -req -sha512 -days 3650 \ - -extfile v3.ext \ - -CA ca.crt -CAkey ca.key -CAcreateserial \ - -in yourdomain.com.csr \ - -out yourdomain.com.crt -``` - -## Configuration and Installation - -**1) Configure Server Certificate and Key for Harbor** - -After obtaining the **yourdomain.com.crt** and **yourdomain.com.key** files, -you can put them into directory such as ```/root/cert/```: - -``` - cp yourdomain.com.crt /data/cert/ - cp yourdomain.com.key /data/cert/ -``` - -**2) Configure Server Certificate, Key and CA for Docker** - -The Docker daemon interprets ```.crt``` files as CA certificates and ```.cert``` files as client certificates. - -Convert server ```yourdomain.com.crt``` to ```yourdomain.com.cert```: - -``` -openssl x509 -inform PEM -in yourdomain.com.crt -out yourdomain.com.cert -``` -Delpoy ```yourdomain.com.cert```, ```yourdomain.com.key```, and ```ca.crt``` for Docker: - -``` - cp yourdomain.com.cert /etc/docker/certs.d/yourdomain.com/ - cp yourdomain.com.key /etc/docker/certs.d/yourdomain.com/ - cp ca.crt /etc/docker/certs.d/yourdomain.com/ -``` - -The following illustrates a configuration with custom certificates: - - -``` -/etc/docker/certs.d/ - └── yourdomain.com:port - ├── yourdomain.com.cert <-- Server certificate signed by CA - ├── yourdomain.com.key <-- Server key signed by CA - └── ca.crt <-- Certificate authority that signed the registry certificate -``` - -Notice that you may need to trust the certificate at OS level. Please refer to the [Troubleshooting](#Troubleshooting) section below. - -**3) Configure Harbor** - -Edit the file `harbor.yml`, update the hostname and uncomment the https block, and update the attributes `certificate` and `private_key`: - -```yaml -#set hostname -hostname: yourdomain.com - -http: - port: 80 - -https: - # https port for harbor, default is 443 - port: 443 - # The path of cert and key files for nginx - certificate: /data/cert/yourdomain.com.crt - private_key: /data/cert/yourdomain.com.key - - ...... - -``` - -Generate configuration files for Harbor: - -``` - ./prepare -``` - -If Harbor is already running, stop and remove the existing instance. Your image data remain in the file system - -``` - docker-compose down -v -``` -Finally, restart Harbor: - -``` - docker-compose up -d -``` -After setting up HTTPS for Harbor, you can verify it by the following steps: - -* Open a browser and enter the address: https://yourdomain.com. It should display the user interface of Harbor. - -* Notice that some browser may still shows the warning regarding Certificate Authority (CA) unknown for security reason even though we signed certificates by self-signed CA and deploy the CA to the place mentioned above. It is because self-signed CA essentially is not a trusted third-party CA. You can import the CA to the browser on your own to solve the warning. - -* On a machine with Docker daemon, make sure the option "-insecure-registry" for https://yourdomain.com is not present. - -* If you mapped nginx port 443 to another port, then you should instead create the directory ```/etc/docker/certs.d/yourdomain.com:port``` (or your registry host IP:port). Then run any docker command to verify the setup, e.g. - - -``` - docker login yourdomain.com -``` -If you've mapped nginx 443 port to another, you need to add the port to login, like below: - -``` - docker login yourdomain.com:port -``` - - -## Troubleshooting -1. You may get an intermediate certificate from a certificate issuer. In this case, you should merge the intermediate certificate with your own certificate to create a certificate bundle. You can achieve this by the below command: - - ``` - cat intermediate-certificate.pem >> yourdomain.com.crt - ``` -2. On some systems where docker daemon runs, you may need to trust the certificate at OS level. - On Ubuntu, this can be done by below commands: - - ```sh - cp yourdomain.com.crt /usr/local/share/ca-certificates/yourdomain.com.crt - update-ca-certificates - ``` - - On Red Hat (CentOS etc), the commands are: - - ```sh - cp yourdomain.com.crt /etc/pki/ca-trust/source/anchors/yourdomain.com.crt - update-ca-trust - ``` +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/configure_swagger.md b/docs/configure_swagger.md index c062ad24f..ea821c59e 100644 --- a/docs/configure_swagger.md +++ b/docs/configure_swagger.md @@ -1,71 +1,5 @@ # View and test Harbor REST API via Swagger -A Swagger file is provided for viewing and testing Harbor REST API. -### Viewing Harbor REST API -* Open the file **swagger.yaml** under the _docs_ directory in Harbor project; -* Paste all its content into the online Swagger Editor at http://editor.swagger.io. The descriptions of Harbor API will be shown on the right pane of the page. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -![Swagger Editor](img/swaggerEditor.png) - -### Testing Harbor REST API -From time to time, you may need to mannually test Harbor REST API. You can deploy the Swagger file into Harbor's service node. Suppose you install Harbor through online or offline installer, you should have a Harbor directory after you un-tar the installer, such as **~/harbor**. - -**Caution:** When using Swagger to send REST requests to Harbor, you may alter the data of Harbor accidentally. For this reason, it is NOT recommended using Swagger against a production Harbor instance. - -* Download _prepare-swagger.sh_ and _swagger.yaml_ under the _docs_ directory to your local Harbor directory, e.g. **~/harbor**. -```sh - wget https://raw.githubusercontent.com/goharbor/harbor/master/docs/prepare-swagger.sh https://raw.githubusercontent.com/goharbor/harbor/master/api/harbor/swagger.yaml -``` -* Edit the script file _prepare-swagger.sh_. -```sh - vi prepare-swagger.sh -``` -* Change the SCHEME to the protocol scheme of your Harbor server. -```sh - SCHEME= -``` -* Change the SERVER_IP to the IP address of your Harbor server. -```sh - SERVER_IP= -``` -* Change the file mode. -```sh - chmod +x prepare-swagger.sh -```` -* Run the shell script. It downloads a Swagger package and extracts files into the _../static_ directory. -```sh - ./prepare-swagger.sh -``` -* Edit the _docker-compose.yml_ file under your local Harbor directory. -```sh - vi docker-compose.yml -``` -* Add two lines to the file _docker-compose.yml_ under the section _ui.volumes_. -```docker -... -ui: - ... - volumes: - - ./common/config/ui/app.conf:/etc/core/app.conf:z - - ./common/config/ui/private_key.pem:/etc/core/private_key.pem:z - - /data/secretkey:/etc/core/key:z - - /data/ca_download/:/etc/core/ca/:z - ## add two lines as below ## - - ../src/ui/static/vendors/swagger-ui-2.1.4/dist:/harbor/static/vendors/swagger - - ../src/ui/static/resources/yaml/swagger.yaml:/harbor/static/resources/yaml/swagger.yaml - ... -``` -* Recreate Harbor containers -```docker - docker-compose down -v && docker-compose up -d -``` - -* Because a session ID is usually required by Harbor API, **you should log in first from a browser.** -* Open another tab in the same browser so that the session is shared between tabs. -* Enter the URL of the Swagger page in Harbor as below. The `````` should be replaced by the IP address or the hostname of the Harbor server. -``` - http:///static/vendors/swagger/index.html -``` -* You should see a Swagger UI page with Harbor API _swagger.yaml_ file loaded in the same domain, **be aware that your REST request submitted by Swagger may change the data of Harbor**. - -![Harbor API](img/renderedSwagger.png) +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/configure_user_settings.md b/docs/configure_user_settings.md index 4894ee9ff..0fb5f3aef 100644 --- a/docs/configure_user_settings.md +++ b/docs/configure_user_settings.md @@ -1,112 +1,5 @@ # Config Harbor user settings by command line -After release 1.8.0, all user settings are separated from system settings, it can not be configured in config file anymore. Users need to configure it with admin privileges in web console or via HTTP request. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -`curl -X PUT -u ":" -H "Content-Type: application/json" -ki /api/configurations -d'{"":""}'` - -Get current configurations - -`curl -u ":" -H "Content-Type: application/json" -ki /api/configurations` - -## Sample config commands: - -1. Update Harbor to use LDAP auth - - Command - ```shell - curl -X PUT -u ":" -H "Content-Type: application/json" -ki https://harbor.sample.domain/api/configurations -d'{"auth_mode":"ldap_auth"}' - ``` - Output - ``` - HTTP/1.1 200 OK - Server: nginx - Date: Wed, 08 May 2019 08:22:02 GMT - Content-Type: text/plain; charset=utf-8 - Content-Length: 0 - Connection: keep-alive - Set-Cookie: sid=a5803a1265e2b095cf65ce1d8bbd79b1; Path=/; HttpOnly - ``` - -1. Restrict project creation to admin only - - Command - ```shell - curl -X PUT -u ":" -H "Content-Type: application/json" -ki https://harbor.sample.domain/api/configurations -d'{"project_creation_restriction":"adminonly"}' - ``` - - Output - ``` - HTTP/1.1 200 OK - Server: nginx - Date: Wed, 08 May 2019 08:24:32 GMT - Content-Type: text/plain; charset=utf-8 - Content-Length: 0 - Connection: keep-alive - Set-Cookie: sid=b7925eaf7af53bdefb13bdcae201a14a; Path=/; HttpOnly - ``` - -1. Update the token expiration time - - Command - ```shell - curl -X PUT -u ":" -H "Content-Type: application/json" -ki https://harbor.sample.domain/api/configurations -d'{"token_expiration":"300"}' - ``` - - Output - ``` - HTTP/1.1 200 OK - Server: nginx - Date: Wed, 08 May 2019 08:23:38 GMT - Content-Type: text/plain; charset=utf-8 - Content-Length: 0 - Connection: keep-alive - Set-Cookie: sid=cc1bc93ffa2675253fc62b4bf3d9de0e; Path=/; HttpOnly - ``` - -## Harbor user settings - -| Configure item name | Description | Type | Required | Default Value | -| ------------ |------------ | ---- | ----- | ----- | -auth_mode | Authentication mode, it can be db_auth, ldap_auth, uaa_auth or oidc_auth | string -email_from | Email from | string | required (email feature) -email_host | Email server | string | required (email feature) -email_identity | Email identity | string | optional (email feature) -email_password | Email password | string | required (email feature) -email_insecure | Email verify certificate, true or false |boolean | optional (email feature) | false -email_port | Email server port | number | required (email feature) -email_ssl | Email SSL | boolean | optional | false -email_username | Email username | string | required (email feature) -ldap_url | LDAP URL | string | required | -ldap_base_dn | LDAP base DN | string | required(ldap_auth) -ldap_filter | LDAP filter | string | optional -ldap_scope | LDAP search scope, 0-Base Level, 1- One Level, 2-Sub Tree | number | optional | 2-Sub Tree -ldap_search_dn | LDAP DN to search LDAP users| string | required(ldap_auth) -ldap_search_password | LDAP DN's password |string | required(ldap_auth) -ldap_timeout | LDAP connection timeout | number | optional | 5 -ldap_uid | LDAP attribute to indicate the username in Harbor | string | optional | cn -ldap_verify_cert | Verify cert when create SSL connection with LDAP server, true or false | boolean | optional | true -ldap_group_admin_dn | LDAP Group Admin DN | string | optional -ldap_group_attribute_name | LDAP Group Attribute, the LDAP attribute indicate the groupname in Harbor, it can be gid or cn | string | optional | cn -ldap_group_base_dn | The Base DN which to search the LDAP groups | string | required(ldap_auth and LDAP group) -ldap_group_search_filter | The filter to search LDAP groups | string | optional -ldap_group_search_scope | LDAP group search scope, 0-Base Level, 1- One Level, 2-Sub Tree | number | optional | 2-Sub Tree| -ldap_group_membership_attribute | LDAP group membership attribute, to indicate the group membership, it can be memberof, or ismemberof | string | optional | memberof -project_creation_restriction | The option to indicate user can be create object, it can be everyone, adminonly | string | optional | everyone -read_only | The option to set repository read only, it can be true or false | boolean | optional | false -self_registration | User can register account in Harbor, it can be true or false | boolean | optional| true -token_expiration | Security token expirtation time in minutes | number |optional| 30 -uaa_client_id | UAA client ID | string | required(uaa_auth) -uaa_client_secret | UAA certificate | string | required(uaa_auth) -uaa_endpoint | UAA endpoint | string | required(uaa_auth) -uaa_verify_cert | UAA verify cert, true or false | boolean | optional | true -oidc_name | name for OIDC authentication | string | required(oidc_auth) -oidc_endpoint | endpoint for OIDC auth | string | required(oidc_auth) -oidc_client_id | client id for OIDC auth | string | required(oidc_auth) -oidc_client_secret | client secret for OIDC auth |string | required(oidc_auth) -oidc_scope | scope for OIDC auth | string| required(oidc_auth) -oidc_verify_cert | verify cert for OIDC auth, true or false | boolean | optional| true -robot_token_duration | Robot token expiration time in minutes | number | optional | 43200 (30days) - - - -**Note:** Both boolean and number can be enclosed with double quote in the request json, for example: `123`, `"123"`, `"true"` or `true` is OK. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/customize_look&feel_guide.md b/docs/customize_look&feel_guide.md index bc967b6d0..ae7339536 100644 --- a/docs/customize_look&feel_guide.md +++ b/docs/customize_look&feel_guide.md @@ -1,38 +1,5 @@ # Customize the look & feel of Harbor -The primary look & feel of Harbor supports to be customized with several simple steps. All the relevant customization in configurations are saved in the `setting.json` file under `$HARBOR_DIR/src/portal/src` folder with `json` format and will be loaded when Harbor is launched. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -## Configure -Open the `setting.json` file, you'll see the default content as shown below: - -``` -{ - "headerBgColor": "#004a70", - "headerLogo": "", - "loginBgImg": "", - "appTitle": "", - "product": { - "name": "Harbor", - "introduction": { - "zh-cn": "", - "es-es": "", - "en-us": "" - } - } -} -``` - -Change the values of configuration if you want to override the default style to your own. Here are references: - -* **headerBgColor**: Background color of the page header, support either HEX or RGB value. e.g: `#004a70` and `rgb(210,110,235)`. -* **headerLogo**: Name path of the logo image in the header, e.g: 'logo.png'. The image file should be put in the `images` folder. -* **loginBgImg**: Name path of the background image displayed in the login page, e.g: 'login_bg.png'. The image file should be put in the `images` folder. Suggest the size of this image should be bigger than 800px*600px. -* **Product**: Contain metadata / description of the product. - - **title**: The full product title displayed in the login page. - - **company**: Name of the company publishing the product. - - **name**: Name of the product. - - **introductions**: The introduction about the product with different languages, which are displayed in the `About` dialog. - -## Build - -Once the `setting.json` configurations has been updated, re-[build](#configure) your product to apply the new changes. \ No newline at end of file +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/customize_token_service.md b/docs/customize_token_service.md index 6d3400bc9..d3aaaaaaa 100644 --- a/docs/customize_token_service.md +++ b/docs/customize_token_service.md @@ -1,60 +1,5 @@ # Customize Harbor token service with your key and certificate -Harbor requires Docker client to access the Harbor registry with a token. The procedure to generate a token is like [Docker Registry v2 authentication](https://github.com/docker/distribution/blob/master/docs/spec/auth/token.md). Firstly, you should make a request to the token service for a token. The token is signed by the private key. After that, you make a new request with the token to the Harbor registry, Harbor registry will verify the token with the public key in the rootcert bundle. Then Harbor registry will authorize the Docker client to push/pull images. - -By default, Harbor uses default private key and certificate in authentication. Also, you can customize your configuration with your own key and certificate with the following steps: - -1.If you already have a certificate, go to step 3. - -2.If not, you can generate a root certificate using openSSL with following commands: - -**1)Generate a private key:** - -```sh - $ openssl genrsa -out private_key.pem 4096 -``` - -**2)Generate a certificate:** -```sh - $ openssl req -new -x509 -key private_key.pem -out root.crt -days 3650 -``` -You are about to be asked to enter information that will be incorporated into your certificate request. -What you are about to enter is what is called a Distinguished Name or a DN. -There are quite a few fields but you can leave some blank -For some fields there will be a default value, -If you enter '.', the field will be left blank. Following are what you're asked to enter. - -Country Name (2 letter code) [AU]: - -State or Province Name (full name) [Some-State]: - -Locality Name (eg, city) []: - -Organization Name (eg, company) [Internet Widgits Pty Ltd]: - -Organizational Unit Name (eg, section) []: - -Common Name (eg, server FQDN or YOUR name) []: - -Email Address []: - -After you execute these two commands, you will see private_key.pem and root.crt in the **current directory**, just type "ls", you'll see them. - -3.Refer to [Installation Guide](https://github.com/goharbor/harbor/blob/master/docs/installation_guide.md) to install Harbor, After you execute ./prepare, Harbor generates several config files. We need to replace the original private key and certificate with your own key and certificate. - -4.Replace the default key and certificate. Assume that you key and certificate are in the directory /root/cert, following are what you should do: - -``` -$ cd config/ui -$ cp /root/cert/private_key.pem private_key.pem -$ cp /root/cert/root.crt ../registry/root.crt -``` - -5.After these, go back to the make directory, you can start Harbor using following command: -``` - $ docker-compose up -d -``` - -6.Then you can push/pull images to see if your own certificate works. Please refer [User Guide](https://github.com/goharbor/harbor/blob/master/docs/user_guide.md) for more info. - +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/demo_server.md b/docs/demo_server.md index 3fb523ce6..01d97f2f8 100644 --- a/docs/demo_server.md +++ b/docs/demo_server.md @@ -1,21 +1,5 @@ # Demo Server Guide -**Important!** - - Please note that this demo server is **ONLY** to be used for experimenting with Harbor functionality. - - Please **DO NOT** upload any sensitive images to this server. - - This is **NOT** a production environment and we are not responsible for any loss of data, functionality, or service. - - We will **CLEAN AND RESET** the server every **couple of days**. - - You can only experience the non-admin functionalities on this server. Please follow the **[Installation Guide](installation_guide.md)** to set up a Harbor server to try the more advanced features. - - Please do not push large images (>100MB) as the server has limited storage. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -If you encounter any problems during using the demo server, please open an issue or ping us on [Slack](https://github.com/goharbor/harbor#community). - -**Usage** - - - The address of the demo server is [https://demo.goharbor.io](https://demo.goharbor.io) - - You can register as a new user - - Then you can use the account/password created in step 2 to log in - ``` - docker login demo.goharbor.io - ``` -You can refer to the [User Guide](user_guide.md) for more details on how to use Harbor. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/developer_guide_i18n.md b/docs/developer_guide_i18n.md index 96fb8744c..8f6854f17 100644 --- a/docs/developer_guide_i18n.md +++ b/docs/developer_guide_i18n.md @@ -1,58 +1,5 @@ ## Developer's Guide for Internationalization (i18n) -*NOTE: All the files you created should use UTF-8 encoding.* +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -### Steps to localize the UI in your language - -1. In the folder `src/portal/src/i18n/lang`, copy json file `en-us-lang.json` to a new file and rename it to `--lang.json` . - - The file contains a JSON object including all the key-value pairs of UI strings: - ``` - { - "APP_TITLE": { - "VMW_HARBOR": "Harbor", - "HARBOR": "Harbor", - ... - }, - ... - } - ``` - In the file `--lang.json`, translate all the values into your language. Do not change any keys. - -2. After creating your language file, you should add it to the language supporting list. - - Locate the file `src/portal/src/app/shared/shared.const.ts`. - Append `-` to the language supporting list: - ``` - export const supportedLangs = ['en-us', 'zh-cn', '-']; - ``` - Define the language display name and append it to the name list: - ``` - export const languageNames = { - "en-us": "English", - "zh-cn": "中文简体", - "-": "" - }; - ``` - - **NOTE: Don't miss the comma before the new key-value item you've added.** - -3. Enable the new language in the view. - - Locate the file `src/portal/src/app/base/navigator/navigator.component.html` and then find the following code piece: - ``` -
- English - 中文简体 -
- ``` - Add new menu item for your language: - ``` -
- English - 中文简体 - DISPLAY_NAME -
- ``` - -4. Next, please refer [compile guideline](compile_guide.md) to rebuild and restart Harbor. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/harbor_compatibility_list.md b/docs/harbor_compatibility_list.md index a0c404d0e..f45110c44 100644 --- a/docs/harbor_compatibility_list.md +++ b/docs/harbor_compatibility_list.md @@ -1,49 +1,5 @@ # Harbor Compatibility List -This document provides compatibility information for all Harbor components. - -## Replication Adapters - -| | Registries | Pull Mode | Push Mode | Introduced in Release | Automated Pipeline Covered | -|-----|------------------|-----------|-----------|-----------------------|---------------------------| -| [Harbor](https://goharbor.io/)| ![Harbor](img/replication_adapters/harbor_logo.png)|![Y](img/replication_adapters/right.png)|![Y](img/replication_adapters/right.png)| V1.8 | Y | -| [distribution](https://github.com/docker/distribution) | ![distribution](img/replication_adapters/distribution.png)|![Y](img/replication_adapters/right.png)|![Y](img/replication_adapters/right.png)| V1.8 | Y | -| [docker hub](https://hub.docker.com/) | ![docker hub](img/replication_adapters/docker_hub.png)|![Y](img/replication_adapters/right.png)|![Y](img/replication_adapters/right.png)| V1.8 | Y | -| [Huawei SWR](https://www.huaweicloud.com/en-us/product/swr.html) | ![Huawei SWR](img/replication_adapters/hw.png)|![Y](img/replication_adapters/right.png)|![Y](img/replication_adapters/right.png)| V1.8 | N | -| [GCR](https://cloud.google.com/container-registry/) | ![GCR](img/replication_adapters/gcr.png)|![Y](img/replication_adapters/right.png)|![Y](img/replication_adapters/right.png)| V1.9 | Y | -| [ECR](https://aws.amazon.com/ecr/) | ![ECR](img/replication_adapters/ecr.png)|![Y](img/replication_adapters/right.png)|![Y](img/replication_adapters/right.png)| V1.9 | Y | -| [ACR](https://azure.microsoft.com/en-us/services/container-registry/) | ![ACR](img/replication_adapters/acr.png)|![Y](img/replication_adapters/right.png)|![Y](img/replication_adapters/right.png)| V1.9 | N | -| [AliCR](https://www.alibabacloud.com/product/container-registry) | ![AliCR](img/replication_adapters/ali-cr.png)|![Y](img/replication_adapters/right.png)|![Y](img/replication_adapters/right.png)| V1.9 | N | -| [Helm Hub](https://hub.helm.sh/) | ![Helm Hub](img/replication_adapters/helm-hub.png)|![Y](img/replication_adapters/right.png)| N/A | V1.9 | N | -| [Artifactory](https://jfrog.com/artifactory/) | ![Artifactory](img/replication_adapters/artifactory.png)|![Y](img/replication_adapters/right.png)| ![Y](img/replication_adapters/right.png) | V1.10 | N | -| [Quay](https://github.com/quay/quay) | ![Quay](img/replication_adapters/quay.png)|![Y](img/replication_adapters/right.png)| ![Y](img/replication_adapters/right.png) | V1.10 | N | -| [GitLab Registry](https://docs.gitlab.com/ee/user/packages/container_registry/) | ![GitLab Registry](img/replication_adapters/gitlab.png)|![Y](img/replication_adapters/right.png)| ![Y](img/replication_adapters/right.png) | V1.10 | N | - -**Notes**: - -* `Pull` mode replicates artifacts from the specified source registries into Harbor. -* `Push` mode replicates artifacts from Harbor to the specified target registries. - -## OIDC Adapters - -| | OIDC Providers | Officially Verified | End User Verified | Verified in Release | -|---|-----------------|---------------------|---------------------|-----------------------| -| [Google Identity](https://developers.google.com/identity/protocols/OpenIDConnect) | ![google identity](img/OIDC/google_identity.png)| ![Y](img/replication_adapters/right.png) | |V1.9| -| [Dex](https://github.com/dexidp/dex) | ![dex](img/OIDC/dex.png) | ![Y](img/replication_adapters/right.png)| | V1.9 | -| [Ping Identity](https://www.pingidentity.com) | ![ping identity](img/OIDC/ping.png) | | ![Y](img/replication_adapters/right.png)| V1.9 | -| [Keycloak](https://www.keycloak.org/) | ![Keycloak](img/OIDC/keycloak.png) | ![Y](img/replication_adapters/right.png) | | V1.10 | -| [Auth0](https://auth0.com/) | ![Auth0](img/OIDC/auth0.png) | ![Y](img/replication_adapters/right.png) | | V1.10 | - -## Scanner Adapters - -| | Scanners | Providers | As Default | Onboard in Release | -|---|----------|-----------|------------|--------------------| -| [Clair](https://github.com/goharbor/harbor-scanner-clair) |![Clair](img/scanners/clair.png)| CentOS |![Y](img/replication_adapters/right.png)| v1.10 | -| [Anchore](https://github.com/anchore/harbor-scanner-adapter) |![Anchore](img/scanners/anchore.png) | Anchore | N | v1.10 | -| [Trivy](https://github.com/aquasecurity/harbor-scanner-trivy)|![Trivy](img/scanners/trivy.png)| Aqua | N | v1.10 | -| [Dosec](https://github.com/dosec-cn/harbor-scanner) |![Dosec](img/scanners/dosec.png)| Dosec | N | v1.10 | - -**Notes:** - -* `As Default` means that the scanner is provided as a default option and can be deployed together with the main Harbor components by providing extra options during installation. You must install other scanners manually. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/import_vulnerability_data.md b/docs/import_vulnerability_data.md index 7179dde83..22e603de8 100644 --- a/docs/import_vulnerability_data.md +++ b/docs/import_vulnerability_data.md @@ -1,69 +1,5 @@ ## Update an offline Harbor instance with new vulnerability data -Harbor has integrated with Clair to scan vulnerabilities in images. When Harbor is installed in an environment without internet connection, Clair cannot fetch data from the public vulnerability database. Under this circumstance, Harbor system administrator needs to manually update the Clair database. - -This document provides step-by-step instructions on updating Clair vulnerability database in Harbor. - -**NOTE:** Harbor does not ship with any vulnerability data. For this reason, if Harbor cannot connect to Internet, the administrator must manually import vulnerability data to Harbor by using instructions given in this document. - -### Preparation - -A. You need to install an instance of Clair with internet connection. If you have another instance of Harbor with internet access, it also works. - -B. Check whether your Clair instance has already updated the vulnerability database to the latest version. If it has not, wait for Clair to get the data from public endpoints. - -- Use command `docker ps` to find out the container id of Clair. - -- Run command `docker logs container_id` to check the log of the Clair container. If you are using Harbor you can find the latest Clair log under /var/log/harbor/2017-xx-xx/clair.log - -- Look for logs that look like the below: - ``` - Jul 3 20:40:45 172.18.0.1 clair[3516]: {"Event":"finished fetching","Level":"info","Location":"updater.go:227","Time":"2017-07-04 03:40:45.890364","updater name":"rhel"} - Jul 3 20:40:46 172.18.0.1 clair[3516]: {"Event":"finished fetching","Level":"info","Location":"updater.go:227","Time":"2017-07-04 03:40:46.768924","updater name":"alpine"} - Jul 3 20:40:47 172.18.0.1 clair[3516]: {"Event":"finished fetching","Level":"info","Location":"updater.go:227","Time":"2017-07-04 03:40:47.190982","updater name":"oracle"} - Jul 3 20:41:07 172.18.0.1 clair[3516]: {"Event":"Debian buster is not mapped to any version number (eg. Jessie-\u003e8). Please update me.","Level":"warning","Location":"debian.go:128","Time":"2017-07-04 03:41:07.833720"} - Jul 3 20:41:07 172.18.0.1 clair[3516]: {"Event":"finished fetching","Level":"info","Location":"updater.go:227","Time":"2017-07-04 03:41:07.833975","updater name":"debian"} - Jul 4 00:26:17 172.18.0.1 clair[3516]: {"Event":"finished fetching","Level":"info","Location":"updater.go:227","Time":"2017-07-04 07:26:17.596986","updater name":"ubuntu"} - Jul 4 00:26:18 172.18.0.1 clair[3516]: {"Event":"adding metadata to vulnerabilities","Level":"info","Location":"updater.go:253","Time":"2017-07-04 07:26:18.060810"} - Jul 4 00:38:05 172.18.0.1 clair[3516]: {"Event":"update finished","Level":"info","Location":"updater.go:198","Time":"2017-07-04 07:38:05.251580"} - ``` -- The phrase "finished fetching" indicates that Clair has finished a round of vulnerability update from an endpoint. Please make sure all five endpoints (rhel, alpine, oracle, debian, ubuntu) are updated correctly. - -## Harbor version < 1.6 - -If you're using a version of Harbor prior to 1.6, you can access the correct instructions for your version using the following URL. -https://github.com/goharbor/harbor/blob/v\/docs/import_vulnerability_data.md - -## Harbor version >= 1.6 - -Databased were consolidated in version 1.6 which moved the clair database to the harbor-db container and removed the clair-db container. - -### Dumping vulnerability data - -- Log in to the host (that is connected to Internet) where Clair database (Postgres) is running. -- Dump Clair's vulnerability database by the following commands, two files (`vulnerability.sql` and `clear.sql`) are generated: - -_NOTE: The container name 'clair-db' is a placeholder for the db container used by the internet connected instance of clair_ - -``` - $ docker exec clair-db /bin/sh -c "pg_dump -U postgres -a -t feature -t keyvalue -t namespace -t schema_migrations -t vulnerability -t vulnerability_fixedin_feature" > vulnerability.sql - $ docker exec clair-db /bin/sh -c "pg_dump -U postgres -c -s" > clear.sql -``` - -### Back up Harbor's Clair database -Before importing the data, it is strongly recommended to back up the Clair database in Harbor. -``` - $ docker exec harbor-db /bin/sh -c "pg_dump -U postgres -c" > all.sql -``` - -### Update Harbor's Clair database -Copy the `vulnerability.sql` and `clear.sql` to the host where Harbor is running on. Run the below commands to import the data to Harbor's Clair database: - -``` - $ docker exec -i harbor-db psql -U postgres < clear.sql - $ docker exec -i harbor-db psql -U postgres < vulnerability.sql -``` - -### Rescanning images -After importing the data, trigger the scanning process in the administrator's web UI: **Administration**->**Configuration**->**Vulnerability**->**SCAN NOW**. Harbor reflects the new changes after the scanning is completed. (Otherwise the summary of the image vulnerabilities will not be displayed correctly.) +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/installation_guide.md b/docs/installation_guide.md index 072c9cbb9..1116473a6 100644 --- a/docs/installation_guide.md +++ b/docs/installation_guide.md @@ -1,646 +1,5 @@ # Harbor Installation and Configuration Guide -There are two possibilities when installing Harbor. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -- **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](https://github.com/goharbor/harbor/releases)** 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](migration_guide.md)**. - -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](kubernetes_deployment.md). - -## Harbor Components - -The table below lists the components that are deployed when you deploy Harbor. - -|Component|Version| -|---|---| -|Postgresql|9.6.10-1.ph2| -|Redis|4.0.10-1.ph2| -|Clair|2.0.8| -|Beego|1.9.0| -|Chartmuseum|0.9.0| -|Docker/distribution|2.7.1| -|Docker/notary|0.6.1| -|Helm|2.9.1| -|Swagger-ui|3.22.1| - -## 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. - -|Resource|Minimum|Recommended| -|---|---|---| -|CPU|2 CPU|4 CPU| -|Mem|4 GB|8 GB| -|Disk|40 GB|160 GB| - -### Software - -The following table lists the software versions that must be installed on the target host. - -|Software|Version|Description| -|---|---|---| -|Docker engine|version 17.06.0-ce+ or higher|For installation instructions, see [docker engine doc](https://docs.docker.com/engine/installation/)| -|Docker Compose|version 1.18.0 or higher|For installation instructions, see [docker compose doc](https://docs.docker.com/compose/install/)| -|Openssl|latest is preferred|Used to generate certificate and keys for Harbor| - -### Network ports - -Harbor requires that the following ports be open on the target host. - -|Port|Protocol|Description| -|---|---|---| -|443|HTTPS|Harbor portal and core API accept HTTPS requests on this port. You can change this port in the configuration file.| -|4443|HTTPS|Connections to the Docker Content Trust service for Harbor. Only required if Notary is enabled. You can change this port in the configuration file.| -|80|HTTP|Harbor portal and core API accept HTTP requests on this port. You can change this port in the configuration file.| - -## 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 and Unpack the Installer - -1. Go to the [Harbor releases page](https://github.com/goharbor/harbor/releases). -1. Download either the online or offline installer for the version you want to install. -1. Optionally download the corresponding `*.asc` file to verify that the package is genuine. - - The `*.asc` file is an OpenPGP key file. Perform the following steps to verify that the downloaded bundle is genuine. - - 1. Obtain the public key for the `*.asc` file. - - 
gpg --keyserver hkps://keyserver.ubuntu.com --receive-keys 644FF454C0B4115C
- - You should see the message ` public key "Harbor-sign (The key for signing Harbor build) " imported` - 1. Verify that the package is genuine by running one of the following commands. - - - Online installer: 
gpg -v --keyserver hkps://keyserver.ubuntu.com --verify harbor-online-installer-version.tgz.asc
- - Offline installer: 
gpg -v --keyserver hkps://keyserver.ubuntu.com --verify harbor-offline-installer-version.tgz.asc
- - The `gpg` command verifies that the signature of the bundle matches that of the `*.asc` key file. You should see confirmation that the signature is correct. - - 
-      gpg: armor header: Version: GnuPG v1
-      gpg: assuming signed data in 'harbor-offline-installer-v1.10.0-rc2.tgz'
-      gpg: Signature made Fri, Dec  6, 2019  5:04:17 AM WEST
-      gpg:                using RSA key 644FF454C0B4115C
-      gpg: using pgp trust model
-      gpg: Good signature from "Harbor-sign (The key for signing Harbor build) <jiangd@vmware.com> [unknown]
-
-1. 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](configure_https.md)**. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Required Parameters for Harbor Deployment -
ParameterSub-parametersDescription and Additional Parameters
hostnameNoneSpecify the IP address or the fully qualified domain name (FQDN) of the target host on which to deploy Harbor. This is the address at which you access the Harbor Portal and the registry service. For example, 192.168.1.10 or reg.yourdomain.com. The registry service must be accessible to external clients, so do not specify localhost, 127.0.0.1, or 0.0.0.0 as the hostname.
https 

Use HTTPS to access the Harbor Portal and the token/notification service. Always use HTTPS in production environments and environments that are not air-gapped.

-
 portThe port number for HTTPS. The default is 443.
 certificateThe path to the SSL certificate.
 private_keyThe path to the SSL key.
harbor_admin_passwordNoneSet an initial password for the Harbor system administrator. This password is only used on the first time that Harbor starts. On subsequent logins, this setting is ignored and the administrator's password is set in the Harbor Portal. The default username and password are admin and Harbor12345.
database Use a local PostgreSQL database. You can optionally configure an external database, in which case you can disable this option.
 passwordSet the root password for the local database. You must change this password for production deployments.
 max_idle_connsThe maximum number of connections in the idle connection pool. If set to <=0 no idle connections are retained. The default value is 50. If it is not configured the value is 2.
 max_open_connsThe maximum number of open connections to the database. If <= 0 there is no limit on the number of open connections. The default value is 100 for the max connections to the Harbor database. If it is not configured the value is 0.
data_volumeNoneThe location on the target host in which to store Harbor's data. You can optionally configure external storage, in which case disable this option and enable storage_service. The default is /data.
clairupdaters_intervalSet an interval for Clair updates, in hours. Set to 0 to disable the updates. The default is 12 hours.
jobservicemax_job_workersThe maximum number of replication workers in the 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, set the value of this attribute based on the hardware resource of the host. The default is 10.
notificationwebhook_job_max_retrySet the maximum number of retries for web hook jobs. The default is 10.
chartabsolute_urlSet to enabled for Chart to use an absolute URL. Set to disabled for Chart to use a relative URL.
log Configure logging.
 levelSet the logging level to debug, info, warning, error, or fatal. The default is info.
 localSet the log retention parameters:
    -
  • rotate_count: Log files are rotated rotate_count times before being removed. If count is 0, old versions are removed rather than rotated. The default is 50.
    • -
  • rotate_size: Log files are rotated only if they grow bigger than rotate_size bytes. Use k for kilobytes, M for megabytes, and G for gigabytes. 100, 100k, 100M and 100G are all valid values. The default is 200M.
    • -
  • location: Set the directory in which to store the logs. The default is /var/log/harbor.
    • -
 external_endpointEnable this option to forward logs to a syslog server. -
    -
  • protocol: Transport protocol for the syslog server. Default is TCP.
    • -
  • host: The URL of the syslog server.
    • -
  • port: The port on which the syslog server listens
    • -
proxy Configure proxies to be used by Clair, the replication jobservice, and Harbor. Leave blank if no proxies are required.
 http_proxyConfigure an HTTP proxy, for example, http://my.proxy.com:3128.
 https_proxyConfigure an HTTPS proxy, for example, http://my.proxy.com:3128.
 no_proxyConfigure when not to use a proxy, for example, 127.0.0.1,localhost,core,registry.
- -### 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Optional Parameters for Harbor -
ParameterSub-ParametersDescription and Additional Parameters
http Do not use HTTP in production environments. Using HTTP is acceptable only in air-gapped test or development environments that do not have a connection to the external internet. Using HTTP in environments that are not air-gapped exposes you to man-in-the-middle attacks.
 portPort number for HTTP
external_urlNoneEnable this option to use an external proxy. When enabled, the hostname is no longer used.
storage_service By default, Harbor stores images and charts on your local filesystem. In a production environment, you might want to use another storage backend instead of the local filesystem. The parameters listed below are the configurations for the registry. See *Configuring Storage Backend* below for more information about how to configure a different backend.
 ca_bundleThe path to the custom root CA certificate, which is injected into the trust store of registry and chart repository containers. This is usually needed if internal storage uses a self signed certificate.
 filesystemThe default is filesystem, but you can set azure, gcs, s3, swift and oss. For information about how to configure other backends, see Configuring a Storage Backend below. Set maxthreads to limit the number of threads to the external provider. The default is 100.
 redirectSet disable to true when you want to disable registry redirect
external_database Configure external database settings, if you disable the local database option. Harbor currently only supports POSTGRES.
 harbor

Configure an external database for Harbor data.

-
    -
  • host: Hostname of the Harbor database.
    • -
  • port: Database port.
    • -
  • db_name: Database name.
    • -
  • username: Username to connect to the core Harbor database.
    • -
  • password: Password for the account you set in username.
    • -
  • ssl_mode: Enable SSL mode.
    • -
  • max_idle_conns: The maximum number of connections in the idle connection pool. If <=0 no idle connections are retained. The default value is 2.
    • -
  • max_open_conns: The maximum number of open connections to the database. If <= 0 there is no limit on the number of open connections. The default value is 0.
    • -
 clairConfigure an external database for Clair. -
    -
  • host: Hostname of the Clair database
    • -
  • port: Database port.
    • -
  • db_name: Database name.
    • -
  • username: Username to connect to the Clair database.
    • -
  • password: Password for the account you set in username.
    • -
  • ssl_mode: Enable SSL mode.
    • -
 notary_signerConfigure an external database for the Notary signer database -
    -
  • host: Hostname of the Notary signer database
    • -
  • port: Database port.
    • -
  • db_name: Database name.
    • -
  • username: Username to connect to the Notary signer database.
    • -
  • password: Password for the account you set in username.
    • -
  • ssl_mode: Enable SSL mode.
    • -
 notary_server
    -
  • host: Hostname of the Notary server database.
    • -
  • port: Database port.
    • -
  • db_name: Database name.
    • -
  • username: Username to connect to the Notary server database.
    • -
  • password: Password for the account you set in username.
    • -
  • ssl_mode: Enable SSL mode.e
    • -
external_redis Configure an external Redis instance.
 hostHostname of the external Redis instance.
 portRedis instance port.
 passwordPassword to connect to the external Redis instance.
 registry_db_indexDatabase index for Harbor registry.
 jobservice_db_indexDatabase index for jobservice.
 chartmuseum_db_indexDatabase index for Chart museum.
- -**NOTE**: The `harbor.yml` file includes options to configure a UAA CA certificate. This authentication mode is not recommended and is not documented. - - -### 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](https://docs.docker.com/registry/configuration/#storage) in the Docker documentation. For example, if you use Openstack Swift as your storage backend, the parameters might resemble the following: - -``` yaml -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 -``` - - -## Installing 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. - -``` sh - $ 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: - -```sh -$ docker login reg.yourdomain.com -$ docker push reg.yourdomain.com/myproject/myrepo:mytag -``` - -### Installation with Notary - -To install Harbor with the Notary service, add the `--with-notary` parameter when you run `install.sh`: - -```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](https://docs.docker.com/engine/security/trust/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`: - -```sh - $ sudo ./install.sh --with-clair -``` - -For more information about Clair, see the [Clair documentation](https://coreos.com/clair/docs/2.0.1/). - -### Installation with Chart Repository Service - -To install Harbor with chart repository service, add the `--with-chartmuseum` parameter when you run ```install.sh```: - -```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: - -```sh - $ sudo ./install.sh --with-notary --with-clair --with-chartmuseum -``` - - -## Connecting to Harbor via HTTP - -**IMPORTANT:** If your installation of Harbor uses HTTP rather than HTTPS, you must add the option `--insecure-registry` to your client's Docker daemon. By default, the daemon file is located at `/etc/docker/daemon.json`. - -For example, add the following to your `daemon.json` file: - -
-{
-"insecure-registries" : ["myregistrydomain.com:5000", "0.0.0.0"]
-}
-
- -After you update `daemon.json`, you must restart both Docker Engine and Harbor. - -1. Restart Docker Engine. - - `systemctl restart docker` -1. Stop Harbor. - - `docker-compose down -v` -1. Restart Harbor. - - `docker-compose up -d` - -## Using Harbor - -For information on how to use Harbor, see the **[Harbor User Guide](user_guide.md)** . - -## 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: - -``` sh -$ 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: - -``` sh -$ 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. - -``` sh -$ 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: - -``` sh -$ sudo docker-compose down -v -``` - -Remove Harbor's database and image data for a clean re-installation: - -``` sh -$ 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: - -``` sh -$ 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](https://docs.docker.com/compose/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](configure_user_settings.md) 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/`. - -``` sh -proxy_set_header X-Forwarded-Proto $scheme; -``` - -Then re-deploy Harbor per the instructions in "Managing Harbor Lifecycle. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/kubernetes_deployment.md b/docs/kubernetes_deployment.md index 18d5ecd14..c19e371a0 100644 --- a/docs/kubernetes_deployment.md +++ b/docs/kubernetes_deployment.md @@ -1,4 +1,4 @@ -Please use [Harbor Helm Chart](https://github.com/goharbor/harbor-helm) to deploy latest Harbor release on Kubernetes. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -**NOTE** Please open issue to the `harbor-helm` repo if you see issues deploying the helm chart. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. diff --git a/docs/manage_role_by_ldap_group.md b/docs/manage_role_by_ldap_group.md index 3f61f03af..9f0f0a617 100644 --- a/docs/manage_role_by_ldap_group.md +++ b/docs/manage_role_by_ldap_group.md @@ -1,12 +1,3 @@ -## Introduction +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -You can import an LDAP/AD group to Harbor and assign project roles to it. All LDAP/AD users in this LDAP/AD group have assigned roles. - -**NOTE**: Information about how to configure LDAP Groups in the Harbor interface has migrated to the [Harbor User Guide](user_guide.md). - -To configure LDAP parameters via the API, see **[Configure Harbor User Settings from the Command Line](configure_user_settings.md)** - -For example: -``` -curl -X PUT -u ":" -H "Content-Type: application/json" -ki https://harbor.sample.domain/api/configurations -d'{"ldap_group_basedn":"ou=groups,dc=example,dc=com"}' -``` +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/migration_guide.md b/docs/migration_guide.md index 711a01105..869e27b2f 100644 --- a/docs/migration_guide.md +++ b/docs/migration_guide.md @@ -1,106 +1,5 @@ # Harbor Upgrade and Migration Guide -This guide covers upgrade and migration to version 1.9.0. This guide only covers migration from v1.7.x and later to the current version. If you are upgrading from an earlier version, refer to the migration guide in the `release-1.7.0` branch to upgrade to v1.7.x first, then follow this guide to perform the migration to this version. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -When upgrading an existing Harbor 1.7.x instance to a newer version, you might need to migrate the data in your database and the settings in `harbor.cfg`. -Since the migration might alter the database schema and the settings of `harbor.cfg`, you should **always** back up your data before any migration. - -**NOTES:** - -- Again, you must back up your data before any data migration. -- Since v1.8.0, the configuration of Harbor has changed to a `.yml` file. If you are upgrading from 1.7.x, the migrator will transform the configuration file from `harbor.cfg` to `harbor.yml`. The command will be a little different to perform this migration, so make sure you follow the steps below. -- In version 1.9.0, some containers are started by `non-root`. This does not pose problems if you are upgrading an officially released version of Harbor, but if you have deployed a customized instance of Harbor, you might encounter permission issues. -- In previous releases, user roles took precedence over group roles in a project. In this version, user roles and group roles are combined so that the user has whichever set of permissions is highest. This might cause the roles of certain users to change during upgrade. -- With the introduction of storage and artifact quotas in version 1.9.0, migration from 1.7.x and 1.8.x might take a few minutes. This is because the `core` walks through all blobs in the registry and populates the database with information about the layers and artifacts in projects. -- With the introduction of storage and artifact quotas in version 1.9.0, replication between version 1.9.0 and a previous version of Harbor does not work. You must upgrade all Harbor nodes to 1.9.0 if you have configured replication between them. - -## Upgrading Harbor and Migrating Data - -1. Log in to the host that Harbor runs on, stop and remove existing Harbor instance if it is still running: - - ```sh - cd harbor - docker-compose down - ``` - -2. Back up Harbor's current files so that you can roll back to the current version if necessary. - - ```sh - mv harbor /my_backup_dir/harbor - ``` - - Back up database (by default in directory `/data/database`) - - ```sh - cp -r /data/database /my_backup_dir/ - ``` - -3. Get the latest Harbor release package from Github: - [https://github.com/goharbor/harbor/releases](https://github.com/goharbor/harbor/releases) - -4. Before upgrading Harbor, perform migration first. The migration tool is delivered as a docker image. - - You can pull the image from docker hub. Replace [tag] with the release version of Harbor (e.g. v1.5.0) in the below command: - ```sh - docker pull goharbor/harbor-migrator:[tag] - ``` - - Alternatively, if you are using an offline installer package you can load it from the image tarball included in the offline installer package. Replace [version] with the release version of Harbor (e.g. v1.5.0) in the below command: - ```sh - tar zxf - docker image load -i harbor/harbor.[version].tar.gz - ``` - -5. If you are current version is v1.7.x or earlier, i.e. migrate config file from `harbor.cfg` to `harbor.yml`. - - **NOTE:** You can find the ${harbor_yml} in the extracted installer you got in step `3`, after the migration the file `harbor.yml` - in that path will be updated with the values from ${harbor_cfg} - - ```sh - docker run -it --rm -v ${harbor_cfg}:/harbor-migration/harbor-cfg/harbor.yml -v ${harbor_yml}:/harbor-migration/harbor-cfg-out/harbor.yml goharbor/harbor-migrator:[tag] --cfg up - ``` - - Otherwise, If your version is 1.8.x or higher, just upgrade the `harbor.yml` file. - - ```sh - docker run -it --rm -v ${harbor_yml}:/harbor-migration/harbor-cfg/harbor.yml goharbor/harbor-migrator:[tag] --cfg up - ``` - - **NOTE:** The schema upgrade and data migration of the database is performed by core when Harbor starts, if the migration fails, please check the log of core to debug. - -6. Under the directory `./harbor`, run the `./install.sh` script to install the new Harbor instance. If you choose to install Harbor with components such as Notary, Clair, and chartmuseum, refer to [Installation & Configuration Guide](../docs/installation_guide.md) for more information. - -## Roll Back from an Upgrade - -If, for any reason, you want to roll back to the previous version of Harbor, perform the following steps: - -1. Stop and remove the current Harbor service if it is still running. - - ```sh - cd harbor - docker-compose down - ``` - -2. Remove current Harbor instance. - - ```sh - rm -rf harbor - ``` - -3. Restore the older version package of Harbor. - - ```sh - mv /my_backup_dir/harbor harbor - ``` - -4. Restore database, copy the data files from backup directory to you data volume, by default `/data/database`. - -5. Restart Harbor service using the previous configuration. - If previous version of Harbor was installed by a release build: - - ```sh - cd harbor - ./install.sh - ``` - -**NOTE**: While you can roll back an upgrade to the state before you started the upgrade, Harbor does not support downgrades. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/permissions.md b/docs/permissions.md index a1f000bb9..f89dadd70 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -1,58 +1,5 @@ # Permissions -Users have different abilities depending on the role they in a project. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -On public projects all users will be able to see the list of repositories, images, image vulnerabilities, helm charts and helm chart versions, pull images, retag images (need push permission for destination image), download helm charts, download helm chart versions. - -System admin have all permissions for the project. - -## Project members permissions - -The following table depicts the various user permission levels in a project. - -| Action | Limited Guest | Guest | Developer | Master | Project Admin | -| --------------------------------------- | ------------- | ----- | --------- | ------ | ------------- | -| See the project configurations | ✓ | ✓ | ✓ | ✓ | ✓ | -| Edit the project configurations | | | | | ✓ | -| See a list of project members | | ✓ | ✓ | ✓ | ✓ | -| Create/edit/delete project members | | | | | ✓ | -| See a list of project logs | | ✓ | ✓ | ✓ | ✓ | -| See a list of project replications | | | | ✓ | ✓ | -| See a list of project replication jobs | | | | | ✓ | -| See a list of project labels | | | | ✓ | ✓ | -| Create/edit/delete project labels | | | | ✓ | ✓ | -| See a list of repositories | ✓ | ✓ | ✓ | ✓ | ✓ | -| Create repositories | | | ✓ | ✓ | ✓ | -| Edit/delete repositories | | | | ✓ | ✓ | -| See a list of images | ✓ | ✓ | ✓ | ✓ | ✓ | -| Retag image | | ✓ | ✓ | ✓ | ✓ | -| Pull image | ✓ | ✓ | ✓ | ✓ | ✓ | -| Push image | | | ✓ | ✓ | ✓ | -| Scan/delete image | | | | ✓ | ✓ | -| Add scanners to Harbor | | | | | | -| Edit scanners in projects | | | | | ✓ | -| See a list of image vulnerabilities | ✓ | ✓ | ✓ | ✓ | ✓ | -| See image build history | ✓ | ✓ | ✓ | ✓ | ✓ | -| Add/Remove labels of image | | | ✓ | ✓ | ✓ | -| See a list of helm charts | ✓ | ✓ | ✓ | ✓ | ✓ | -| Download helm charts | ✓ | ✓ | ✓ | ✓ | ✓ | -| Upload helm charts | | | ✓ | ✓ | ✓ | -| Delete helm charts | | | | ✓ | ✓ | -| See a list of helm chart versions | ✓ | ✓ | ✓ | ✓ | ✓ | -| Download helm chart versions | ✓ | ✓ | ✓ | ✓ | ✓ | -| Upload helm chart versions | | | ✓ | ✓ | ✓ | -| Delete helm chart versions | | | | ✓ | ✓ | -| Add/Remove labels of helm chart version | | | ✓ | ✓ | ✓ | -| See a list of project robots | | | | ✓ | ✓ | -| Create/edit/delete project robots | | | | | ✓ | -| See configured CVE whitelist | ✓ | ✓ | ✓ | ✓ | ✓ | -| Create/edit/remove CVE whitelist | | | | | ✓ | -| Enable/disable webhooks | | | ✓ | ✓ | ✓ | -| Create/delete tag retention rules | | | ✓ | ✓ | ✓ | -| Enable/disable tag retention rules | | | ✓ | ✓ | ✓ | -| Create/delete tag immutability rules | | | | | ✓ | -| Enable/disable tag immutability rules | | | | | ✓ | -| See project quotas | ✓ | ✓ | ✓ | ✓ | ✓ | -| Edit project quotas * | | | | | | - -* Only the Harbor system administrator can edit project quotas and add new scanners. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/registry_landscape.md b/docs/registry_landscape.md index b6bdb9f9d..f4c67ba7f 100644 --- a/docs/registry_landscape.md +++ b/docs/registry_landscape.md @@ -1,32 +1,5 @@ # Registry Landscape -The cloud native ecosystem is moving rapidly–registries and their feature sets are no exception. We've made our best effort to survey the container registry landscape and compare to our core feature set. -If you find something outdated or outright erroneous, please submit a PR and we'll fix it right away. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -Table updated on 10/21/2019 against Harbor 1.9. - -| Feature | Harbor | Docker Trusted Registry | Quay | Cloud Providers (GCP, AWS, Azure) | Docker Distribution | Artifactory | GitLab | -| -------------: | :----: | :---------------------: | :-----: | :-------------------------------: | :-----------------: | :---------: | :------: | -| Ability to Determine Version of Binaries in Containers | ✓ | ✓ | ✓ | ✗ | ✗ | ? | ? | -| Artifact Repository (rpms, git, jar, etc) | ✗ | ✗ | ✗ | ✗ | ✗ | ✓ | partial | -| Audit Logs | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ | ✓ | -| Content Trust and Validation | ✓ | ✓ | ✗ | ✗ | partial | partial | ✗ | -| Custom TLS Certificates | ✓ | ✓ | ✓ | ✗ | ✓ | ✓ | ✓ | -| Helm Chart Repository Manager | ✓ | ✗ | partial | ✗ | ✗ | ✓ | ✗ | -| LDAP-based Auth | ✓ | ✓ | ✓ | partial | ✗ | ✓ | ✓ | -| Local Auth | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ | ✓ | -| Multi-Tenancy (projects, teams, namespaces, etc) | ✓ | ✓ | ✓ | partial | ✗ | ✓ | ✓ | -| Open Source | ✓ | partial | ✗ | ✗ | ✓ | partial | partial | -| Project Quotas (by image count & storage consumption) | ✓ | ✗ | ✗ | partial | ✗ | ✗ | ✗ | -| Replication between instances | ✓ | ✓ | ✓ | n/a | ✗ | ✓ | ✗ | -| Replication between non-instances | ✓ | ✗ | ✓ | n/a | ✗ | ✗ | ✗ | -| Robot Accounts for Helm Charts | ✓ | ✗ | ✗ | ? | ✗ | ✗ | ✗ | -| Robot Accounts for Images | ✓ | ? | ✓ | ? | ✗ | ? | ? | -| Role-Based Access Control | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ | ✗ | -| Single Sign On (OIDC) | ✓ | ✓ | ✓ | ✓ | ✗ | partial | ✗ | -| Tag Retention Policy | ✓ | ✗ | partial | ✗ | ✗ | ✗ | ✗ | -| Upstream Registry Proxy Cache | ✗ | ✓ | ✗ | ✗ | ✓ | ✓ | ✗ | -| Vulnerability Scanning & Monitoring | ✓ | ✓ | ✓ | ✗ | ✗ | ✓ | partial | -| Vulnerability Scanning Plugin Framework | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | -| Vulnerability Whitelisting | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | -| Webhooks | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/ui_contribution_get_started.md b/docs/ui_contribution_get_started.md index 568508d72..d23be2737 100644 --- a/docs/ui_contribution_get_started.md +++ b/docs/ui_contribution_get_started.md @@ -1,94 +1,5 @@ # Harbor frontend environment get started guide -If you already have a harbor backend environment, you can build a frontend development environment with the following configuration. - -1. Create the file proxy.config.json in the directory harbor/src/portal，and config it according to the sample below. - - **NOTE:** You should replace “$IP_ADDRESS” with your own ip address. - - ``` - { - "/api/*": { - "target": "$IP_ADDRESS", - "secure": false, - "changeOrigin": true, - "logLevel": "debug" - }, - "/service/*": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/c/login": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/sign_in": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/c/log_out": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/sendEmail": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/language": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/reset": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/userExists": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/reset_password": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/i18n/lang/*.json": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug", - "pathRewrite": { "^/src$": "" } - }, - "/chartrepo": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - }, - "/*.json": { - "target": "$IP_ADDRESS", - "secure": false, - "logLevel": "debug" - } - } - ``` - -2. Open the terminal and run the following command，install npm packages as 3rd-party dependencies. - ``` - cd harbor/src/portal - npm install - ``` - -3. Execute the following command，serve Harbor locally. - - ``` - npm run start - ``` - -4. Then you can visit the Harbor by address: https://localhost:4200. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/upgradetest.md b/docs/upgradetest.md index 5a6e0175b..9f0f0a617 100644 --- a/docs/upgradetest.md +++ b/docs/upgradetest.md @@ -1,44 +1,3 @@ -This guide is for Harbor upgrade test -======= +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -# Before upgrade - -## Prepare data -1. Add user usera userb userc userd usere, set usera userb as system admin. -2. Create project projecta projectc as private, create projectb as public. -3. Add usera as projecta's admin, userc as developer, and userd as guest. Do the same to projectb and projectc. -4. Login harbor as usera, push an unsigned image into projecta, then push a signed image to projecta. -5. Login harbor as userc, push an unsigned image into projecta, then push a signed image to projeca. -6. Login harbor as userd, push each image one time. -7. Repeat 4 5 6 to projectb and projectc. -8. Add one endpoint to harbor. -9. Add an immediate replication rule to projeca, a schedule rule to projectb, a manual rule to projectc, trigger each rule one time. -10. Add 5 system label syslabel1 to syslabel5 and tag syslabel1 and syslabel2 to all unsigned image. -11. In each project add 5 project label projlabela to projlabele, add projlabela projlabelb and projlabelc to signed image. -12. Trigger one scan all job to scan all images.(For clair enabled instance) -13. Update project publicly, content trust, severity and scanning settings. -14. Update Harbor email, token expire read only and scan settings. -15. Update repository info. -**NOTE**: Create user step is not needed if auth mode is LDAP. - -# Upgrade - -## Follow the upgrade guide -1. Run db migrator image to backup database. -2. Run db migrator image to migrate database. -3. Install new version harbor. - -# After upgrade - -1. Confirm users are exist and available(No need for VIC and LDAP Mode). -2. Confirm users have the correct role. -3. Confirm labels are existing and labeled correct.(No need for VIC) -4. Confirm notary signature correct. -5. Confirm endpoint exist. -6. Confirm replication rule exist and works well. -7. Confirm project level settings(publicly, content trust, scan) same as before. -8. Confirm system level settings(email token expire scan) same as before. -9. Confirm scan result the same as before upgrade. -10. Confirm access log the same as before upgrade. -11. Confirm repository info the same as before. -12. Confirm other image metadata(e.g. author, size) the same as before. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/use_make.md b/docs/use_make.md index ab249d941..9f0f0a617 100644 --- a/docs/use_make.md +++ b/docs/use_make.md @@ -1,48 +1,3 @@ -### Variables -Variable | Description --------------------|------------- -BASEIMAGE | Container base image, default: photon -DEVFLAG | Build model flag, default: dev -COMPILETAG | Compile model flag, default: compile_normal (local golang build) -GOBUILDIMAGE | Golang image to compile harbor go source code. -NOTARYFLAG | Whether to enable notary in harbor, default:false -HTTPPROXY | Clarity proxy to build UI. +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -### Targets -Target | Description ---------------------|------------- -all | prepare env, compile binaries, build images and install images -prepare | prepare env -compile | compile ui and jobservice code -compile_portal | compile portal code -compile_core | compile core binary -compile_jobservice | compile jobservice binary -build | build Harbor docker images (default: using build_photon) -build_photon | build Harbor docker images from Photon OS base image -install | compile binaries, build images, prepare specific version of compose file and startup Harbor instance -start | startup Harbor instance -down | shutdown Harbor instance -package_online | prepare online install package -package_offline | prepare offline install package -pushimage | push Harbor images to specific registry server -clean all | remove binary, Harbor images, specific version docker-compose file, specific version tag and online/offline install package -cleanbinary | remove ui and jobservice binary -cleanimage | remove Harbor images -cleandockercomposefile | remove specific version docker-compose -cleanversiontag | remove specific version tag -cleanpackage | remove online/offline install package -version | set harbor version - -#### EXAMPLE: - -#### Build and run harbor from source code. -make install GOBUILDIMAGE=golang:1.13.4 COMPILETAG=compile_golangimage NOTARYFLAG=true - -### Package offline installer -make package_offline GOBUILDIMAGE=golang:1.13.4 COMPILETAG=compile_golangimage NOTARYFLAG=true - -### Start harbor with notary -make -e NOTARYFLAG=true start - -### Stop harbor with notary -make -e NOTARYFLAG=true down +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/use_notary.md b/docs/use_notary.md index a7030aa0e..9f0f0a617 100644 --- a/docs/use_notary.md +++ b/docs/use_notary.md @@ -1,26 +1,3 @@ -### Setup +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. -In harbor.yml, make sure https is enabled, and the attributes `ssl_cert` and `ssl_cert_key` are pointed to valid certificates. For more information about generating https certificate please refer to: [Configuring HTTPS for Harbor](configure_https.md) - -### Copy Root Certificate - -Suppose the Harbor instance is hosted on a machine `192.168.0.5` -If you are using a self-signed certificate, make sure to copy the CA root cert to `/etc/docker/certs.d/192.168.0.5/` and `~/.docker/tls/192.168.0.5:4443/` - -### Enable Docker Content Trust - -It can be done via setting environment variables: - -``` -export DOCKER_CONTENT_TRUST=1 -export DOCKER_CONTENT_TRUST_SERVER=https://192.168.0.5:4443 -``` - -### Set alias for notary (optional) - -Because by default the local directory for storing meta files for notary client is different from docker client. If you want to use notary client to manipulate the keys/meta files generated by Docker Content Trust, please set the alias to reduce the effort: - -``` -alias notary="notary -s https://192.168.0.5:4443 -d ~/.docker/trust --tlscacert /etc/docker/certs.d/192.168.0.5/ca.crt" - -``` +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file diff --git a/docs/user_guide.md b/docs/user_guide.md index 3e2d79ea2..461d319b2 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -1,1422 +1,5 @@ # Harbor User Guide -This guide walks you through the fundamentals of using the different Harbor features. - -* [Role Based Access Control (RBAC)](#rbac) -* [Authentication Modes and User Accounts](#auth) -* [Managing Projects](#managing-projects) -* [Managing Members of a Project](#managing-members-of-a-project) -* [Access Project Logs](#access-project-logs) -* [Replicating Resources](#replicating-resources) -* [Retagging Images](#retagging-images) -* [Searching Projects and Repositories](#searching-projects-and-repositories) -* [Managing Labels](#managing-labels) -* [Set Project Quotas](#set-project-quotas) -* [Administrator Options](#administrator-options) -* [Pulling and Pushing Images using Docker Client](#pulling-and-pushing-images-in-the-docker-client) -* [Add Descriptions to Repositories](#add-descriptions-to-repositories) -* [Deleting Repositories](#deleting-repositories) -* [Content Trust](#content-trust) -* [Vulnerability Scanning](#vulnerability-scanning) -* [Configure CVE Whitelists](#configure-cve-whitelists) -* [Pulling Images from Harbor in Kubernetes](#pulling-images-from-harbor-in-kubernetes) -* [Managing Helm Charts](#managing-helm-charts) -* [Garbage Collection](#garbage-collection) -* [View Build History](#build-history) -* [Robot Accounts](#robot-accounts) -* [Tag Retention Rules](#tag-retention-rules) -* [Tag Immutability Rules](#tag-immutability-rules) -* [Webhook Notifications](#webhook-notifications) -* [Using API Explorer](#api-explorer) - - -## Role Based Access Control (RBAC) - -![rbac](img/rbac.png) - -Harbor manages images through projects. Users can be added into one project as a member with one of the following different roles: - -* **Limited Guest**: A Limited Guest does not have full read privileges for a project. They can pull images but cannot push, and they cannot see logs or the other members of a project. For example, you can create limited guests for users from different organizations who share access to a project. -* **Guest**: Guest has read-only privilege for a specified project. They can pull and retag images, but cannot push. -* **Developer**: Developer has read and write privileges for a project. -* **Master**: Master has elevated permissions beyond those of 'Developer' including the ability to scan images, view replications jobs, and delete images and helm charts. -* **ProjectAdmin**: When creating a new project, you will be assigned the "ProjectAdmin" role to the project. Besides read-write privileges, the "ProjectAdmin" also has some management privileges, such as adding and removing members, starting a vulnerability scan. - -Besides the above roles, there are two system-level roles: - -* **Harbor system administrator**: "Harbor system administrator" has the most privileges. In addition to the privileges mentioned above, "Harbor system administrator" can also list all projects, set an ordinary user as administrator, delete users and set vulnerability scan policy for all images. The public project "library" is also owned by the administrator. -* **Anonymous**: When a user is not logged in, the user is considered as an "Anonymous" user. An anonymous user has no access to private projects and has read-only access to public projects. - -See detailed permissions matrix listed here: https://github.com/goharbor/harbor/blob/master/docs/permissions.md - - -## Authentication Modes and User Accounts -Harbor supports different modes for authenticating users and managing user accounts. - -- [Database Authentication](#db_auth) -- [LDAP/Active Directory Authentication](#ldap_auth) -- [OIDC Provider Authentication](#oidc_auth) - -**NOTE**: The Harbor interface offers an option to configure UAA authentication. This authentication mode is not recommended and is not documented in this guide. - - -### Database Authentication - -In database authentication mode, user accounts are stored in the local database. By default, only the Harbor system administrator can create user accounts to add users to Harbor. You can optionally configure Harbor to allow self-registration. - -**IMPORTANT**: If you create users in the database, Harbor is locked in database mode. You cannot change to a different authentication mode after you have created local users. - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Under **Administration**, go to **Configuration** and select the **Authentication** tab. -1. Leave **Auth Mode** set to the default **Database** option. - - ![Database authentication](img/db_auth.png) - -1. Optionally select the **Allow Self-Registration** check box. - - ![Enable self-registration](img/new_self_reg.png) - - If you enable self registration option, users can register themselves in Harbor. Self-registration is disabled by default. If you enable self-registration, unregistered users can sign up for a Harbor account by clicking **Sign up for an account** in the Harbor log in page. - - ![Enable self-registration](img/self-registration-login.png) - -#### Create User Accounts - -In database authentication mode, the Harbor system administrator creates user accounts manually. - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Under **Administration**, go to **Users**. - - ![Create user account](img/create_user.png) -1. Click **New User**. -1. Enter information about the new user. - - ![Provide user information](img/new_user.png) - - - The username must be unique in the Harbor system - - The email address is used for password recovery - - The password must contain at least 8 characters with 1 lowercase letter, 1 uppercase letter and 1 numeric character - -If users forget their password, there is a **Forgot Password** in the Harbor log in page. - - -### LDAP/Active Directory Authentication - -If you select LDAP/AD authentication, users whose credentials are stored in an external LDAP or AD server can log in to Harbor directly. In this case, you do not create user accounts in Harbor. - -**IMPORTANT**: You can change the authentication mode from database to LDAP only if no local users have been added to the database. If there is at least one user other than `admin` in the Harbor database, you cannot change the authentication mode. - -Because the users are managed by LDAP or AD, self-registration, creating users, deleting users, changing passwords, and resetting passwords are not supported in LDAP/AD authentication mode. - -If you want to manage user authentication by using LDAP groups, you must enable the `memberof` feature on the LDAP/AD server. With the `memberof` feature, the LDAP/AD user entity's `memberof` attribute is updated when the group entity's `member` attribute is updated, for example by adding or removing an LDAP/AD user from the LDAP/AD group. This feature is enabled by default in Active Directory. For information about how to enable and verify `memberof` overlay in OpenLDAP, see [this technical note]( https://technicalnotes.wordpress.com/2014/04/19/openldap-setup-with-memberof-overlay/). - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Under **Administration**, go to **Configuration** and select the **Authentication** tab. -1. Use the **Auth Mode** drop-down menu to select **LDAP**. - - ![LDAP authentication](img/select_ldap_auth.png) -1. Enter the address of your LDAP server, for example `ldaps://10.162.16.194`. -1. Enter information about your LDAP server. - - - **LDAP Search DN** and **LDAP Search Password**: When a user logs in to Harbor with their LDAP username and password, Harbor uses these values to bind to the LDAP/AD server. For example, `cn=admin,dc=example.com`. - - **LDAP Base DN**: Harbor looks up the user under the LDAP Base DN entry, including the subtree. For example, `dc=example.com`. - - **LDAP Filter**: The filter to search for LDAP/AD users. For example, `objectclass=user`. - - **LDAP UID**: An attribute, for example `uid`, or `cn`, that is used to match a user with the username. If a match is found, the user's password is verified by a bind request to the LDAP/AD server. - - **LDAP Scope**: The scope to search for LDAP/AD users. Select from **Subtree**, **Base**, and **OneLevel**. - - ![Basic LDAP configuration](img/ldap_auth.png) -1. If you want to manage user authentication with LDAP groups, configure the group settings. - - **LDAP Group Base DN**: The base DN from which to lookup a group in LDAP/AD. For example, `ou=groups,dc=example,dc=com`. - - **LDAP Group Filter**: The filter to search for LDAP/AD groups. For example, `objectclass=groupOfNames`. - - **LDAP Group GID**: The attribute used to name an LDAP/AD group. For example, `cn`. - - **LDAP Group Admin DN**: All LDAP/AD users in this group DN have Harbor system administrator privileges. - - **LDAP Group Membership**: The user attribute usd to identify a user as a member of a group. By default this is `memberof`. - - **LDAP Scope**: The scope to search for LDAP/AD groups. Select from **Subtree**, **Base**, and **OneLevel**. - - ![LDAP group configuration](img/ldap_groups.png) -1. Uncheck **LDAP Verify Cert** if the LDAP/AD server uses a self-signed or untrusted certificate. - - ![LDAP certificate verification](img/ldap_cert_test.png) -1. Click **Test LDAP Server** to make sure that your configuration is correct. -1. Click **Save** to complete the configuration. - - -### OIDC Provider Authentication - -If you select OpenID Connect (OIDC) authentication, users log in to the Harbor interface via an OIDC single sign-on (SSO) provider, such as Okta, KeyCloak, or dex. In this case, you do not create user accounts in Harbor. - -**IMPORTANT**: You can change the authentication mode from database to OIDC only if no local users have been added to the database. If there is at least one user other than `admin` in the Harbor database, you cannot change the authentication mode. - -Because the users are managed by the OIDC provider, self-registration, creating users, deleting users, changing passwords, and resetting passwords are not supported in OIDC authentication mode. - -#### Configure Your OIDC Provider - -You must configure your OIDC provider so that you can use it with Harbor. For precise information about how to perform these configurations, see the documentation for your OIDC provider. - -- Set up the users and groups that will use the OIDC provider to log in to Harbor. You do not need to assign any specific OIDC roles to users or groups as these do not get mapped to Harbor roles. -- The URL of the OIDC provider endpoint, known as the Authorization Server in OAuth terminology, must service the well-known URI for its configuration document. For more information about the configuration document, see the [OpenID documentation] (https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationRequest). -- To manage users by using OIDC groups, create a custom group claim that contains all of the user groups that you want to register in Harbor. The group claim must be mapped in the ID token that is sent to Harbor when users log in. You can enable the `memberof` feature on the OIDC provider. With the `memberof` feature, the OIDC user entity's `memberof` attribute is updated when the group entity's `member` attribute is updated, for example by adding or removing an OIDC user from the OIDC group. -- Register Harbor as a client application with the OIDC provider. Associate Harbor's callback URI to the client application as a `redirectURI`. This is the address to which the OIDC provider sends ID tokens. - -#### Configure an OIDC Provider in Harbor - -Before configuring an OIDC provider in Harbor, make sure that your provider is configured correctly according to the preceding section. - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Under **Administration**, go to **Configuration** and select the **Authentication** tab. -1. Use the **Auth Mode** drop-down menu to select **OIDC**. - - ![LDAP authentication](img/select_oidc_auth.png) -1. Enter information about your OIDC provider. - - - **OIDC Provider Name**: The name of the OIDC provider. - - **OIDC Provider Endpoint**: The URL of the endpoint of the OIDC provider. - - **OIDC Client ID**: The client ID with which Harbor is registered as client application with the OIDC provider. - - **OIDC Client Secret**: The secret for the Harbor client application. - - **Group Claim Name**: The name of a custom group claim that you have configured in your OIDC provider, that includes the groups to add to Harbor. - - **OIDC Scope**: A comma-separated string listing the scopes to be used during authentication. - - The OIDC scope must contain `openid` and usually also contains `profile` and `email`. To obtain refresh tokens it should also contain `offline_access`. If you are using OIDC groups, a scope must identify the group claim. Check with your OIDC provider administrator for precise details of how to identify the group claim scope, as this differs from vendor to vendor. - - ![OIDC settings](img/oidc_auth_setting.png) -1. Uncheck **Verify Certificate** if the OIDC Provider uses a self-signed or untrusted certificate. -1. Verify that the Redirect URI that you configured in your OIDC provider is the same as the one displayed at the bottom of the page. - - ![OIDC certificate verification, URI, and test ](img/oidc_cert_verification.png) -1. Click **Test OIDC Server** to make sure that your configuration is correct. -1. Click **Save** to complete the configuration. - -#### Log In to Harbor via an OIDC Provider - -When the Harbor system administrator has configured Harbor to authenticate via OIDC a **Login via OIDC Provider** button appears on the Harbor login page. - -![oidc_login](img/oidc_login.png) - -**NOTE:** When Harbor is configured authentication via OIDC, the **Username** and **Password** fields are reserved for the local Harbor system administrator to log in. - -1. As a Harbor user, click the **Login via OIDC Provider** button. - - This redirects you to the OIDC Provider for authentication. -1. If this is the first time that you are logging in to Harbor with OIDC, specify a user name for Harbor to associate with your OIDC username. - - ![Specify Harbor username for OIDC](img/oidc_onboard_dlg.png) - - This is the user name by which you are identified in Harbor, which is used when adding you to projects, assigning roles, and so on. If the username is already taken, you are prompted to choose another one. -1. After the OIDC provider has authenticated you, you are redirected back to Harbor. - -#### Using OIDC from the Docker or Helm CLI - -After you have authenticated via OIDC and logged into the Harbor interface for the first time, you can use the Docker or Helm CLI to access Harbor. - -The Docker and Helm CLIs cannot handle redirection for OIDC, so Harbor provides a CLI secret for use when logging in from Docker or Helm. This is only available when Harbor uses OIDC authentication. - -1. Log in to Harbor with an OIDC user account. -1. Click your username at the top of the screen and select **User Profile**. - - ![Access user profile](img/user_profile.png) -1. Click the clipboard icon to copy the CLI secret associated with your account. - - ![Copy CLI secret](img/profile_dlg.png) -1. Optionally click the **...** icon in your user profile to display buttons for automatically generating or manually creating a new CLI secret. - - ![Copy CLI secret](img/generate_create_new_secret.png) - - A user can only have one CLI secret, so when a new secret is generated or create, the old one becomes invalid. -1. If you generated a new CLI secret, click the clipboard icon to copy it. - -You can now use your CLI secret as the password when logging in to Harbor from the Docker or Helm CLI. - -
-sh docker login -u testuser -p cli_secret jt-test.local.goharbor.io
-
- -**NOTE**: The CLI secret is associated with the OIDC ID token. Harbor will try to refresh the token, so the CLI secret will be valid after the ID token expires. However, if the OIDC Provider does not provide a refresh token or the refresh fails, the CLI secret becomes invalid. In this case, log out and log back in to Harbor via your OIDC provider so that Harbor can get a new ID token. The CLI secret will then work again. - -## Managing Projects -A project in Harbor contains all repositories of an application. No images can be pushed to Harbor before the project is created. RBAC is applied to a project. There are two types of projects in Harbor: - -* **Public**: All users have the read privilege to a public project, it's convenient for you to share some repositories with others in this way. -* **Private**: A private project can only be accessed by users with proper privileges. - -You can create a project after you signed in. Check on the "Access Level" checkbox will make this project public. - -![create project](img/new_create_project.png) - -After the project is created, you can browse repositories, members, logs, replication and configuration using the navigation tab. - -![browse project](img/new_browse_project.png) - -There are two views to show repositories, list view and card view, you can switch between them by clicking the corresponding icon. - -![browse repositories](img/browse_project_repositories.png) - -Project properties can be changed by clicking "Configuration". - -* To make all repositories under the project accessible to everyone, select the `Public` checkbox. - -* To prevent un-signed images under the project from being pulled, select the `Enable content trust` checkbox. - -![browse project](img/project_configuration.png) - -## Managing Members of a Project - -You can add individual users to an existing project and assign a role to them. You can add an LDAP/AD or OIDC user to the project members if you use LDAP/AD or OIDC authentication, or a user that you have already created if you use database authentication. If you use LDAP/AD or OIDC authentication, you can add groups to projects and assign a role to the group. - -### Add Individual Members to Projects - -1. Log in to the Harbor interface with an account that has at least project administrator privileges. -1. Go to **Projects** and select a project. -1. Select the **Members** tab and click **+User**. - - ![browse project](img/project_members.png) -1. Enter the name of an existing database, LDAP/AD, or OIDC user and select a role for this user. - - ![browse project](img/new_add_member.png) -1. Optionally select one or more members, click **Action**, and select a different role for the user or users, or select **Remove** to remove them from the project. - - ![browse project](img/new_remove_update_member.png) - -### Add LDAP/AD Groups to Projects - -1. Log in to the Harbor interface with an account that has at least project administrator privileges. -1. Go to **Projects** and select a project. -1. Select the **Members** tab and click **+Group**. - - ![Add group](img/add_group.png) -1. Select **Add an existing user group to project members** or **Add a group from LDAP to project member**. - - ![Screenshot of add group dialog](img/group/ldap_group_addgroup_dialog.png) - - - If you selected **Add an existing user group to project members**, enter the name of a group that you have already used in Harbor and assign a role to that group. - - If you selected **Add a group from LDAP to project member**, enter the LDAP Group DN and assign a role to that group. - -Once an LDAP group has been assigned a role in a project, all LDAP/AD users in this group have the privileges of the role you assigned to the group. If a user has both user-level role and group-level role, these privileges are merged. - -If a user in the LDAP group has admin privilege, the user has the same privileges as the Harbor system administrator. - -### Add OIDC Groups to Projects - -To be able to add OIDC groups to projects, your OIDC provider and Harbor instance must be configured correctly. For information about how to configure OIDC so that Harbor can use groups, see [OIDC Provider Authentication](#oidc_auth). - -1. Log in to the Harbor interface with an account that has at least project administrator privileges. -1. Go to **Projects** and select a project. -1. Select the **Members** tab and click **+Group**. - - ![Add group](img/add_group.png) -1. Enter the name of a group that already exists in your OIDC provider and assign a role to that group. - - ![Add group](img/add_oidc_group.png) - -**NOTE**: Unlike with LDAP groups, Harbor cannot check whether OIDC groups exist when you add them to a project. If you mistype the group name, or if the group does not exist in your OIDC provider, Harbor still creates the group. - -## Access Project Logs - -1. Log in to the Harbor interface with an account that has at least developer privileges. -1. Go to **Projects**, select a project, and select **Logs**. - - ![Filter logs](img/project_logs.png) - - All logs for the project are displayed. -1. Click the **Search** icon and start typing to filter the logs by name. - - ![Filter logs](img/log_filter.png) -1. Click **Advanced**. - - ![Advanced log search](img/log_search_advanced.png) -1. Use the **Operations** drop-down menu to filter by operation type. - ![Search logs by operation type](img/new_project_log.png) -1. Click the calendar icons to enter dates between which to search for logs of the types you set in the **Operations** drop-down menu. - - ![Filter logs by date](img/log_search_advanced_date.png) - -## Replicating Resources -Replication allows users to replicate resources, namely images and charts, between Harbor and non-Harbor registries, in both pull or push mode. - -When the Harbor system administrator has set a replication rule, all resources that match the defined filter patterns are replicated to the destination registry when the triggering condition is met. Each resource that is replicated starts a replication task. If the namespace does not exist in the destination registry, a new namespace is created automatically. If it already exists and the user account that is configured in the replication policy does not have write privileges in it, the process fails. Member information is not replicated. - -There might be some delay during replication based on the condition of the network. If a replication task fails, it is re-scheduled for a few minutes later and retried several times. - -**NOTE:** Due to API changes, replication between different versions of Harbor is not supported. - -### Creating Replication Endpoints - -To replicate image repositories from one instance of Harbor to another Harbor or non-Harbor registry, you first create replication endpoints. - -1. Go to **Registries** and click the **+ New Endpoint** button. - - ![New replication endpoint](img/replication-endpoint1.png) -1. For **Provider**, use the drop-down menu to select the type of registry to set up as a replication endpoint. - - The endpoint can be another Harbor instance, or a non-Harbor registry. Currently, the following non-Harbor registries are supported: - - - Docker Hub - - Docker registry - - AWS Elastic Container Registry - - Azure Container Registry - - Ali Cloud Container Registry - - Google Container Registry - - Huawei SWR - - Helm Hub - - Gitlab - - Quay.io - - Jfrog Artifactory - - ![Replication providers](img/replication-endpoint2.png) - -1. Enter a suitable name and description for the new replication endpoint. -1. Enter the full URL of the registry to set up as a replication endpoint. - - For example, to replicate to another Harbor instance, enter https://harbor_instance_address:443. The registry must exist and be running before you create the endpoint. -1. Enter the Access ID and Access Secret for the endpoint registry instance. - - Use an account that has the appropriate privileges on that registry, or an account that has write permission on the corresponding project in a Harbor registry. - - **NOTES**: - - AWS ECR adapters should use access keys, not a username and password. The access key should have sufficient permissions, such as storage permission. - - Google GCR adapters should use the entire JSON key generated in the service account. The namespace should start with the project ID. -1. Optionally, select the **Verify Remote Cert** check box. - - Deselect the check box if the remote registry uses a self-signed or untrusted certificate. -1. Click **Test Connection**. -1. When you have successfully tested the connection, click **OK**. - -### Creating a Replication Rule - -A replication endpoint must exist before you create a replication rule. To create an endpoint, follow the instructions in the [Creating replication endpoints](#creating-replication-endpoints). - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Expand **Administration**, and select **Replications**. - - ![Add a replication rule](img/replication-rule1.png) -1. Click **New Replication Rule**. -1. Provide a name and description for the replication rule. -1. Select **Push-based** or **Pull-based** replication, depending on whether you want to replicate images to or from the remote registry. - - ![Replication mode](img/replication-rule2.png) -1. For **Source resource filter**, identify the images to replicate. - - ![Replication filters](img/replication-rule3.png) - - * **Name**: Replicate resources with a given name by entering an image name or fragment. - * **Tag**: Replicate resources with a given tag by entering a tag name or fragment. - * **Label**: Replicate resources with a given label by using the drop-down menu to select from the available labels. - * **Resource**: Replicate images, charts, or both. - - The name filter and tag filters support the following patterns: - - * **\***: Matches any sequence of non-separator characters `/`. - * **\*\***: Matches any sequence of characters, including path separators `/`. - * **?**: Matches any single non-separator character `/`. - * **{alt1,...}**: Matches a sequence of characters if one of the comma-separated alternatives matches. are as follows: - * **\***: Matches any sequence of non-separator characters `/`. - * **\*\***: Matches any sequence of characters, including path separators `/`. - * **?**: Matches any single non-separator character `/`. - * **{alt1,...}**: Matches a sequence of characters if one of the comma-separated alternatives matches. - - **NOTE:** You must add `library` if you want to replicate the official images of Docker Hub. For example, `library/hello-world` matches the official hello-world images. - - Pattern | String(Match or not) - ---------- | ------- - `library/*` | `library/hello-world`(Y)
`library/my/hello-world`(N) - `library/**` | `library/hello-world`(Y)
`library/my/hello-world`(Y) - `{library,goharbor}/**` | `library/hello-world`(Y)
`goharbor/harbor-core`(Y)
`google/hello-world`(N) - `1.?` | `1.0`(Y)
`1.01`(N) -1. Use the **Destination Registry** drop-down menu to select from the configured replication endpoints. -1. Enter the name of the namespace in which to replicate resources in the **Destination namespace** text box. - - If you do not enter a namespace, resources are placed in the same namespace as in the source registry. - - ![Destination and namespaces](img/replication-rule4.png) -1. Use the Trigger Mode drop-down menu to select how and when to run the rule. - * **Manual**: Replicate the resources manually when needed. **Note**: Deletion operations are not replicated. - * **Scheduled**: Replicate the resources periodically by defining a cron job. **Note**: Deletion operations are not replicated. - * **Event Based**: When a new resource is pushed to the project, or an image is retagged, it is replicated to the remote registry immediately. If you select the `Delete remote resources when locally deleted`, if you delete an image, it is automatically deleted from the replication target. - - **NOTE**: You can filter images for replication based on the labels that are applied to the images. However, changing a label on an image does not trigger replication. Event-based replication is limited to pushing, retagging, and deleting images. - - ![Trigger mode](img/replication-rule5.png) - -1. Optionally select the Override checkbox to force replicated resources to replace resources at the destination with the same name. -1. Click **Save** to create the replication rule. - - -### Running Replication Manually - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Expand **Administration**, and select **Replications**. -1. Select a replication rule and click **Replicate**. - - ![Add a replication rule](img/replication-rule6.png) - - The resources to which the rule is applied start to replicate from the source registry to the destination immediately. -1. Click the rule to see its execution status. -1. Click the **ID** of the execution to see the details of the replication and the task list. The count of `IN PROGRESS` status in the summary includes both `Pending` and `In Progress` tasks. -1. Optionally click **STOP** to stop the replication. -1. Click the log icon to see detailed information about the replication task. - -![View replication task](img/list_tasks.png) - -To edit or delete a replication rule, select the replication rule in the **Replications** view and click **Edit** or **Delete**. Only rules which have no executions in progress can be edited deleted. - -![Delete or edit rule](img/replication-rule6.png) - -## Retagging Images - -Images retag helps users to tag images in Harbor, images can be tagged to different repositories and projects, as long as the users have sufficient permissions. For example, - -``` -release/app:stg --> release/app:prd -develop/app:v1.0 --> release/app:v1.0 -``` -To retag an image, users should have read permission (guest role or above) to the source project and write permission (developer role or above) to the target project. - -In Harbor portal, select the image you'd like to retag, and click the enabled `Retag` button to open the retag dialog. - -![retag image](img/retag_image.png) - -In the retag dialog, project name, repository name and the new tag should be specified. On click the `CONFIRM` button, the new tag would be created instantly. You can check the new tag in the corresponding project. - -## Searching Projects and Repositories -Entering a keyword in the search field at the top lists all matching projects and repositories. The search result includes both public and private repositories you have access to. - -![browse project](img/new_search.png) - -## Managing Labels -Harbor provides two kinds of labels to isolate kinds of resources(only images for now): -* **Global Level Label**: Managed by Harbor system administrators and used to manage the images of the whole system. They can be added to images under any projects. -* **Project Level Label**: Managed by project administrators under a project and can only be added to the images of the project. - -### Managing Global Labels -The Harbor system administrators can list, create, update and delete the global level labels under `Administration->Configuration->Labels`: - -![manage global level labels](img/manage_global_level_labels.png) - -### Managing Project-Level Labels -The project administrators and Harbor system administrators can list, create, update and delete the project level labels under `Labels` tab of the project detail page: - -![manage project level labels](img/manage_project_level_labels.png) - -### Adding and Removing Labels to and from Images -Users who have Harbor system administrator, project administrator or project developer role can click the `ADD LABELS` button to add labels to or remove labels from images. The label list contains both globel level labels(come first) and project level labels: - -![add labels to images](img/add_labels_to_images.png) - -### Filtering Images by Label -The images can be filtered by labels: - -![filter images by labels](img/filter_images_by_label.png) - -## Set Project Quotas - -To exercise control over resource use, as a Harbor system administrator you can set quotas on projects. You can limit the number of tags that a project can contain and limit the amount of storage capacity that a project can consume. You can set default quotas that apply to all projects globally. - -**NOTE**: Default quotas apply to projects that are created after you set or change the default quota. The default quota is not applied to projects that already existed before you set it. - -You can also set quotas on individual projects. If you set a global default quota and you set different quotas on individual projects, the per-project quotas are applied. - -By default, all projects have unlimited quotas for both tags and storage use. - -1. Select the **Project Quotas** view. - ![Project quotas](img/project-quota1.png) -1. To set global default quotas on all projects, click **Edit**. - - ![Project quotas](img/project-quota2.png) - 1. For **Default artifact count**, enter the maximum number of tags that any project can contain at a given time, or enter `-1` to set the default to unlimited. - 1. For **Default storage consumption**, enter the maximum quantity of storage that any project can consume, selecting `MB`, `GB`, or `TB` from the drop-down menu, or enter `-1` to set the default to unlimited. - ![Project quotas](img/project-quota3.png) - 1. Click **OK**. -1. To set quotas on an individual project, click the 3 vertical dots next to a project and select **Edit**. - ![Project quotas](img/project-quota4.png) - 1. For **Default artifact count**, enter the maximum number of tags that this individual project can contain, or enter `-1` to set the default to unlimited. - 1. For **Default storage consumption**, enter the maximum quantity of storage that this individual project can consume, selecting `MB`, `GB`, or `TB` from the drop-down menu. - -After you set quotas, you can see how much of their quotas each project has consumed. - -![Project quotas](img/project-quota5.png) - -### How Harbor Calculates Resource Usage - -When setting project quotas, it is useful to know how Harbor calculates tag numbers and storage use, especially in relation to image pushing, retagging, and garbage collection. - -- Harbor computes image size when blobs and manifests are pushed from the Docker client. -- Harbor computes tag counts when manifests are pushed from the Docker client. - - **NOTE**: When users push an image, the manifest is pushed last, after all of the associated blobs have been pushed successfully to the registry. If several images are pushed concurrently and if there is an insufficient number of tags left in the quota for all of them, images are accepted in the order that their manifests arrive. Consequently, an attempt to push an image might not be immediately rejected for exceeding the quota. This is because there was availability in the tag quota when the push was initiated, but by the time the manifest arrived the quota had been exhausted. -- Shared blobs are only computed once per project. In Docker, blob sharing is defined globally. In Harbor, blob sharing is defined at the project level. As a consequence, overall storage usage can be greater than the actual disk capacity. -- Retagging images reserves and releases resources: - - If you retag an image within a project, the tag count increases by one, but storage usage does not change because there are no new blobs or manifests. - - If you retag an image from one project to another, the tag count and storage usage both increase. -- During garbage collection, Harbor frees the storage used by untagged blobs in the project. -- If the tag count reaches the limit, image blobs can be pushed into a project and storage usage is updated accordingly. You can consider these blobs to be untagged blobs. They can be removed by garbage collection, and the storage that they consume is returned after garbage colletion. -- Helm chart size is not calculated. Only tag counts are calculated. - -## Administrator Options -### Managing Users -Administrator can add "Administrator" role to one or more ordinary users by checking checkboxes and clicking `SET AS ADMINISTRATOR`. To delete users, checked checkboxes and select `DELETE`. Deleting user is only supported under database authentication mode. - -![browse project](img/new_set_admin_remove_user.png) - -### Managing Project Creation -Use the **Project Creation** drop-down menu to set which users can create projects. Select **Everyone** to allow all users to create projects. Select **Admin Only** to allow only users with the Administrator role to create projects. -![browse project](img/new_proj_create.png) - -### Managing Email Settings -You can change Harbor's email settings, the mail server is used to send out responses to users who request to reset their password. -![browse project](img/new_config_email.png) - -### Managing Registry Read Only -You can change Harbor's registry read only settings, read only mode will allow 'docker pull' while preventing 'docker push' and the deletion of repository and tag. -![browse project](img/read_only.png) - -If it set to true, deleting repository, tag and pushing image will be disabled. -![browse project](img/read_only_enable.png) - - -``` -$ docker push 10.117.169.182/demo/ubuntu:14.04 -The push refers to a repository [10.117.169.182/demo/ubuntu] -0271b8eebde3: Preparing -denied: The system is in read only mode. Any modification is prohibited. -``` -## Pulling and Pushing Images in the Docker Client - -**NOTE**: Harbor only supports the Registry V2 API. You must use Docker client 1.6.0 or higher. - -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](installation_guide.md#connect_http) in the *Harbor Installation and Configuration Guide*. - -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. - -### Pulling Images -If the project that the image belongs to is private, you should sign in first: - -``` -sh -$ docker login 10.117.169.182 -``` - -You can now pull the image: - -``` -sh -$ docker pull 10.117.169.182/library/ubuntu:14.04 -``` - -**Note**: Replace "10.117.169.182" with the IP address or domain name of your Harbor node. You cannot pull an unsigned image if you enabled content trust. - -### Pushing Images -Before pushing an image, you must create a corresponding project on Harbor web UI. - -First, log in from Docker client: - -``` -sh -$ docker login 10.117.169.182 -``` - -Tag the image: - -``` -sh -$ docker tag ubuntu:14.04 10.117.169.182/demo/ubuntu:14.04 -``` - -Push the image: - -``` -sh -$ docker push 10.117.169.182/demo/ubuntu:14.04 -``` - -**Note: Replace "10.117.169.182" with the IP address or domain name of your Harbor node.** - -## Add Descriptions to Repositories - -After pushing an image, an Information can be added by project admin to describe this repository. - -Go into the repository and select the "Info" tab, and click the "EDIT" button. An textarea will appear and enter description here. Click "SAVE" button to save this information. - -![edit info](img/edit_description.png) - -## Download the Harbor Certificate - -Users can click the "registry certificate" link to download the registry certificate. - -![browse project](img/download_harbor_certs.png) - -## Deleting Repositories - -Repository deletion runs in two steps. - -First, delete a repository in Harbor's UI. This is soft deletion. You can delete the entire repository or just a tag of it. After the soft deletion, -the repository is no longer managed in Harbor, however, the files of the repository still remain in Harbor's storage. - -![browse project](img/new_delete_repo.png) -![browse project](img/new_delete_tag.png) - -**CAUTION: 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 actual files of the repository using the [garbage collection](#online-garbage-collection) in Harbor's UI. - -## Content Trust -**NOTE: Notary is an optional component, please make sure you have already installed it in your Harbor instance before you go through this section.** -If you want to enable content trust to ensure that images are signed, please set two environment variables in the command line before pushing or pulling any image: -```sh -export DOCKER_CONTENT_TRUST=1 -export DOCKER_CONTENT_TRUST_SERVER=https://10.117.169.182:4443 -``` -If you push the image for the first time, You will be asked to enter the root key passphrase. This will be needed every time you push a new image while the ``DOCKER_CONTENT_TRUST`` flag is set. -The root key is generated at: ``/root/.docker/trust/private/root_keys`` -You will also be asked to enter a new passphrase for the image. This is generated at ``/root/.docker/trust/private/tuf_keys/[registry name] /[imagepath]``. -If you are using a self-signed cert, make sure to copy the CA cert into ```/etc/docker/certs.d/10.117.169.182``` and ```$HOME/.docker/tls/10.117.169.182:4443/```. When an image is signed, it is indicated in the Web UI. -**Note: Replace "10.117.169.182" with the IP address or domain name of your Harbor node. In order to use content trust, HTTPS must be enabled in Harbor.** - - -When an image is signed, it has a tick shown in UI; otherwise, a cross sign(X) is displayed instead. -![browse project](img/content_trust.png) - -## Vulnerability Scanning - -Harbor provides static analysis of vulnerabilities in images through the open source [Clair](https://github.com/coreos/clair) project. - -**IMPORTANT**: Clair is an optional component. To be able to use Clair you must have enabled Clair when you installed your Harbor instance. - -You can also connect Harbor to your own instance of Clair or to additional vulnerability scanners by using an interrogation service. You configure additional scanners in the Harbor interface, after you have installed Harbor. For the list of additional scanners that are currently supported, see the [Harbor Compatibility List](harbor_compatibility_list.md#scanner-adapters). - -It might be necessary to connect Harbor to other scanners for corporate compliance reasons, or because your organization already uses a particular scanner. Different scanners also use different vulnerability databases, capture different CVE sets, and apply different severity thresholds. By connecting Harbor to more than one vulnerability scanner, you broaden the scope of your protection against vulnerabilities. - -- For information about installing Harbor with Clair, see the [Installation and Configuration Guide](installation_guide.md). -- For information about adding additional scanners, see [Connect Harbor to Additional Vulnerability Scanners](#pluggable-scanners) below. - -You can manually initiate scanning on a particular image, or on all images in Harbor. Additionally, you can also set a policy to automatically scan all of the images at specific intervals. - - -### Connect Harbor to Additional Vulnerability Scanners - -To connect Harbor to additional vulnerability scanners, you must install and configure an instance of the additional scanner according to the scanner vendor's requirements. The scanner must expose an API endpoint to allow Harbor to trigger the scan process or get reports. You can deploy multiple different scanners, and multiple instances of the same type of scanner. - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Expand **Administration**, and select **Interrogation Services**. - ![Interrogation Services](img/interrogation-services.png) -1. Click the **New Scanner** button. -1. Enter the information to identify the scanner. - - A unique name for this scanner instance, to display in the Harbor interface. - - An optional description of this scanner instance. - - The address of the API endpoint that the scanner exposes to Harbor. - ![Add scanner](img/add-scanner.png) -1. Select how to connect to the scanner from the **Authorization** drop-down menu. - ![Select scanner authentication method](img/scanner-auth.png) - - **None**: The scanner allows all connections without any security. - - **Basic**: Enter a username and password for an account that can connect to the scanner. - - **Bearer**: Paste the contents of a bearer token in the **Token** text box. - - **APIKey**: Paste the contents of an API key for the scanner in the **APIKey** text box. -1. Optionally select **Skip certificate verification** if the scanner uses a self-signed or untrusted certificate. -1. Optionally select **Use internal registry address** if the scanner should connect to Harbor using an internal network address rather than its external URL. - - **NOTE**: To use this option, the scanner must be deployed in a network that allows the scanner to reach Harbor via Harbor's internal network. -1. Click **Test Connection** to make sure that Harbor can connect successfully to the scanner. - ![Test scanner connection](img/test-scanner-connection.png) -1. Click **Add** to connect Harbor to the scanner. -1. Optionally repeat the procedure to add more scanners. -1. If you configure multiple scanners, select one and click **Set as Default** to designate it as the default scanner. - -### Updating the Vulnerability Metadata in the Database - -Vulnerability scanners depend on the vulnerability metadata to complete the analysis process. After the first initial installation, the vulnerability scanner automatically starts to update the metadata database from different vulnerability repositories. The database update might take a while, based on the data size and network connection. - -Depending on the scanner that you use, once the database is ready, the timestamp of the last update is shown in the **Interrogation Services** > **Vulnerability** tab. Currently, only Clair and Anchore provide timestamp information. -![browse project](img/clair_ready.png) - -Until the database has been fully populated, the timestamp is replaced by a warning symbol. When the database is ready, you can scan images individually or scan all images across all projects. - -### Scan Individual Images - -1. Log in to the Harbor interface with an account that has at least project administrator privileges. -1. Go to **Projects** and select a project. -1. Select the **Scanner** tab. - - The **Scanner** tab shows the details of the scanner that is currently set as the scanner to use for this project. - - ![Project scanner tab](img/project-scanners.png) -1. Click **Edit** to select a different scanner from the list of scanners that are connected to this Harbor instance, and click **OK**. - - ![Project scanner tab](img/select-scanner.png) - - **NOTE**: If you have selected the **Prevent vulnerable images from running** option in the project **Configuration** tab, the prevention of pulling vulnerable images is determined by the scanner that is set in the project, or by the global default scanner if no scanner is configured specifically for the project. Different scanners might apply different levels of severity to image vulnerabilities. -1. Select the **Repositories** tab and select a repository. - - For each tag in the repository, the **Vulnerabilities** column displays the vulnerability scanning status and related information. - - ![Tag vulnerability status](img/tag-vulnerability-status.png) -1. Select a tag, or use the check box at the top to select all tags in the repository, and click the **Scan** button to run the vulnerability scan on this image. - - ![Scan an image](img/scan_image.png) - - **NOTE**: You can start a scan at any time, unless the status is **Queued** or **Scanning**. If the database has not been fully populated, you should not run a scan. The following statuses are displayed in the **Vulnerabilities** column: - - * **Not Scanned:** The tag has never been scanned. - * **Queued:** The scanning task is scheduled but has not run yet. - * **Scanning:** The scanning task is in progress and a progress bar is displayed. - * **View log:** The scanning task failed to complete. Click **View Log** link to view the related logs. - * **Complete:** The scanning task completed successfully. - - If the process completes successfully, the result indicates the overall severity level, with the total number of vulnerabilities found for each severity level, and the number of fixable vulnerabilities. - - ![Scan result](img/scan-result.png) - - * **Red:** At least one critical vulnerability found - * **Orange:** At least one high level vulnerability found - * **Yellow:** At least one medium level vulnerability found - * **Blue:** At least one low level vulnerability found - * **Green:** No vulnerabilities found - * **Grey:** Unknown vulnerabilities -1. Hover over the number of fixable vulnerabilities to see a summary of the vulnerability report. - - ![Vulnerability summary](img/vulnerability-summary.png) -1. Click on the tag name to see a detailed vulnerability report. - - ![Vulnerability report](img/tag_detail.png) - - In addition to information about the tag, all of the vulnerabilities found in the last scan are listed. You can order or filter the list by the different columns. You can also click **Scan** in the report page to run a scan on this image tag. - -### Scan All Images - -In addition to scanning individual images in projects, you can run global scans on all of the images in a Harbor instance, across all projects. - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Expand **Administration**, and select **Interrogation Services**. -1. Select the **Vulnerability** tab and click **Scan Now** to scan all of the images in all projects. - - ![Scan all images](img/scan_all.png) - -Scanning requires intensive resource consumption. If scanning is in progress, the **Scan Now** button is unavailable. - -### Schedule Scans - -You can set policies to control when vulnerability scanning should run. - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Expand **Administration**, and select **Interrogation Services**. -1. Select the **Vulnerability** tab and click the **Edit** button next to **Schedule to scan all**. -1. Use the drop down-menu to select how often to run scans. - - ![browse project](img/scan_policy.png) - - * **None**: No scans are scheduled. - * **Hourly**: Run a scan at the beginning of every hour. - * **Daily**: Run a scan at midnight every day. - * **Weekly**: Run a scan at midnight every Saturday. - * **Custom**: Run a scan according to a `cron` job. -1. Click **Save**. - -### Configure Vulnerability Settings in Projects - -You can configure projects so that images with vulnerabilities cannot be run, and to automatically scan images as soon as they are pushed into the project. - -1. Log in to the Harbor interface with an account that has at least project administrator privileges. -1. Go to **Projects** and select a project. -1. Select the **Configuration** tab. -1. To prevent vulnerable images under the project from being pulled, select the **Prevent vulnerable images from running** checkbox. - - ![Prevent vulnerable images from running](img/prevent_vulnerable_images.png) - -1. Select the severity level of vulnerabilities to prevent images from running. - - ![Set vulnerability threshold](img/set_vulnerability_threshold.png) - - Images cannot be pulled if their level is equal to or higher than the selected level of severity. Harbor does not prevent images with a vulnerability severity of `negligible` from running. -1. To activate an immediate vulnerability scan on new images that are pushed to the project, select the **Automatically scan images on push** check box. - - ![Automatically scan images on push](img/scan_on_push.png) - -## Configure CVE Whitelists - -When you run vulnerability scans, images that are subject to Common Vulnerabilities and Exposures (CVE) are identified. According to the severity of the CVE and your security settings, these images might not be permitted to run. As a Harbor system administrator, you can create whitelists of CVEs to ignore during vulnerability scanning. - -You can set a system-wide CVE whitelist or you can set CVE whitelists on a per-project basis. - -### Configure a System-Wide CVE Whitelist - -System-wide CVE whitelists apply to all of the projects in a Harbor instance. - -1. Go to **Configuration** > **System Settings**. -1. Under **Deployment security**, click **Add**. - ![System-wide CVE whitelist](img/cve-whitelist1.png) -1. Enter the list of CVE IDs to ignore during vulnerability scanning. - ![Add system CVE whitelist](img/cve-whitelist2.png) - - Either use a comma-separated list or newlines to add multiple CVE IDs to the list. -1. Click **Add** at the bottom of the window to add the list. -1. Optionally uncheck the **Never expires** checkbox and use the calendar selector to set an expiry date for the whitelist. - ![Add system CVEs](img/cve-whitelist3.png) -1. Click **Save** at the bottom of the page to save your settings. - -After you have created a system whitelist, you can remove CVE IDs from the list by clicking the delete button next to it in the list. You can click **Add** to add more CVE IDs to the system whitelist. - -![Add and remove system CVEs](img/cve-whitelist4.png) - -### Configure a Per-Project CVE Whitelist - -By default, the system whitelist is applied to all projects. You can configure different CVE whitelists for individual projects, that override the system whitelist. - -1. Go to **Projects**, select a project, and select **Configuration**. -1. Under **CVE whitelist**, select **Project whitelist**. - ![Project CVE whitelist](img/cve-whitelist5.png) -1. Optionally click **Copy From System** to add all of the CVE IDs from the system CVE whitelist to this project whitelist. -1. Click **Add** and enter a list of additional CVE IDs to ignore during vulnerability scanning of this project. - ![Add project CVEs](img/cve-whitelist6.png) - - Either use a comma-separated list or newlines to add multiple CVE IDs to the list. -1. Click **Add** at the bottom of the window to add the CVEs to the project whitelist. -1. Optionally uncheck the **Never expires** checkbox and use the calendar selector to set an expiry date for the whitelist. -1. Click **Save** at the bottom of the page to save your settings. - -After you have created a project whitelist, you can remove CVE IDs from the list by clicking the delete button next to it in the list. You can click **Add** at any time to add more CVE IDs to this project whitelist. - -If CVEs are added to the system whitelist after you have created a project whitelist, click **Copy From System** to add the new entries from the system whitelist to the project whitelist. - -**NOTE**: If CVEs are deleted from the system whitelist after you have created a project whitelist, and if you added the system whitelist to the project whitelist, you must manually remove the deleted CVEs from the project whitelist. If you click **Copy From System** after CVEs have been deleted from the system whitelist, the deleted CVEs are not automatically removed from the project whitelist. - -## Pulling Images from Harbor in Kubernetes -Kubernetes users can easily deploy pods with images stored in Harbor. The settings are similar to that of another private registry. There are two major issues: - -1. When your Harbor instance is hosting http and the certificate is self signed. You need to modify daemon.json on each work node of your cluster, for details please refer to: https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry -2. If your pod references an image under private project, you need to create a secret with the credentials of user who has permission to pull image from this project, for details refer to: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ - -## Managing Helm Charts -[Helm](https://helm.sh) is a package manager for [Kubernetes](https://kubernetes.io). Helm uses a packaging format called [charts](https://docs.helm.sh/developing_charts). Since version 1.6.0 Harbor is now a composite cloud-native registry which supports both container image management and Helm charts management. Access to Helm charts in Harbor is controlled by [role-based access controls (RBAC)](https://en.wikipedia.org/wiki/Role-based_access_control) and is restricted by projects. - -### Manage Helm Charts via the Harbor Interface -#### List charts -Click your project to enter the project detail page after successful logging in. The existing helm charts will be listed under the tab `Helm Charts` which is beside the image `Repositories` tab with the following information: -* Name of helm chart -* The status of the chart: Active or Deprecated -* The count of chart versions -* The created time of the chart - -![list charts](img/chartrepo/list_charts.png) - -You can click the icon buttons on the top right to switch views between card view and list view. - -#### Upload a New Chart -Click the `UPLOAD` button on the top left to open the chart uploading dialog. Choose the uploading chart from your filesystem. Click the `UPLOAD` button to upload it to the chart repository server. - -![upload charts](img/chartrepo/upload_charts.png) - -If the chart is signed, you can choose the corresponding provenance file from your filesystem and Click the `UPLOAD` button to upload them together at once. - -If the chart is successfully uploaded, it will be displayed in the chart list at once. - -#### List Chart Versions -Clicking the chart name from the chart list will show all the available versions of that chart with the following information: -* the chart version number -* the maintainers of the chart version -* the template engine used (default is gotpl) -* the created timestamp of the chart version - -![list charts versions](img/chartrepo/list_chart_versions.png) - -Obviously, there will be at least 1 version for each of the charts in the top chart list. Same with chart list view, you can also click the icon buttons on the top right to switch views between card view and list view. - -Check the checkbox at the 1st column to select the specified chart versions: -* Click the `DELETE` button to delete all the selected chart versions from the chart repository server. Batch operation is supported. -* Click the `DOWNLOAD` button to download the chart artifact file. Batch operation is not supported. -* Click the `UPLOAD` button to upload the new chart version for the current chart - -#### Adding Labels to and Removing Labels from Chart Versions -Users who have Harbor system administrator, project administrator or project developer role can click the `ADD LABELS` button to add labels to or remove labels from chart versions. - -![add labels to chart versions](img/chartrepo/add_labesl_to_chart_versions.png) - - -#### Filtering Chart Versions by Label -The chart versions can be filtered by labels: - -![filter chart versions by labels](img/chartrepo/filter_chart_versions_by_label.png) - -#### View Chart Version Details -Clicking the chart version number link will open the chart version details view. You can see more details about the specified chart version here. There are three content sections: -* **Summary:** - * readme of the chart - * overall metadata like home, created timestamp and application version - * related helm commands for reference, such as `helm add repo` and `helm install` etc. -![chart details](img/chartrepo/chart_details.png) -* **Dependencies:** - * list all the dependant sun charts with 'name', 'version' and 'repository' fields -![chart dependencies](img/chartrepo/chart_dependencies.png) -* **Values:** - * display the content from `values.yaml` file with highlight code preview - * clicking the icon buttons on the top right to switch the yaml file view to k-v value pair list view -![chart values](img/chartrepo/chart_values.png) - -Clicking the `DOWNLOAD` button on the top right will start the downloading process. - -### Working with the Helm CLI -As a helm chart repository, Harbor can work smoothly with Helm CLI. About how to install Helm CLI, please refer [install helm](https://docs.helm.sh/using_helm/#installing-helm). Run command `helm version` to make sure the version of Helm CLI is v2.9.1+. -``` -helm version - -#Client: &version.Version{SemVer:"v2.9.1", GitCommit:"20adb27c7c5868466912eebdf6664e7390ebe710", GitTreeState:"clean"} -#Server: &version.Version{SemVer:"v2.9.1", GitCommit:"20adb27c7c5868466912eebdf6664e7390ebe710", GitTreeState:"clean"} -``` -#### Add Harbor to the Repository List -Before working, Harbor should be added into the repository list with `helm repo add` command. Two different modes are supported. -* Add Harbor as a unified single index entry point - -With this mode Helm can be made aware of all the charts located in different projects and which are accessible by the currently authenticated user. -``` -helm repo add --ca-file ca.crt --username=admin --password=Passw0rd myrepo https://xx.xx.xx.xx/chartrepo -``` -**NOTES:** Providing both ca file and cert files is caused by an issue from helm. - -* Add Harbor project as separate index entry point - -With this mode, helm can only pull charts in the specified project. -``` -helm repo add --ca-file ca.crt --username=admin --password=Passw0rd myrepo https://xx.xx.xx.xx/chartrepo/myproject -``` - -#### Push Charts to the Repository Server with the CLI -As an alternative, you can also upload charts via the CLI. It is not supported by the native helm CLI. A plugin from the community should be installed before pushing. Run `helm plugin install` to install the `push` plugin first. -``` -helm plugin install https://github.com/chartmuseum/helm-push -``` -After a successful installation, run `push` command to upload your charts: -``` -helm push --ca-file=ca.crt --username=admin --password=passw0rd chart_repo/hello-helm-0.1.0.tgz myrepo -``` -**NOTES:** `push` command does not support pushing a prov file of a signed chart yet. - -#### Install Charts -Before installing, make sure your helm is correctly initialized with command `helm init` and the chart index is synchronized with command `helm repo update`. - -Search the chart with the keyword if you're not sure where it is: -``` -helm search hello - -#NAME CHART VERSION APP VERSION DESCRIPTION -#local/hello-helm 0.3.10 1.3 A Helm chart for Kubernetes -#myrepo/chart_repo/hello-helm 0.1.10 1.2 A Helm chart for Kubernetes -#myrepo/library/hello-helm 0.3.10 1.3 A Helm chart for Kubernetes -``` -Everything is ready, install the chart to your kubernetes: -``` -helm install --ca-file=ca.crt --username=admin --password=Passw0rd --version 0.1.10 repo248/chart_repo/hello-helm -``` - -For other more helm commands like how to sign a chart, please refer to the [helm doc](https://docs.helm.sh/helm/#helm). - -## Garbage Collection - -When you delete images from Harbor, space is not automatically freed up. You must run garbage collection to free up space by removing blobs that are no longer referenced by a manifest from the file system. - -### Run Garbage Collection - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Expand **Administration**, and select **Garbage Collection**. -1. Select the **'Garbage Collection'** tab. - ![Garbage collection](img/garbage-collection.png) -1. To run garbage collection immediately, click **GC Now**. - -When you run garbage collection, Harbor goes into read-only mode. All modifications to the registry are prohibited. - -To avoid triggering the garbage collection process too frequently, the availability of the **GC Now** button is restricted. Garbage collection can be only run once per minute. - -### Schedule Garbage Collection - -1. Expand **Administration**, and select **Garbage Collection**. -1. Select the **'Garbage Collection'** tab. -1. Use the drop down-menu to select how often to run garbage collection. - ![Schedule garbage collection](img/gc_policy.png) - * **None**: No garbage collection is scheduled. - * **Hourly**: Run garbage collection at the beginning of every hour. - * **Daily**: Run garbage collection at midnight every day. - * **Weekly**: Run garbage collection at midnight every Saturday. - * **Custom**: Run garbage collection according to a `cron` job. -1. Click **Save**. -1. Select the **History** tab to view records of the 10 most recent garbage collection runs. - ![Garbage collection history](img/gc_history.png) -1. Click on the **Logs** link to view the related logs. - -## Build history - -Build history make it easy to see the contents of a container image, find the code which bulids an image, or locate the image for a source repository. - -In Harbor portal, enter your project, select the repository, click on the link of tag name you'd like to see its build history, the detail page will be opened. Then switch to `Build History` tab, you can see the build history information. - -![build_ history](img/build_history.png) - -## Robot Accounts - -You can create robot accounts to run automated operations. Robot accounts have the following limitations: - -1. Robot Accounts cannot log in to the Harbor interface. -1. Robot Accounts can only perform operations by using the Docker and Helm CLIs. - -### Add a Robot Account - -1. Log in to the Harbor interface with an account that has at least project administrator privileges. -1. Go to **Projects**, select a project, and select **Robot Accounts**. - - ![Robot accounts](img/robotaccount/add_robot_account.png) -1. Click **New Robot Account**. -1. Enter a name and an optional description for this robot account. -1. Grant permission to the robot account to push images and to push and pull Helm charts. - - Robot accounts can always pull images, so you cannot deselect this option. - - ![Add a robot account](img/robotaccount/add_robot_account_2.png) -1. Click **Save**. -1. In the confirmation window, click **Export to File** to download the access token as a JSON file, or click the clipboard icon to copy its contents to the clipboard. - - ![copy_robot_account_token](img/robotaccount/copy_robot_account_token.png) - - **IMPORTANT**: Harbor does not store robot account tokens, so you must either download the token JSON or copy and paste its contents into a text file. There is no way to get the token from Harbor after you have created the robot account. - - The new robot account appears as `robot$account_name` in the list of robot accounts. The `robot$` prefix makes it easily distinguishable from a normal Harbor user account. - - ![New robot account](img/robotaccount/new_robot_account.png) -1. To delete or disable a robot account, select the account in the list, and select **Disable account** or **Delete** from the Action drop-down menu. - - ![Disable or delete a robot account](img/robotaccount/disable_delete_robot_account.png) - -### Configure the Expiry Period of Robot Accounts - -By default, robot accounts expire after 30 days. You can set a longer or shorter lifespan for robot accounts by modifying the expiry period for robot account tokens. The expiry period applies to all robot accounts in all projects. - -1. Log in to the Harbor interface with an account that has Harbor system administrator privileges. -1. Go to **Configuration** and select **System Settings**. -1. In the **Robot Token Expiration (Days)** row, modify the number of days after which robot account tokens expire. - - ![Set robot account token expiry](img/robotaccount/set_robot_account_token_duration.png) - -### Authenticate with a Robot Account - -To use a robot account in an automated process, for example a script, use `docker login` and provide the credentials of the robot account. - -
-docker login harbor_address
-Username: robot$account_name
-Password: robot_account_token
-
- -## Tag Retention Rules - -A repository can rapidly accumulate a large number of image tags, many of which might not be required after a given time or once they have been superseded by a subsequent image build. These excess tags can obviously consume large quantities of storage capacity. As a Harbor system administrator, you can define rules that govern how many tags of a given repository to retain, or for how long to retain certain tags. - -### How Tag Retention Rules Work - -You define tag retention rules on repositories, not on projects. This allows for greater granularity when defining your retention rules. As the name suggests, when you define a retention rule for a repository, you are identifying which tags to retain. You do not define rules to explicitly remove tags. Rather, when you set a rule, any tags in a repository that are not identified as being eligible for retention are discarded. - -A tag retention rule has 3 filters that are applied sequentially, as described in the following table. - -|Order|Filter|Description| -|---|---|---| -|First|Repository or repositories|Identify the repository or repositories on which to apply the rule. You can identify repositories that either have a certain name or name fragment, or that do not have that name or name fragment. Wild cards (for example `*repo`, `repo*`, and `**`) are permitted. The repository filter is applied first to mark the repositories to which to apply the retention rule. The identified repositories are earmarked for further matching based on the tag criteria. No action is taken on the nonspecified repositories at this stage.| -|Second|Quantity to retain|Set which tags to retain either by specifying a maximum number of tags, or by specifying a maximum period for which to retain tags.| -|Third|Tags to retain|Identify the tag or tags on which to apply the rule. You can identify tags that either have a certain name or name fragment, or that do not have that name or name fragment. Wild cards (for example `*tag`, `tag*`, and `**`) are permitted.| - -For information about how the `**` wildcard is applied, see https://github.com/bmatcuk/doublestar#patterns. - -#### Example 1 - -- You have 5 repositories in a project, repositories A to E. - - Repository A has 100 image tags, all of which have been pulled in the last week. - - Repositories B to E each have 6 images, none of which have been pulled in the last month. -- You set the repository filter to `**`, meaning that all repositories in the project are included. -- You set the retention policy to retain the 10 most recently pulled images in each repository. -- You set the tag filter to `**`, meaning that all tags in the repository are included. - -In this example the rule retains the 10 most recently pulled images in repository A, and all 6 of the images in each of the 4 repositories B to E. So, a total of 34 image tags are retained in the project. In other words, the rule does not treat all of the images in repositories A to E as a single pool from which to choose the 10 most recent images. So, even if the 11th to 100th tags in repository A have been pulled more recently than any of the tags in repositories B to E, all of the tags in repositories B to E are retained, because each of those repositories has fewer than 10 tags. - -#### Example 2 - -This example uses the same project and repositories as example 1, but sets the retention policy to retain the images in each repository that have been pulled in the last 7 days. - -In this case, all of the images in repository A are retained because they have been pulled in the last 7 days. None of the images in repositories B to E are retained, because none of them has been pulled in the last week. In this example, 100 images are retained, as opposed to 34 images in example 1. - -#### Tag Retention Rules and Native Docker Tag Deletion - -**WARNING**: Due to native Docker tag deletion behavior, there is an issue with the current retention policy implementation. If you have multiple tags that refer to the same SHA digest, and if a subset of these tags are marked for deletion by a configured retention policy, all of the remaining tags would also be deleted. This violates the retention policy, so in this case all of the tags are retained. This issue will be addressed in a future update release, so that tag retention policies can delete tags without deleting the digest and other shared tags. - -For example, you have following tags, listed according to their push time, and all of them refer to the same SHA digest: - -- `harbor-1.8`, pushed 8/14/2019 12:00am -- `harbor-release`, pushed 8/14/2019 03:00am -- `harbor-nightly`, pushed 8/14/2019 06:00am -- `harbor-latest`, pushed 8/14/2019 09:00am - -You configure a retention policy to retain the two latest tags that match `harbor-*`, so that `harbor-rc` and `harbor-latest` are deleted. However, since all tags refer to the same SHA digest, this policy would also delete the tags `harbor-1.8` and `harbor-release`, so all tags are retained. - -### Combining Rules on a Repository - -You can define up to 15 rules per project. You can apply multiple rules to a repository or set of repositories. When you apply multiple rules to a repository, they are applied with `OR` logic rather than with `AND` logic. In this way, there is no prioritization of application of the rules on a given repository. Rules run concurrently in the background, and the resulting sets from each rule are combined at the end of the run. - -#### Example 3 - -This example uses the same project and repositories as examples 1 and 2, but sets two rules: - -- Rule 1: Retain all of the images in each repository that have been pulled in the last 7 days. -- Rule 2: Retain a maximum number of 10 images in each repository. - -For repository A, rule 1 retains all of the images because they have all been pulled in the last week. Rule 2 retains the 10 most recently pulled images. So, since the two rules are applied with an `OR` relationship, all 100 images are retained in repository A. - -For repositories B-E, rule 1 will retain 0 images as no images are pulled in the last week. Rule 2 will retain all 6 images because 6 < 10. So, since the two rules are applied with an `OR` relationship, for repositories B-E, each repository will keep all 6 images. - -In this example, all of the images are retained. - -#### Example 4 - -This example uses a different repository to the previous examples. - -- You have a repository that has 12 tags: - - |Production|Release Candidate|Release| - |---|---|---| - |`2.1-your_repo-prod`|`2.1-your_repo-rc`|`2.1-your_repo-release`| - |`2.2-your_repo-prod`|`2.2-your_repo-rc`|`2.2-your_repo-release`| - |`3.1-your_repo-prod`|`3.1-your_repo-rc`|`3.1-your_repo-release`| - |`4.4-your_repo-prod`|`4.4-your_repo-rc`|`4.4-your_repo-release`| - -- You define three tag retention rules on this repository: - - Retain the 10 most recently pushed image tags that start with `2`. - - Retain the 10 most recently pushed image tags that end with `-prod`. - - Retain all tags that do not include `2.1-your_repo-prod`. - -In this example, the rules are applied to the following 7 tags: - -- `2.1-your_repo-rc` -- `2.1-your_repo-release` -- `2.2-your_repo-prod` -- `2.2-your_repo-rc` -- `2.2-your_repo-release` -- `3.1-your_repo-prod` -- `4.4-your_repo-prod` - -### How Tag Retention Rules Interact with Project Quotas - -The Harbor system administrator can set a maximum on the number of tags that a project can contain and the amount of storage that it can consume. For information about project quotas, see [Set Project Quotas](#set-project-quotas). - -If you set a quota on a project, this quota cannot be exceeded. The quota is applied to a project even if you set a retention rule that would exceed it. In other words, you cannot use retention rules to bypass quotas. - -### Configure Tag Retention Rules - -1. Log in to the Harbor interface with an account that has at least project administrator privileges. -1. Go to **Projects**, select a project, and select **Tag Retention**. - - ![Tag options](img/tag-retention1.png) -1. Click **Add Rule** to add a rule. -1. In the **Repositories** drop-down menu, select **matching** or **excluding**. - ![Select repositories](img/tag-retention2.png) -1. In the **Repositories** text box, identify the repositories on which to apply the rule. - - You can define the repositories on which to apply the rule by entering the following information: - - - A repository name, for example `my_repo_1`. - - A comma-separated list of repository names, for example `my_repo_1,my_repo_2,your_repo_3`. - - A partial repository name with wildcards, for example `my_*`, `*_3`, or `*_repo_*`. - - `**` to apply the rule to all of the repositories in the project. - - If you selected **matching**, the rule is applied to the repositories you identified. If you selected **excluding**, the rule is applied to all of the repositories in the project except for the ones that you identified. -1. In the **By image count or number of days** drop-down menu, define how many tags to retain or the period to retain tags. - ![Select retention criteria](img/tag-retention3.png) - - |Option|Description| - |---|---| - |**retain the most recently pushed # images**|Enter the maximum number of images to retain, keeping the ones that have been pushed most recently. There is no maximum age for an image.| - |**retain the most recently pulled # images**|Enter the maximum number of images to retain, keeping only the ones that have been pulled recently. There is no maximum age for an image.| - |**retain the images pushed within the last # days**|Enter the number of days to retain images, keeping only the ones that have been pushed during this period. There is no maximum number of images.| - |**retain the images pulled within the last # days**|Enter the number of days to retain images, keeping only the ones that have been pulled during this period. There is no maximum number of images.| - |**retain always**|Always retain the images identified by this rule.| - -1. In the **Tags** drop-down menu, select **matching** or **excluding**. -1. In the **Tags** text box, identify the tags on which to apply the rule. - - You can define the tags on which to apply the rule by entering the following information: - - - A tag name, for example `my_tag_1`. - - A comma-separated list of tag names, for example `my_tag_1,my_tag_2,your_tag_3`. - - A partial tag name with wildcards, for example `my_*`, `*_3`, or `*_tag_*`. - - `**` to apply the rule to all of the tags in the project. - - If you selected **matching**, the rule is applied to the tags you identified. If you selected **excluding**, the rule is applied to all of the tags in the repository except for the ones that you identified. -1. Click **Add** to save the rule. -1. (Optional) Click **Add Rule** to add more rules, up to a maximum of 15 per project. -1. (Optional) Under Schedule, click **Edit** and select how often to run the rule. - - ![Select retention criteria](img/tag-retention4.png) - - If you select **Custom**, enter a cron job command to schedule the rule. - - **NOTE**: If you define multiple rules, the schedule is applied to all of the rules. You cannot schedule different rules to run at different times. -1. Click **Dry Run** to test the rule or rules that you have defined. -1. Click **Run Now** to run the rule immediately. - -**WARNING**: You cannot revert a rule after you run it. It is strongly recommended to perform a dry run before you run rules. - -To modify an existing rule, use the **Action** drop-down menu next to a rule to disable, edit, or delete that rule. - -![Modify tag retention rules](img/tag-retention5.png) - -## Tag Immutability Rules - -By default, users can repeatedly push an image with the same tag to repositories in Harbor. This causes the previous image to effectively be overwritten with each push, in that the tag now points to a different image and the image that previously used the tag now becomes tagless. This is due to the Docker implementation, that does not enforce the mapping between an image tag and the image digest. This can be undesirable in certain cases, because the tag can no longer be trusted to identify the image version. The sha256 digest remains reliable and always points to the same build, but it is not rendered in a human-readable format. - -Moreover, the Docker implementation requires that deleting a tag results in the deletion of all other tags that point to the same digest, causing unwanted image deletions. - -To prevent this, Harbor allows you to configure tag immutability at the project level, so that images with certain tags cannot be pushed into Harbor if their tags match existing tags. This prevents existing images from being overwritten. Tag immutability guarantees that an immutable tagged image cannot be deleted, and cannot be altered through repushing, retagging, or replication. - -Immutability rules use `OR` logic, so if you set multiple rules and a tag is matched by any of those rules, it is marked as immutable. - -### How Immutable Tags Prevent Tag Deletion - -Tags that share a common digest cannot be deleted even if only a single tag is configured as immutable. For example: - -1. In a project, set an immutable tag rule that matches the image and tag `hello-world:v1`. -1. In the Docker client, pull `hello-world:v1` and retag it to `hello-world:v2`. -1. Push `hello-world:v2` to the same project. -1. In the Harbor interface, attempt to delete `hello-world:v2`. - -In this case, you cannot delete `hello-world:v2` because it shares the sha256 digest with `hello-world:v1`, and `hello-world:v1` is an immutable tag. - -### Create a Tag Immutability Rule - -1. Log in to the Harbor interface with an account that has at least project administrator privileges. -1. Go to **Projects**, select a project, and select **Tag Immutability**. - - ![Add an immutability rule](img/tag-immutability.png) -1. Click **Add Rule**. - - - In the **Respositories** row, enter a comma-separated list of repositories to which to either apply or exclude from the rule by selecting either **matching** or **excluding** from the drop-down menu. - - In the **Tags** row, enter a comma-separated list of tags to which to either apply or exclude from the rule by selecting either **matching** or **excluding** from the drop-down menu. - - ![Add an immutability rule](img/add-immutability-rule.png) -1. Click **Add** to save the rule. - - You can add a maximum of 15 immutability rules per project. - - After you add a rule, any tags that are identified by the rule are marked **Immutable** in the Repositories tab. -1. To modify an existing rule, use the **Action** drop-down menu next to a rule to disable, edit, or delete that rule. - - ![Immutability rules](img/edit-tag-immutability.png) - -### Example - -To make all tags for all repositories in the project immutable, set the following options: - -- Set **For the respositories** to **matching** and enter `**`. -- Set **Tags** to **matching** and enter `**`. - -To allow the tags `rc`, `test`, and `nightly` to be overwritten but make all other tags immutable, set the following options: - -- Set **For the respositories** to **matching** and enter `**`. -- Set **Tags** to **excluding** and enter `rc,test,nightly`. - -## Webhook Notifications - -If you are a project administrator, you can configure a connection from a project in Harbor to a webhook endpoint. If you configure webhooks, Harbor notifies the webhook endpoint of certain events that occur in the project. Webhooks allow you to integrate Harbor with other tools to streamline continuous integration and development processes. - -The action that is taken upon receiving a notification from a Harbor project depends on your continuous integration and development processes. For example, by configuring Harbor to send a `POST` request to a webhook listener at an endpoint of your choice, you can trigger a build and deployment of an application whenever there is a change to an image in the repository. - -### Supported Events - -You can define one webhook endpoint per project. Webhook notifications provide information about events in JSON format and are delivered by `HTTP` or `HTTPS POST` to an existing webhhook endpoint URL that you provide. The following table describes the events that trigger notifications and the contents of each notification. - -|Event|Webhook Event Type|Contents of Notification| -|---|---|---| -|Push image to registry|`IMAGE PUSH`|Repository namespace name, repository name, resource URL, tags, manifest digest, image name, push time timestamp, username of user who pushed image| -|Pull manifest from registry|`IMAGE PULL`|Repository namespace name, repository name, manifest digest, image name, pull time timestamp, username of user who pulled image| -|Delete manifest from registry|`IMAGE DELETE`|Repository namespace name, repository name, manifest digest, image name, image size, delete time timestamp, username of user who deleted image| -|Upload Helm chart to registry|`CHART PUSH`|Repository name, chart name, chart type, chart version, chart size, tag, timestamp of push, username of user who uploaded chart| -|Download Helm chart from registry|`CHART PULL`|Repository name, chart name, chart type, chart version, chart size, tag, timestamp of push, username of user who pulled chart| -|Delete Helm chart from registry|`CHART DELETE`|Repository name, chart name, chart type, chart version, chart size, tag, timestamp of delete, username of user who deleted chart| -|Image scan completed|`IMAGE SCAN COMPLETED`|Repository namespace name, repository name, tag scanned, image name, number of critical issues, number of major issues, number of minor issues, last scan status, scan completion time timestamp, vulnerability information (CVE ID, description, link to CVE, criticality, URL for any fix), username of user who performed scan| -|Image scan failed|`IMAGE SCAN FAILED`|Repository namespace name, repository name, tag scanned, image name, error that occurred, username of user who performed scan| -|Project quota exceeded|`PROJECT QUOTA EXCEED`|Repository namespace name, repository name, tags, manifest digest, image name, push time timestamp, username of user who pushed image| - -#### JSON Payload Format - -The webhook notification is delivered in JSON format. The following example shows the JSON notification for a push image event: - -``` -{ - "event_type": "pushImage" - "events": [ - { - "project": "prj", - "repo_name": "repo1", - "tag": "latest", - "full_name": "prj/repo1", - "trigger_time": 158322233213, - "image_id": "9e2c9d5f44efbb6ee83aecd17a120c513047d289d142ec5738c9f02f9b24ad07", - "project_type": "Private" - } - ] -} -``` - -### Webhook Endpoint Recommendations - -The endpoint that receives the webhook should ideally have a webhook listener that is capable of interpreting the payload and acting upon the information it contains. For example, running a shell script. - -### Example Use Cases - -You can configure your continuous integration and development infrastructure so that it performs the following types of operations when it receives a webhook notification from Harbor. - -- Image push: - - Trigger a new build immediately following a push on selected repositories or tags. - - Notify services or applications that use the image that a new image is available and pull it. - - Scan the image using Clair. - - Replicate the image to remote registries. -- Image scanning: - - If a vulnerability is found, rescan the image or replicate it to another registry. - - If the scan passes, deploy the image. - -### Configure Webhooks - -1. Log in to the Harbor interface with an account that has at least project administrator privileges. -1. Go to **Projects**, select a project, and select **Webhooks**. - - ![Webhooks option](img/webhooks1.png) -1. Enter the URL for your webhook endpoint listener. -1. If your webhook listener implements authentication, enter the authentication header. -1. To implement `HTTPS POST` instead of `HTTP POST`, select the **Verifiy Remote Certficate** check box. - - ![Webhook URL](img/webhooks2.png) -1. Click **Test Endpoint** to make sure that Harbor can connect to the listener. -1. Click **Continue** to create the webhook. - -When you have created the webhook, you see the status of the different notifications and the timestamp of the last time each notification was triggered. You can click **Disable** to disable notifications. - -**NOTE**: You can only disable and reenable all notifications. You cannot disable and enable selected notifications. - -![Webhook Status](img/webhooks3.png) - -If a webhook notification fails to send, or if it receives an HTTP error response with a code other than `2xx`, the notification is re-sent based on the configuration that you set in `harbor.yml`. - -### Globally Enable and Disable Webhooks - -As a Harbor system administrator, you can enable and disable webhook notifications for all projects. - -1. Go to **Configuration** > **System Settings**. -1. Scroll down and check or uncheck the **Webhooks enabled** check box. - - ![Enable/disable webhooks](img/webhooks4.png) - -## API Explorer - -Harbor integrated swagger UI from 1.8. That means all apis can be invoked through UI. Normally, user have 2 ways to navigate to API Explorer. - -1. User can login harbor, and click the "API EXPLORER" button.All apis will be invoked with current user authorization. -![navigation bar](img/api_explorer_btn.png) - - -2. User can navigate to swagger page by ip address by router "devcenter". For example: https://10.192.111.118/devcenter. After go to the page, need to click "authorize" button to give basic authentication to all apis. All apis will be invoked with the authorized user authorization. -![authentication](img/authorize.png) - +This content has moved. For the 1.10 docs, please go to https://github.com/goharbor/harbor/blob/master/docs/1.10/index.md. +For older versions of the docs, please select the appropriate `release-1.xx.x` branch and go to the `docs` folder. \ No newline at end of file