Upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor.git synced 2024-11-22 02:05:41 +01:00
Code Issues Projects Releases Wiki Activity

update docs for 1.2 (#2974)

Browse Source 
* update change log

* update documents

* update documents

* update AUTHORS

* update README

* update harbor.cfg

* remove unused files

* updated TOC of docs

* update REAME

* update README

* udpate docs for 1.2

* udpate authors

* updated installation guide

* updated migration guide

* updated migration guide
This commit is contained in:
Haining Henry Zhang 2017-08-07 14:38:10 +08:00 committed by Daniel Jiang
parent f40eb993a0
commit 43b2bce6b1
4 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
AUTHORS
View File

@ -5,15 +5,20 @@ Alexey Erkak <eryigin at mail.ru>
Allen Heavey <xheavey at gmail.com>
Amanda Zhang <amzhang at vmware.com>
Andre Cruz <andre at brpx.com>
Aron Parsons <aron at knackworks.com>
Aron Parsons <aron at knackworks.com>
Benniu Ji <benniuji at gmail.com>
Bin Liu <liubin0329 at gmail.com>
BhEaN <bhean at vandalsweb.com>
Bobby Zhang <junzhang at vmware.com>
Brian Christner <brian.christner at gmail.com>
Chaofeng Wu <chaofengw at vmware.com>
Casey Peel < >
Daniel Jiang <jiangd at vmware.com>
Deshi Xiao <xiaods at gmail.com>
Dmitry Lazurkin <dilaz03 at gmail.com>
Fangyuan Li <maplainfly at gmail.com>
Feileng Cui <feilengcui008 at gmail.com>
Fuhui Peng <srqh1120 at sina.com>
Guangping Fu <krystism at gmail.com>
Haining Henry Zhang <henryzhang at vmware.com>
Hao Xia <haox at vmware.com>
@ -21,19 +26,23 @@ Haoyuan <harryge00 at gmail.com>
Jack Liu <ljack at vmware.com>
Jessy Zhang <jessyz at vmware.com>
Jianye Li <li.jianye at gmail.com>
Kira <me at imkira.com>
Kira <me at imkira.com>
Kun Wang <kunw at vmware.com>
Mahesh Paolini-Subramanya <mahesh at dieswaytoofast.com>
Maxwell <710028463 at qq.com>
Meng Wei <weim at vmware.com>
Mizukoshi Masataka <m.mizukoshi.wakuwaku at gmail.com>
Nagarjun G <nagarjung.g at gmail.com>
Peng Zhao <zhaopeng1988 at gmail.com>
Penghao Cen <scorpiocph at gmail.com>
Phillip Gomez <gomez.phillip at gmail.com>
Robin Naundorf <r.naundorf at fh-muenster.de>
Samuel Archambault <sarchambault at lapresse.ca>
Shan Zhu <zhus at vmware.com>
Steven Zou <szou at vmware.com>
Ricardo Katz <rikatz at users.noreply.github.com>
Robin Yue <jmyue at hotmail.com>
Tim Chen Xiaoyu <837829664 at qq.com>
Tobe Chen <tobeg3oogle at gmail.com>
Victoria Zheng <vzheng at vmware.com>
Wenkai Yin <yinw at vmware.com>
@ -41,4 +50,7 @@ Xiaoxiao Zhou <xiaoxiaoz at vmware.com>
Xinkun Xu <xuxinkun at gmail.com>
Yahao He <bhe at vmware.com>
Yan Wang <wangyan at vmware.com>
Yixing Jia <yixingj at vmware.com>
Yong Hua <yhua at vmware.com>
Yufei Ma <myufei at vmware.com>

4
README.md
View File

@ -12,7 +12,8 @@ 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.
* **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.
* **Policy based image replication**: Images can be replicated (synchronized) between multiple registry instances, with auto-retry on errors. Great for load balancing, high availability, multi-datacenter, hybrid and multi-cloud scenarios.
* **Vulnerability Scanning**: Harbor scans images regularly and warns users of vulerabilities.
* **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.
* **Notary**: Image authenticity can be ensured.
@ -34,7 +35,6 @@ Refer to **[User Guide](docs/user_guide.md)** for more details on how to use Har
### Community
**Slack:** Join Harbor's community here: [VMware {code}](https://code.vmware.com/join/), Channel: #harbor.
**Email:** harbor@ vmware.com .
**WeChat Group:** Add WeChat id *connect1688* to join WeChat discussion group.
More info on [partners and users](partners.md).
### Contribution

2
docs/installation_guide.md
View File

@ -122,7 +122,7 @@ _NOTE: For detailed information on storage backend of a registry, refer to [Regi
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/Clair)
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.
Harbor has integrated with Notary and Clair (for vulnerability scanning). However, the default installation does not include Notary or Clair service.
```sh
$ sudo ./install.sh

16
docs/migration_guide.md
View File

@ -1,12 +1,13 @@
# Harbor upgrade and database migration guide
When upgrading your existing Habor instance to a newer version, you may need to migrate the data in your database. Refer to [change log](../migration/changelog.md) to find out whether there is any change in the database. If there is, you should go through the database migration process. Since the migration may alter the database schema, you should **always** back up your data before any migration.
When upgrading your existing Habor instance to a newer version, you may need to migrate the data in your database. Refer to [change log](../tools/migration/changelog.md) to find out whether there is any change in the database. If there is, you should go through the database migration process. Since the migration may alter the database schema, you should **always** back up your data before any migration.
*If your install Harbor for the first time, or the database version is the same as that of the lastest version, you do not need any database migration.*
**NOTE:** From 1.2, you need to use release version as the tag of migrator image. 'latest' is no longer used for new release.
**NOTE:**
- From v1.2 on, you need to use the release version as the tag of the migrator image. 'latest' is no longer used for new release.
**NOTE:** You must backup your data before any data migration.
- You must back up your data before any data migration.
### Upgrading Harbor and migrating data
@ -20,13 +21,13 @@ When upgrading your existing Habor instance to a newer version, you may need to
2. Back up Harbor's current files so that you can roll back to the current version when it is necessary.
```sh
cd ..
mv harbor /tmp/harbor
mv harbor /my_backup_dir/harbor
```
3. Get the lastest Harbor release package from Github:
https://github.com/vmware/harbor/releases
4. Before upgrading Harbor, perform database migration first. The migration tool is delivered as a docker image, so you should pull the image from docker hub:
4. Before upgrading Harbor, perform database migration first. The migration tool is delivered as a docker image, so you should pull the image from docker hub. Replace [tag] with the release version of Harbor (e.g. 1.2) in the below command:
```
docker pull vmware/harbor-db-migrator:[tag]
@ -62,7 +63,7 @@ you must make sure **auth_mode** is set to **ldap_auth** in `harbor.cfg` before
```
**NOTE:** After running the script, make sure you go through `harbor.cfg` to verify all the settings are correct. You can make changes to `harbor.cfg` as needed.
8. Under the directory `./harbor`, run the `./install.sh` script to install the new Harbor instance.
8. Under the directory `./harbor`, run the `./install.sh` script to install the new Harbor instance. If your choose to install Harbor with components like Notary and/or Clair, refer to [Installation & Configuration Guide](../docs/installation_guide.md) for more information.
### Roll back from an upgrade
For any reason, if you want to roll back to the previous version of Harbor, follow the below steps:
@ -86,7 +87,7 @@ For any reason, if you want to roll back to the previous version of Harbor, foll
4. Restore the older version package of Harbor.
```sh
mv /tmp/harbor harbor
mv /my_backup_dir/harbor harbor
```
5. Restart Harbor service using the previous configuration.
@ -95,6 +96,7 @@ For any reason, if you want to roll back to the previous version of Harbor, foll
cd harbor
./install.sh
```
**Note:** If your choose to install Harbor with components like Notary and/or Clair, refer to [Installation & Configuration Guide](../docs/installation_guide.md) for more information.
If your previous version of Harbor was installed from source code:
```sh