mirror of https://github.com/goharbor/harbor.git
update docs
This commit is contained in:
Henry Zhang
parent
98bf17e007
commit
136e0bbda3
63
README.md
63
README.md
|
|
@ -9,56 +9,22 @@ Project Harbor is an enterprise-class registry server that stores and distribute
|
|||
|
||||
### Features
|
||||
* **Role based access control**: Users and repositories are organized via 'projects' and a user can have different permission for images under a project.
|
||||
* **Image replication**: Images can be replicated (synchronized) between multiple registry instances. Great for load balancing, high availability, hybrid and multi-cloud scenarios.
|
||||
* **Policy based image replication**: Images can be replicated (synchronized) between multiple registry instances. Great for load balancing, high availability, multi-datacenter, hybrid and multi-cloud scenarios.
|
||||
* **LDAP/AD support**: Harbor integrates with existing enterprise LDAP/AD for user authentication and management.
|
||||
* **Image deletion & garbage collection**: Images can be deleted and their space can be recycled.
|
||||
* **Graphical user portal**: User can easily browse, search repositories and manage projects.
|
||||
* **AD/LDAP support**: Harbor integrates with existing enterprise AD/LDAP for user authentication and management.
|
||||
* **Auditing**: All the operations to the repositories are tracked.
|
||||
* **RESTful API**: RESTful APIs for most administrative operations, easy to integrate with external systems.
|
||||
* **Easy deployment**: docker compose and offline installer.
|
||||
* **Easy deployment**: Provide both an online and offline installer. Besides, a virtual appliance for vSphere platform (OVA) is available.
|
||||
|
||||
### Install
|
||||
### Install & Run
|
||||
|
||||
**System requirements:**
|
||||
Harbor only works with docker 1.10.0+ and docker-compose 1.6.0+.
|
||||
|
||||
#### Install via docker compose
|
||||
On an Internet connected host, Harbor can be easily installed via docker-compose:
|
||||
Download binaries of **[Harbor release ](https://github.com/vmware/harbor/releases)** and follow **[Installation & Confiugration Guide](docs/installation_guide.md)** to install Harbor.
|
||||
|
||||
1. Get the source code:
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/vmware/harbor
|
||||
```
|
||||
2. Edit the file **make/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 with the following methods. Note that the build container images process can take a while.
|
||||
|
||||
I: Automation Install
|
||||
```sh
|
||||
$ make install
|
||||
```
|
||||
|
||||
II: Manual Install
|
||||
```sh
|
||||
$ cd make
|
||||
|
||||
$ ./prepare
|
||||
Generated configuration file: ./config/ui/env
|
||||
Generated configuration file: ./config/ui/app.conf
|
||||
Generated configuration file: ./config/registry/config.yml
|
||||
Generated configuration file: ./config/db/env
|
||||
|
||||
$ cd dev
|
||||
|
||||
$ docker-compose up -d
|
||||
```
|
||||
|
||||
#### Install via offline installer
|
||||
For those who do not want to clone the source, or need to install Harbor on a server not connected to the Internet, there is a pre-built installation package available. For details on how to download and use the installation package, please refer to [Installation and Configuration Guide](docs/installation_guide.md).
|
||||
|
||||
#### After installation
|
||||
_If everything worked properly, you should be able to open a browser to visit the admin portal at http://reg.yourdomain.com. Note that the default administrator username/password are admin/Harbor12345._
|
||||
After installation, if everything worked properly, you should be able to open a browser to visit the admin portal at http://reg.yourdomain.com. Note that the default administrator username/password are admin/Harbor12345.
|
||||
|
||||
Log in to the admin portal and create a new project, e.g. `myproject`. You can then use docker commands to login and push images (by default, the registry server listens on port 80):
|
||||
```sh
|
||||
|
|
@ -66,18 +32,16 @@ $ docker login reg.yourdomain.com
|
|||
$ docker push reg.yourdomain.com/myproject/myrepo:mytag
|
||||
```
|
||||
|
||||
### Upgrade
|
||||
Refer to **[User Guide](docs/user_guide.md)** for more details on how to use Harbor.
|
||||
|
||||
If you are upgrading Harbor from an older version with existing data, you need to migrate the data to fit the new database schema. For more details, please refer to [Data Migration Guide](docs/migration_guide.md).
|
||||
|
||||
### Run
|
||||
For information on how to use Harbor, please take a look at [User Guide](docs/user_guide.md).
|
||||
|
||||
### Community
|
||||
Get connected with Project Harbor's community and sign up with VMware {code} [https://code.vmware.com/join/](https://code.vmware.com/join/) to get invited to VMware {code} Slack group, Channel: #harbor. **Email:** harbor @ vmware.com .
|
||||
**Slack:** Join Harbor's community here: [VMware {code}](https://code.vmware.com/join/) Slack group, Channel: #harbor.
|
||||
**Email:** harbor@ vmware.com .
|
||||
**WeChat:** Add WeChat id *connect1688* to join WeChat discussion group.
|
||||
|
||||
### Contribution
|
||||
We welcome contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a pull request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq).
|
||||
We welcome contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a pull request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq). Contact us for any qustions: harbor@ vmware.com .
|
||||
|
||||
### License
|
||||
Harbor is available under the [Apache 2 license](LICENSE).
|
||||
|
|
@ -98,6 +62,3 @@ This project uses open source components which have additional licensing terms.
|
|||
|
||||
### Supporting Technologies
|
||||
<img alt="beego" src="docs/img/beegoLogo.png"> Harbor is powered by <a href="http://beego.me/">Beego</a>.
|
||||
|
||||
### About
|
||||
Project Harbor is initiated by the Advanced Technology Center (ATC), VMware China R&D.
|
||||
|
|
|
|||
|
|
@ -1,13 +1,21 @@
|
|||
# Installation and Configuration Guide
|
||||
Harbor can be installed by one of two installers:
|
||||
Harbor can be installed by one of three approaches:
|
||||
|
||||
- **Online installer:** The installer downloads Harbor's images from Docker hub. For this reason, the installer is very small in size.
|
||||
|
||||
- **Offline installer:** Use this installer when the host does not have Internet connection. The installer contains pre-built images so its size is larger.
|
||||
|
||||
Both installers can be downloaded from the [release page](https://github.com/vmware/harbor/releases). The installation process of both installers are the same, this guide describes the steps to install and configure Harbor.
|
||||
- **Virtual Appliance:** If you are installing Harbor as the registry component of vSphere Integrated Containers (VIC), or using Harbor as a standalone registry on vSphere platform, download the OVA version of Harbor.
|
||||
|
||||
In addition, the deployment instructions on Kubernetes has been created by the community. Refer to [make Harbor on Kubernetes](kubernetes_deployment.md) for details.
|
||||
All installers can be downloaded from the **[official release](https://github.com/vmware/harbor/releases)** page.
|
||||
|
||||
To install Harbor's virtual appliance, refer to the **[Harbor Installation Guide for OVA](installation_guide_ova.md)**.
|
||||
|
||||
This guide describes the steps to install and configure Harbor by using the online or offline installer. The installation processes are almost the same.
|
||||
|
||||
If you run a previous version of Harbor, you may need to migrate the data to fit the new database schema. For more details, please refer to **[Data Migration Guide](migration_guide.md)**.
|
||||
|
||||
In addition, the deployment instructions on Kubernetes has been created by the community. Refer to set up [Harbor on Kubernetes](kubernetes_deployment.md) for details.
|
||||
|
||||
## Prerequisites for the target host
|
||||
Harbor is deployed as several Docker containers, and, therefore, can be deployed on any Linux distribution that supports Docker. The target host requires Python, Docker, and Docker Compose to be installed.
|
||||
|
|
|
|||
|
|
@ -1,41 +1,42 @@
|
|||
# Install and Configure Harbor on vSphere using OVA
|
||||
This guide takes you through the steps about installing and configuring Harbor on vSphere using OVA.
|
||||
# Installing and Configuring Harbor on vSphere as Virtual Appliance
|
||||
|
||||
This guide walks you through the steps about installing and configuring Harbor on vSphere as an virtual appliance (OVA). If you are installing Harbor on a Linux host, refer to this **[Installation Guide](installation_guide.md)**.
|
||||
|
||||
## Installation
|
||||
1.Get URL or download the OVA file to your local disk from [release page](https://github.com/vmware/harbor/releases).
|
||||
1. Download the OVA file to your local disk from the **[official release page](https://github.com/vmware/harbor/releases)**.
|
||||
|
||||
2.Login vSphere web client. Right click on the datacenter, cluster or host which Harbor will be deployed on. Select "Deploy OVF Template" and open the import wizard.
|
||||
2. Log in vSphere web client. Right click on the datacenter, cluster or host which Harbor will be deployed on. Select "Deploy OVF Template" and open the import wizard.
|
||||
|
||||
|
||||
|
||||
3.Paste the URL of OVA file or select it from local disk and click "Next".
|
||||
3. Select the OVA file from your local disk and click "Next".
|
||||
|
||||
|
||||
|
||||
4.Review the OVF template details and click "Next".
|
||||
4. Review the OVF template details and click "Next".
|
||||
|
||||
|
||||
|
||||
5.Spefify a name and location for the deployed template.
|
||||
5. Spefify a name and a location for the virtual appliance.
|
||||
|
||||
|
||||
|
||||
6.Select the storage and virtual disk format, click "Next".
|
||||
6. Select the datastore and virtual disk format, click "Next".
|
||||
|
||||
|
||||
|
||||
7.Configure the networks the deployed template should use.
|
||||
7. Configure the network(s) the virtual appliance should be connected to.
|
||||
|
||||
|
||||
|
||||
8.Customize the properties of Harbor. The properties are described below. Note that at the very least, you just need to set the **Root Password**, **Harbor Admin Password** and **Database Password** properties.
|
||||
8. Customize the properties of Harbor. The properties are described below. Note that at the very least, you just need to set the **Root Password**, **Harbor Admin Password** and **Database Password** properties.
|
||||
|
||||
|
||||
|
||||
* Application
|
||||
* **Root Password**: The password of the root user. (8-128 characters)
|
||||
* **Harbor Admin Password**: The initial password of Harbor admin. It only works for the first time when Harbor starts. It has no effect after the first launch of Harbor. Change the admin password from UI after launching Harbor. (8-20 characters)
|
||||
* **Database Password**: The password of the root user of MySQL database. (8-128 characters)
|
||||
* Harbor
|
||||
* **Root Password**: The password of the root user.
|
||||
* **Harbor Admin Password**: The initial password of Harbor admin. It only works for the first time when Harbor starts. It has no effect after the first launch of Harbor. Change the admin password from UI after launching Harbor.
|
||||
* **Database Password**: The password of the root user of MySQL database.
|
||||
* **Authentication Mode**: The default authentication mode is db_auth, i.e. the credentials are stored in a local database. Set it to ldap_auth if you want to verify the user's credential against an LDAP/AD server.
|
||||
* **LDAP URL**: The URL of an LDAP/AD server.
|
||||
* **LDAP Search DN**: A user's DN who has the permission to search the LDAP/AD server. If your LDAP/AD server does not support anonymous search, you should configure this DN and LDAP Seach Password.
|
||||
|
|
@ -51,8 +52,8 @@ This guide takes you through the steps about installing and configuring Harbor o
|
|||
* **SSL Cert**: Paste in the content of a certificate file. If SSL Cert and SSL Cert Key are both set, HTTPS will be used.
|
||||
* **SSL Cert Key**: Paste in the content of certificate key file. If SSL Cert and SSL Cert Key are both set, HTTPS will be used.
|
||||
* **Self Registration**: Determine whether the self-registration is allowed or not when the authentication mode is database. Set this to off to disable a user's self-registration in Harbor.
|
||||
* **Verify Remote Cert**: Determine whether the image replication should verify the SSL certificate when it connects to a remote registry. Set this flag to off when the remote registry uses a self-signed or untrusted certificate.
|
||||
* **Garbage Collection**: When setting this to true, Harbor performs garbage collection everytime it boots up.
|
||||
* **Verify Remote Cert**: Determine whether the image replication should verify the certificate when it connects to a remote registry via TLS. Set this flag to off when the remote registry uses a self-signed or untrusted certificate.
|
||||
* **Garbage Collection**: When setting this to true, Harbor performs garbage collection everytime it boots up. The first time setting this flag to true needs to power off the VM and power it on again.
|
||||
|
||||
* Networking properties
|
||||
* **Default Gateway**: The default gateway address for this VM. Leave blank if DHCP is desired.
|
||||
|
|
@ -62,25 +63,30 @@ This guide takes you through the steps about installing and configuring Harbor o
|
|||
* **Network 1 IP Adress**: The IP address of this interface. Leave blank if DHCP is desired.
|
||||
* **Network 1 Netmask**: The netmask or prefix for this interface. Leave blank if DHCP is desired.
|
||||
|
||||
**Notes:** If you want to enable HTTPS with a self-signed certificate and have no idea how to generate it, refer to the "Getting a certificate" part of this [guide](https://github.com/vmware/harbor/blob/master/docs/configure_https.md#getting-a-certificate).
|
||||
**Notes:** If you want to enable HTTPS with a self-signed certificate, refer to the "Getting a certificate" part of this [guide](https://github.com/vmware/harbor/blob/master/docs/configure_https.md#getting-a-certificate) for generating a certificate.
|
||||
|
||||
After you complete the properties, click "Next".
|
||||
|
||||
9.Review your settings and click "Finish" to complete the installation.
|
||||
9. Review your settings and click "Finish" to complete the deployment.
|
||||
|
||||
|
||||
|
||||
10. Power on the virtual appliance. It may take a few minutes for the first bootup. The virtual appliance needs to initialize itself for configuration like netowrk address and password.
|
||||
|
||||
11. When the appliance is ready, check from vSphere Web Client for its IP address. Open a browser and type in the URL `http(s)://harbor_ip_address` or `http(s)://harbor_host_name`. Log in as the admin user and verify Harbor has been successfully installed.
|
||||
|
||||
## Reconfiguration
|
||||
If you want to reconfigure the properties of Harbor, follow the steps:
|
||||
1.Power off the VM which Harbor is deployed on.
|
||||
2.Right click on the VM and select "Edit Settings".
|
||||
If you want to change the properties of Harbor, follow the below steps:
|
||||
|
||||
1. **Power off** Harbor's virtual appliance.
|
||||
2. Right click on the VM and select "Edit Settings".
|
||||
|
||||
|
||||
|
||||
3.Click the "vApp Options" tab, reconfigure the properties and click "OK".
|
||||
3. Click the "vApp Options" tab, update the properties and click "OK".
|
||||
|
||||
|
||||
|
||||
4.Power on the VM.
|
||||
4. **Power on** the VM.
|
||||
|
||||
**Notes:** "Harbor Admin Password" and all networking properties can not be modified using this method after Harbor launched. Change the admin password from UI and change the networking properties in the OS level manually.
|
||||
**Note:** The initial admin password, root password of the virtual appliance, MySql root password, and all networking properties can not be modified using this method after Harbor's first launch. The password of the admin user should be changed in the admin portal. The root password of virtual appliance, as well as the networking settings, can be changed by logging in the virtural appliance and doing it in the Linux operating system.
|
||||
|
|
|
|||
Loading…
Reference in New Issue