Upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor.git synced 2024-11-16 07:15:13 +01:00
Code Issues Projects Releases Wiki Activity

update readme & installation guide

Browse Source
This commit is contained in:
Henry Zhang 2016-04-08 17:26:53 +08:00
parent 2cfbbda2a3
commit 659e8a9e10
2 changed files with 29 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -17,7 +17,7 @@ Project Harbor is an enterprise-class registry server. It extends the open sourc
* **RESTful API**: RESTful APIs are provided for most administrative operations of Harbor. The integration with other management softwares becomes easy. * **RESTful API**: RESTful APIs are provided for most administrative operations of Harbor. The integration with other management softwares becomes easy.
### Getting Started ### Getting Started
Harbor is self-contained and can be easily deployed via docker-compose. The below is a quick-start guide. Refer to the [Installation and Configuration Guide](docs/installation_guide.md) for detail information. Harbor is self-contained and can be easily deployed via docker-compose. The below are quick-start steps. Refer to the [Installation and Configuration Guide](docs/installation_guide.md) for detail information.
**System requirements:** **System requirements:**
Harbor only works with docker 1.10+ and docker-compose 1.6.0+ . Harbor only works with docker 1.10+ and docker-compose 1.6.0+ .
@ -28,7 +28,7 @@ The host must be connected to the Internet.
```sh ```sh
$ git clone https://github.com/vmware/harbor $ git clone https://github.com/vmware/harbor
``` ```
2. Edit the file **Deploy/harbor.cfg**, make necessary configuration changes such as hostname, admin password and mail server. Refer to [Installation Guide](docs/installation_guide.md) for more info. 2. Edit the file **Deploy/harbor.cfg**, make necessary configuration changes such as hostname, admin password and mail server. Refer to [Installation and Configuration Guide](docs/installation_guide.md) for more info.
3. Install Harbor by the following commands. It may take a while for the docker-compose process to finish. 3. Install Harbor by the following commands. It may take a while for the docker-compose process to finish.

50
docs/installation_guide.md
View File

