Skip to content

Commit 43b2bce

Browse files
hainingzhangreasonerjt
authored andcommitted
update docs for 1.2 (goharbor#2974)
* 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
1 parent f40eb99 commit 43b2bce

File tree

4 files changed

+26
-12
lines changed

4 files changed

+26
-12
lines changed

AUTHORS

+14-2
Original file line numberDiff line numberDiff line change
@@ -5,40 +5,52 @@ Alexey Erkak <eryigin at mail.ru>
55
Allen Heavey <xheavey at gmail.com>
66
Amanda Zhang <amzhang at vmware.com>
77
Andre Cruz <andre at brpx.com>
8-
Aron Parsons <aron at knackworks.com>
8+
Aron Parsons <aron at knackworks.com>
99
Benniu Ji <benniuji at gmail.com>
1010
Bin Liu <liubin0329 at gmail.com>
11+
BhEaN <bhean at vandalsweb.com>
1112
Bobby Zhang <junzhang at vmware.com>
1213
Brian Christner <brian.christner at gmail.com>
1314
Chaofeng Wu <chaofengw at vmware.com>
15+
Casey Peel < >
1416
Daniel Jiang <jiangd at vmware.com>
1517
Deshi Xiao <xiaods at gmail.com>
18+
Dmitry Lazurkin <dilaz03 at gmail.com>
19+
Fangyuan Li <maplainfly at gmail.com>
1620
Feileng Cui <feilengcui008 at gmail.com>
21+
Fuhui Peng <srqh1120 at sina.com>
1722
Guangping Fu <krystism at gmail.com>
1823
Haining Henry Zhang <henryzhang at vmware.com>
1924
Hao Xia <haox at vmware.com>
2025
Haoyuan <harryge00 at gmail.com>
2126
Jack Liu <ljack at vmware.com>
2227
Jessy Zhang <jessyz at vmware.com>
2328
Jianye Li <li.jianye at gmail.com>
24-
Kira <me at imkira.com>
29+
Kira <me at imkira.com>
2530
Kun Wang <kunw at vmware.com>
2631
Mahesh Paolini-Subramanya <mahesh at dieswaytoofast.com>
2732
Maxwell <710028463 at qq.com>
2833
Meng Wei <weim at vmware.com>
34+
Mizukoshi Masataka <m.mizukoshi.wakuwaku at gmail.com>
2935
Nagarjun G <nagarjung.g at gmail.com>
3036
Peng Zhao <zhaopeng1988 at gmail.com>
3137
Penghao Cen <scorpiocph at gmail.com>
3238
Phillip Gomez <gomez.phillip at gmail.com>
3339
Robin Naundorf <r.naundorf at fh-muenster.de>
40+
Samuel Archambault <sarchambault at lapresse.ca>
3441
Shan Zhu <zhus at vmware.com>
3542
Steven Zou <szou at vmware.com>
43+
Ricardo Katz <rikatz at users.noreply.github.com>
3644
Robin Yue <jmyue at hotmail.com>
45+
Tim Chen Xiaoyu <837829664 at qq.com>
3746
Tobe Chen <tobeg3oogle at gmail.com>
3847
Victoria Zheng <vzheng at vmware.com>
3948
Wenkai Yin <yinw at vmware.com>
4049
Xiaoxiao Zhou <xiaoxiaoz at vmware.com>
4150
Xinkun Xu <xuxinkun at gmail.com>
4251
Yahao He <bhe at vmware.com>
4352
Yan Wang <wangyan at vmware.com>
53+
Yixing Jia <yixingj at vmware.com>
4454
Yong Hua <yhua at vmware.com>
55+
Yufei Ma <myufei at vmware.com>
56+

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Project Harbor is an enterprise-class registry server that stores and distribute
1212

1313
### Features
1414
* **Role based access control**: Users and repositories are organized via 'projects' and a user can have different permission for images under a project.
15-
* **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.
15+
* **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.
16+
* **Vulnerability Scanning**: Harbor scans images regularly and warns users of vulerabilities.
1617
* **LDAP/AD support**: Harbor integrates with existing enterprise LDAP/AD for user authentication and management.
1718
* **Image deletion & garbage collection**: Images can be deleted and their space can be recycled.
1819
* **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
3435
### Community
3536
**Slack:** Join Harbor's community here: [VMware {code}](https://code.vmware.com/join/), Channel: #harbor.
3637
**Email:** harbor@ vmware.com .
37-
**WeChat Group:** Add WeChat id *connect1688* to join WeChat discussion group.
3838
More info on [partners and users](partners.md).
3939

4040
### Contribution

docs/installation_guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ _NOTE: For detailed information on storage backend of a registry, refer to [Regi
122122
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.
123123

124124
##### Default installation (without Notary/Clair)
125-
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.
125+
Harbor has integrated with Notary and Clair (for vulnerability scanning). However, the default installation does not include Notary or Clair service.
126126

127127
```sh
128128
$ sudo ./install.sh

docs/migration_guide.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Harbor upgrade and database migration guide
22

3-
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.
3+
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.
44

55
*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.*
66

7-
**NOTE:** From 1.2, you need to use release version as the tag of migrator image. 'latest' is no longer used for new release.
7+
**NOTE:**
8+
- 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.
89

9-
**NOTE:** You must backup your data before any data migration.
10+
- You must back up your data before any data migration.
1011

1112
### Upgrading Harbor and migrating data
1213

@@ -20,13 +21,13 @@ When upgrading your existing Habor instance to a newer version, you may need to
2021
2. Back up Harbor's current files so that you can roll back to the current version when it is necessary.
2122
```sh
2223
cd ..
23-
mv harbor /tmp/harbor
24+
mv harbor /my_backup_dir/harbor
2425
```
2526
2627
3. Get the lastest Harbor release package from Github:
2728
https://github.com/vmware/harbor/releases
2829
29-
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:
30+
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:
3031
3132
```
3233
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
6263
```
6364
**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.
6465
65-
8. Under the directory `./harbor`, run the `./install.sh` script to install the new Harbor instance.
66+
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.
6667
6768
### Roll back from an upgrade
6869
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
8687
8788
4. Restore the older version package of Harbor.
8889
```sh
89-
mv /tmp/harbor harbor
90+
mv /my_backup_dir/harbor harbor
9091
```
9192
9293
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
9596
cd harbor
9697
./install.sh
9798
```
99+
**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.
98100
99101
If your previous version of Harbor was installed from source code:
100102
```sh

0 commit comments

Comments
 (0)