update installation guide (#2930)

* update installation guide

* add perf turning.

* update per comments

* update per comments
This commit is contained in:
Yan 2017-08-04 18:04:14 +08:00 committed by GitHub
parent 302d5c4073
commit 957bd1722a

View File

@ -121,8 +121,8 @@ _NOTE: For detailed information on storage backend of a registry, refer to [Regi
#### Finishing installation and starting Harbor #### Finishing installation and starting Harbor
Once **harbor.cfg** and storage backend (optional) are configured, install and start Harbor using the ```install.sh``` script. Note that it may take some time for the online installer to download Harbor images from Docker hub. Once **harbor.cfg** and storage backend (optional) are configured, install and start Harbor using the ```install.sh``` script. Note that it may take some time for the online installer to download Harbor images from Docker hub.
##### Default installation (without Notary) ##### Default installation (without Notary/Clair)
After version 1.1.0, Harbor has integrated with Notary, but by default the installation does not include Notary service. After version 1.1.0, Harbor has integrated with Notary and Clair (for vulnerability scanning), but by default the installation does not include Notary or Clair service.
```sh ```sh
$ sudo ./install.sh $ sudo ./install.sh
@ -147,6 +147,20 @@ To install Harbor with Notary service, add a parameter when you run ```install.s
More information about Notary and Docker Content Trust, please refer to Docker's documentation: More information about Notary and Docker Content Trust, please refer to Docker's documentation:
https://docs.docker.com/engine/security/trust/content_trust/ https://docs.docker.com/engine/security/trust/content_trust/
##### Installation with Clair
To install Harbor with Clair service, add a parameter when you run ```install.sh```:
```sh
$ sudo ./install.sh --with-clair
```
For more information about Clair, please refer to Clair's documentation:
https://coreos.com/clair/docs/2.0.1/
**Note**: If you want to install both Notary and Clair, you must specify both parameters in the same command:
```sh
$ sudo ./install.sh --with-notary --with-clair
```
For information on how to use Harbor, please refer to **[User Guide of Harbor](user_guide.md)** . For information on how to use Harbor, please refer to **[User Guide of Harbor](user_guide.md)** .
#### Configuring Harbor with HTTPS access #### Configuring Harbor with HTTPS access
@ -210,6 +224,30 @@ $ sudo prepare --with-notary
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.notary.yml up -d $ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.notary.yml up -d
``` ```
#### _Managing lifecycle of Harbor when it's installed with Clair_
When Harbor is installed with Clair, an extra template file ```docker-compose.clair.yml``` is needed for docker-compose commands. The docker-compose commands to manage the lifecycle of Harbor are:
```
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.clair.yml [ up|down|ps|stop|start ]
```
For example, if you want to change configuration in ```harbor.cfg``` and re-deploy Harbor when it's installed with Clair, the following commands should be used:
```sh
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.clair.yml down -v
$ vim harbor.cfg
$ sudo prepare --with-clair
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.clair.yml up -d
```
#### _Managing lifecycle of Harbor when it's installed with Notary and Clair_
If you have installed Notary and Clair, you should include both components in the docker-compose and prepare commands:
```sh
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.notary.yml -f ./docker-compose.clair.yml down -v
$ vim harbor.cfg
$ sudo prepare --with-notary --with-clair
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.notary.yml -f ./docker-compose.clair.yml up -d
```
Please check the [Docker Compose command-line reference](https://docs.docker.com/compose/reference/) for more on docker-compose. Please check the [Docker Compose command-line reference](https://docs.docker.com/compose/reference/) for more on docker-compose.
### Persistent data and log files ### Persistent data and log files
@ -288,6 +326,9 @@ hostname = 192.168.0.2:8888
4.Re-deploy Harbor refering to previous section "Managing Harbor's lifecycle". 4.Re-deploy Harbor refering to previous section "Managing Harbor's lifecycle".
## Performance tuning
By default, Harbor limits the CPU usage of Clair container to 150000 and avoids its using up all the CPU resources. This is defined in the docker-compose.clair.yml file. You can modify it based on your hardware configuration.
## Troubleshooting ## Troubleshooting
1. When Harbor does not work properly, run the below commands to find out if all containers of Harbor are in **UP** status: 1. When Harbor does not work properly, run the below commands to find out if all containers of Harbor are in **UP** status:
``` ```