@ -1,8 +1,8 @@
# Installation and Configuration Guide of Harbor # Installation and Configuration Guide of Harbor
Harbor can be installed by two approaches: Harbor can be installed by two approaches:
1. Install from the source code, which goes through a full build process. Internet connection is required. 1. Installing from the source code, which goes through a full build process. Internet connection is required.
2. Install via a pre-built installation package, which saves time for building the code. Further, it provides a way to install Harbor to a host that is isolated from the Internet (offline installation). 2. Installing via a pre-built installation package, which saves time for building the code. Further, it provides a way to install Harbor to a host that is isolated from the Internet (offline installation).
This guide describes both approaches and their usage. This guide describes both approaches and their usage.
@ -13,14 +13,16 @@ Before deploying Harbor, the target host requires Python, Docker, Docker Compose
* The Docker engine should be version 1.10 or higher. For the details to install Docker engine, please refer to: https://docs.docker.com/engine/installation/ * The Docker engine should be version 1.10 or higher. For the details to install Docker engine, please refer to: https://docs.docker.com/engine/installation/
* The Docker Compose needs to be version 1.6.0 or higher. For the details to install Docker compose, please refer to: https://docs.docker.com/compose/install/ * The Docker Compose needs to be version 1.6.0 or higher. For the details to install Docker compose, please refer to: https://docs.docker.com/compose/install/
## Install Harbor from the source code ## Installing Harbor from the source code
To install from the source, the target host must be connected to the Internet. To install from the source, the target host must be connected to the Internet.
#### Get the source code: #### Getting the source code:
```sh
$ git clone https://github.com/vmware/harbor ```sh
``` $ git clone https://github.com/vmware/harbor
#### Configure Harbor ```
#### Configuring Harbor
Before installing Harbor, you should configure the parameters in the file **harbor.cfg**. You then execute the **prepare** script to generate configuration files for Harbor's containers. Finally, you use Docker Compose to start Harbor. Before installing Harbor, you should configure the parameters in the file **harbor.cfg**. You then execute the **prepare** script to generate configuration files for Harbor's containers. Finally, you use Docker Compose to start Harbor.
At minimum, you need to change the **hostname** attribute in **harbor.cfg**. The description of each attribute is as follows: At minimum, you need to change the **hostname** attribute in **harbor.cfg**. The description of each attribute is as follows:
@ -41,10 +43,10 @@ At minimum, you need to change the **hostname** attribute in **harbor.cfg**. The
**db_password**: The password of root user of mySQL database. **db_password**: The password of root user of mySQL database.
**self_registration**: The flag to turn on or off the user self-registration function. If this flag is turned off, only an admin user can create new users in Harbor. The default value is on. **self_registration**: The flag to turn on or off the user self-registration function. If this flag is turned off, only an admin user can create new users in Harbor. The default value is on.
#### Build and start Harbor #### Building and starting Harbor
After configuring harbor.cfg, build and start Harbor by the following commands. Because it requires downloading necesary files from the Internet, it may take a while for the docker-compose process to finish. After configuring harbor.cfg, build and start Harbor by the following commands. Because it requires downloading necessary files from the Internet, it may take a while for the docker-compose process to finish.
```sh ```sh
$ cd Deploy $ cd Deploy
$ ./prepare $ ./prepare
@ -55,7 +57,7 @@ After configuring harbor.cfg, build and start Harbor by the following commands.
The configuration files are ready, please use docker-compose to start the service. The configuration files are ready, please use docker-compose to start the service.
$ sudo docker-compose up -d $ sudo docker-compose up -d
``` ```
If everything works fine, you can open a browser to visit the admin portal at http://reg.yourdomain.com . The default administrator username and password are admin/Harbor12345 . If everything works fine, you can open a browser to visit the admin portal at http://reg.yourdomain.com . The default administrator username and password are admin/Harbor12345 .
@ -68,10 +70,10 @@ $ docker push reg.yourdomain.com/myproject/myrepo
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) .
#### Configure Harbor with HTTPS Access #### Configuring Harbor with HTTPS Access
Because Harbor does not ship with any certificates, it uses HTTP by default to serve registry requests. This makes it relatively simple to configure, especially for a development or testing environment. However, it is highly recommended that security be enabled for any production environment. Refer to [Configure Harbor with HTTPS Access](configure_https.md) if you want to enable HTTPS access to Harbor. Because Harbor does not ship with any certificates, it uses HTTP by default to serve registry requests. This makes it relatively simple to configure, especially for a development or testing environment. However, it is highly recommended that security be enabled for any production environment. Refer to [Configure Harbor with HTTPS Access](configure_https.md) if you want to enable HTTPS access to Harbor.
## Install Harbor via a pre-built installation package ## Installing Harbor via a pre-built installation package
A pre-built installation package of each release can be downloaded from the [release page](https://github.com/vmware/harbor/releases). After downloading the package file **harbor-<version>.tgz** , extract files in the package. A pre-built installation package of each release can be downloaded from the [release page](https://github.com/vmware/harbor/releases). After downloading the package file **harbor-<version>.tgz** , extract files in the package.
``` ```
@ -79,7 +81,7 @@ $ tar -xzvf harbor-0.1.1.tgz
$ cd harbor $ cd harbor
``` ```
Then configure Harbor by following instructions in Section [Configure Harbor](#markdown-header-configure-harbor). Next, run **prepare** script to generate config files and use docker compose to build Harbor's container images and eventually spin it up. Then configure Harbor by following instructions in Section [Configure Harbor](#configuring-harbor). Next, run **prepare** script to generate config files and use docker compose to build Harbor's container images and eventually spin it up.
``` ```
@ -94,11 +96,11 @@ $ sudo docker-compose up -d
...... ......
``` ```
### Deploy Harbor to a target machine that does not have Internet access ### Deploying Harbor to a target machine that does not have Internet access
When you run *docker-compose up* to start Harbor, it will pull base images from Docker Hub and build new images for the containers. This process requires accessing the Internet. If you want to deploy Harbor to a host that is not connected to the Internet, you need to prepare Harbor on a machine that has access to the Internet. After that, you export the images as tgz files and transfer them to the target machine, then load the tgz file into Docker's local image repo. When you run *docker-compose up* to start Harbor, it will pull base images from Docker Hub and build new images for the containers. This process requires accessing the Internet. If you want to deploy Harbor to a host that is not connected to the Internet, you need to prepare Harbor on a machine that has access to the Internet. After that, you export the images as tgz files and transfer them to the target machine. Then load the tgz file into Docker's local image repo.
#### Build and save images for offline installation #### Building and saving images for offline installation
On a machine that is connected to the Internet, extract files from the pre-built installation package. Then run command "docker-compose build" to build the images and use the script *save_image.sh* to export them as tar files. The tar files will be stored in **images** directory. Next, package everything in the directory **harbor** into a tgz file and transfer it to the target machine. This can be done by executing the following commands: On a machine that is connected to the Internet, extract files from the pre-built installation package. Then run command "docker-compose build" to build the images and use the script *save_image.sh* to export them as tar files. The tar files will be stored in *images/* directory. Next, package everything in the directory *harbor/* into a tgz file and transfer it to the target machine. This can be done by executing the following commands:
``` ```
$ cd harbor $ cd harbor
@ -119,8 +121,8 @@ $ cd ../
$ tar -cvzf harbor_offline-0.1.1.tgz harbor $ tar -cvzf harbor_offline-0.1.1.tgz harbor
``` ```
The file **harbor_offline-0.1.0.tgz** contains the images saved by previously steps and the files required to start Harbor. The file **harbor_offline-0.1.1.tgz** contains the images saved by previously steps and the files required to start Harbor.
You can use tools such as scp to transfer the file **harbor_offline-0.1.0.tgz** to the target machine that does not have Internet connection. On the target machine, you can execute the following commands to start Harbor. Again, before running the **prepare** script, be sure to update **harbor.cfg** to reflect the right configuration of the target machine. (Refer to Section [Configure Harbor](#markdown-header-configure-harbor) .) You can use tools such as scp to transfer the file **harbor_offline-0.1.1.tgz** to the target machine that does not have Internet connection. On the target machine, you can execute the following commands to start Harbor. Again, before running the **prepare** script, be sure to update **harbor.cfg** to reflect the right configuration of the target machine. (Refer to Section [Configure Harbor](#configuring-harbor) .)
``` ```
$ tar -xzvf harbor_offline-0.1.1.tgz $ tar -xzvf harbor_offline-0.1.1.tgz
$ cd harbor $ cd harbor
@ -142,13 +144,13 @@ Generated configuration file: ./config/ui/env
Generated configuration file: ./config/ui/app.conf Generated configuration file: ./config/ui/app.conf
Generated configuration file: ./config/registry/config.yml Generated configuration file: ./config/registry/config.yml
Generated configuration file: ./config/db/env Generated configuration file: ./config/db/env
The configuration files are ready, please use docker-compose to start the service. The configuration files are ready, please use docker-compose to start the service.
# Build the images and then start the services # Build the images and then start the services
$ sudo docker-compose up -d $ sudo docker-compose up -d
``` ```
### Manage Harbor's lifecycle ### Managing Harbor's lifecycle
Harbor is composed of a few containers which are deployed via docker-compose, you can use docker-compose to manage the lifecycle of the containers. Below are a few useful commands: Harbor is composed of a few containers which are deployed via docker-compose, you can use docker-compose to manage the lifecycle of the containers. Below are a few useful commands:
Build and start Harbor: Build and start Harbor:
@ -189,7 +191,7 @@ Removing harbor_registry_1 ... done
Removing harbor_mysql_1 ... done Removing harbor_mysql_1 ... done
``` ```
Remove Harbor's database and image data (for a clean reinstallation): Remove Harbor's database and image data (for a clean re-installation):
```sh ```sh
$ rm -r /data/database $ rm -r /data/database
$ rm -r /data/registry $ rm -r /data/registry