diff --git a/docs/img/add_labels_to_images.png b/docs/img/add_labels_to_images.png index 9b75994b2..d74c6112a 100644 Binary files a/docs/img/add_labels_to_images.png and b/docs/img/add_labels_to_images.png differ diff --git a/docs/img/bar_chart.png b/docs/img/bar_chart.png index c4a499ce0..e701dd06b 100644 Binary files a/docs/img/bar_chart.png and b/docs/img/bar_chart.png differ diff --git a/docs/img/browse_project_repositories.png b/docs/img/browse_project_repositories.png index 3ac2897fe..13746d70c 100644 Binary files a/docs/img/browse_project_repositories.png and b/docs/img/browse_project_repositories.png differ diff --git a/docs/img/clair_not_ready.png b/docs/img/clair_not_ready.png index 5dd683165..c8a978856 100644 Binary files a/docs/img/clair_not_ready.png and b/docs/img/clair_not_ready.png differ diff --git a/docs/img/clair_not_ready2.png b/docs/img/clair_not_ready2.png index 8da28622d..0fa425941 100644 Binary files a/docs/img/clair_not_ready2.png and b/docs/img/clair_not_ready2.png differ diff --git a/docs/img/clair_ready.png b/docs/img/clair_ready.png index fc2845ec8..9d6d97f4d 100644 Binary files a/docs/img/clair_ready.png and b/docs/img/clair_ready.png differ diff --git a/docs/img/content_trust.png b/docs/img/content_trust.png index a40eef94b..55d716ad6 100644 Binary files a/docs/img/content_trust.png and b/docs/img/content_trust.png differ diff --git a/docs/img/create_rule.png b/docs/img/create_rule.png index c7e869af6..4269bc014 100644 Binary files a/docs/img/create_rule.png and b/docs/img/create_rule.png differ diff --git a/docs/img/delete_rule.png b/docs/img/delete_rule.png index 0c29e82eb..fd8a9ac55 100644 Binary files a/docs/img/delete_rule.png and b/docs/img/delete_rule.png differ diff --git a/docs/img/edit_description.png b/docs/img/edit_description.png index 859308be2..64000e917 100644 Binary files a/docs/img/edit_description.png and b/docs/img/edit_description.png differ diff --git a/docs/img/filter_images_by_label.png b/docs/img/filter_images_by_label.png index a7f847f62..556505ed5 100644 Binary files a/docs/img/filter_images_by_label.png and b/docs/img/filter_images_by_label.png differ diff --git a/docs/img/ldap_auth.png b/docs/img/ldap_auth.png index 3fc2ed974..fb4a1a845 100644 Binary files a/docs/img/ldap_auth.png and b/docs/img/ldap_auth.png differ diff --git a/docs/img/list_stop_jobs.png b/docs/img/list_stop_jobs.png index e5c562498..1e8990f70 100644 Binary files a/docs/img/list_stop_jobs.png and b/docs/img/list_stop_jobs.png differ diff --git a/docs/img/log_search_advanced.png b/docs/img/log_search_advanced.png index bd04f724d..ddc76f1cc 100644 Binary files a/docs/img/log_search_advanced.png and b/docs/img/log_search_advanced.png differ diff --git a/docs/img/manage_endpoint.png b/docs/img/manage_endpoint.png index 34e59c72e..f6d135444 100644 Binary files a/docs/img/manage_endpoint.png and b/docs/img/manage_endpoint.png differ diff --git a/docs/img/manage_global_level_labels.png b/docs/img/manage_global_level_labels.png index 768761e4c..4c8fa87ba 100644 Binary files a/docs/img/manage_global_level_labels.png and b/docs/img/manage_global_level_labels.png differ diff --git a/docs/img/manage_project_level_labels.png b/docs/img/manage_project_level_labels.png index 5eff864b6..94b8ec63e 100644 Binary files a/docs/img/manage_project_level_labels.png and b/docs/img/manage_project_level_labels.png differ diff --git a/docs/img/manage_replication.png b/docs/img/manage_replication.png index 190ba13d9..f73ab3122 100644 Binary files a/docs/img/manage_replication.png and b/docs/img/manage_replication.png differ diff --git a/docs/img/new_add_member.png b/docs/img/new_add_member.png index fc034b261..c28463692 100644 Binary files a/docs/img/new_add_member.png and b/docs/img/new_add_member.png differ diff --git a/docs/img/new_auth.png b/docs/img/new_auth.png index 1b8446968..76bcf438e 100644 Binary files a/docs/img/new_auth.png and b/docs/img/new_auth.png differ diff --git a/docs/img/new_browse_project.png b/docs/img/new_browse_project.png index 4cd55bd49..71d55866b 100644 Binary files a/docs/img/new_browse_project.png and b/docs/img/new_browse_project.png differ diff --git a/docs/img/new_config_email.png b/docs/img/new_config_email.png index 996694f89..35237912c 100644 Binary files a/docs/img/new_config_email.png and b/docs/img/new_config_email.png differ diff --git a/docs/img/new_create_project.png b/docs/img/new_create_project.png index 27069a8f6..352d5f556 100644 Binary files a/docs/img/new_create_project.png and b/docs/img/new_create_project.png differ diff --git a/docs/img/new_delete_repo.png b/docs/img/new_delete_repo.png index 84edda4d2..05450b8e4 100644 Binary files a/docs/img/new_delete_repo.png and b/docs/img/new_delete_repo.png differ diff --git a/docs/img/new_delete_tag.png b/docs/img/new_delete_tag.png index be28c034c..ac4d6dc60 100644 Binary files a/docs/img/new_delete_tag.png and b/docs/img/new_delete_tag.png differ diff --git a/docs/img/new_proj_create.png b/docs/img/new_proj_create.png index c390819c9..fbe3f72ab 100644 Binary files a/docs/img/new_proj_create.png and b/docs/img/new_proj_create.png differ diff --git a/docs/img/new_project_log.png b/docs/img/new_project_log.png index c96ffc6f2..11a41a84b 100644 Binary files a/docs/img/new_project_log.png and b/docs/img/new_project_log.png differ diff --git a/docs/img/new_remove_update_member.png b/docs/img/new_remove_update_member.png index 16664e761..f7a599ed2 100644 Binary files a/docs/img/new_remove_update_member.png and b/docs/img/new_remove_update_member.png differ diff --git a/docs/img/new_search.png b/docs/img/new_search.png index 4fe309d49..b5d362fa4 100644 Binary files a/docs/img/new_search.png and b/docs/img/new_search.png differ diff --git a/docs/img/new_self_reg.png b/docs/img/new_self_reg.png index 8e8ad7b10..36e38107e 100644 Binary files a/docs/img/new_self_reg.png and b/docs/img/new_self_reg.png differ diff --git a/docs/img/new_set_admin_remove_user.png b/docs/img/new_set_admin_remove_user.png index 1495a2fa7..8b5c2c35c 100644 Binary files a/docs/img/new_set_admin_remove_user.png and b/docs/img/new_set_admin_remove_user.png differ diff --git a/docs/img/project_configuration.png b/docs/img/project_configuration.png index 1705d9f66..efe129e43 100644 Binary files a/docs/img/project_configuration.png and b/docs/img/project_configuration.png differ diff --git a/docs/img/read_only.png b/docs/img/read_only.png index 85e55a8f5..ce48fec29 100644 Binary files a/docs/img/read_only.png and b/docs/img/read_only.png differ diff --git a/docs/img/read_ony_enable.png b/docs/img/read_ony_enable.png new file mode 100644 index 000000000..9e7c88a40 Binary files /dev/null and b/docs/img/read_ony_enable.png differ diff --git a/docs/img/rule_under_project_view.png b/docs/img/rule_under_project_view.png index 79403e1c6..e626ced07 100644 Binary files a/docs/img/rule_under_project_view.png and b/docs/img/rule_under_project_view.png differ diff --git a/docs/img/scan_all.png b/docs/img/scan_all.png index b6cb5e99c..270324961 100644 Binary files a/docs/img/scan_all.png and b/docs/img/scan_all.png differ diff --git a/docs/img/scan_all2.png b/docs/img/scan_all2.png index 070a326b4..2dd35912d 100644 Binary files a/docs/img/scan_all2.png and b/docs/img/scan_all2.png differ diff --git a/docs/img/scan_image.png b/docs/img/scan_image.png new file mode 100644 index 000000000..58a01a1cd Binary files /dev/null and b/docs/img/scan_image.png differ diff --git a/docs/img/scan_menu_item.png b/docs/img/scan_menu_item.png deleted file mode 100644 index c2ab90ae7..000000000 Binary files a/docs/img/scan_menu_item.png and /dev/null differ diff --git a/docs/img/scan_policy.png b/docs/img/scan_policy.png index 18fbcc283..39ef71086 100644 Binary files a/docs/img/scan_policy.png and b/docs/img/scan_policy.png differ diff --git a/docs/img/select_info_tab.png b/docs/img/select_info_tab.png deleted file mode 100644 index 9c931860e..000000000 Binary files a/docs/img/select_info_tab.png and /dev/null differ diff --git a/docs/img/start_replicate.png b/docs/img/start_replicate.png index 2d5bf76c2..7e438d17e 100644 Binary files a/docs/img/start_replicate.png and b/docs/img/start_replicate.png differ diff --git a/docs/img/summary_tooltip.png b/docs/img/summary_tooltip.png index f8c874936..7601efb80 100644 Binary files a/docs/img/summary_tooltip.png and b/docs/img/summary_tooltip.png differ diff --git a/docs/img/tag_detail.png b/docs/img/tag_detail.png index b358f5fd9..c9466d836 100644 Binary files a/docs/img/tag_detail.png and b/docs/img/tag_detail.png differ diff --git a/docs/user_guide.md b/docs/user_guide.md index c008de958..fe3893357 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -41,8 +41,6 @@ Besides the above three roles, there are two system-wide roles: * **SysAdmin**: "SysAdmin" has the most privileges. In addition to the privileges mentioned above, "SysAdmin" can also list all projects, set an ordinary user as administrator, delete users and set vulnerability scan policy for all images. The public project "library" is also owned by the administrator. * **Anonymous**: When a user is not logged in, the user is considered as an "Anonymous" user. An anonymous user has no access to private projects and has read-only access to public projects. -**Video demo:** ![RBAC](img/demos/rbac.png) [youtube](https://www.youtube.com/watch?v=2ZIu9XTvsC0) , [Tencent Video](https://v.qq.com/x/page/l0553yw19ek.html) - ## User account Harbor supports two authentication modes: @@ -112,7 +110,7 @@ You can add members with different roles to an existing project. You can add a L ![browse project](img/new_add_member.png) ### Updating and removing members -You can check one or more members, then click `MEMBER ACTION`, choose one role to batch switch checked members' roles. You can also click `MEMBER.REMOVE` to batch remove checked members. +You can check one or more members, then click `ACTION`, choose one role to batch switch checked members' roles or remove them from the project. ![browse project](img/new_remove_update_member.png) @@ -123,7 +121,7 @@ The function is project-oriented, and once the system administrator has set a ru There may be a bit of delay during replication based on the situation of the network. If replication job fails due to the network issue, the job will be re-scheduled a few minutes later and the schedule will keep trying until the network issue is resolved. -**Note:** The replication feature is incompatible between Harbor versions before version 0.3.5 (included) and those versions after 0.3.5. +**Note:** Due to API changes, replication between different versions of Harbor may be broken. ### Creating a replication rule Replication can be configured by creating a rule. Click `NEW REPLICATION RULE` under `Administration->Replications` and fill in the necessary fields. You can choose different image filters and trigger modes according to the different requirements. If there is no endpoint available in the list, you need to create one. Click `SAVE` to create a replication rule for the selected project. If `Replicate existing images immediately` is chosen, the existing images under the project will be replicated to the remote registry immediately. @@ -302,11 +300,7 @@ $ docker push 10.117.169.182/demo/ubuntu:14.04 After pushing an image, an Information can be added by project admin to describe this repository. -First, go into the repository and select the "Info" tab. - -![select info tab](img/select_info_tab.png) - -Next, click the "EDIT" button, an textarea will appear and enter description here. Click "SAVE" button to save this information. +Go into the repository and select the "Info" tab, and click the "EDIT" button. An textarea will appear and enter description here. Click "SAVE" button to save this information. ![edit info](img/edit_description.png) @@ -363,8 +357,6 @@ If you are using a self-signed cert, make sure to copy the CA cert into ```/etc/ When an image is signed, it has a tick shown in UI; otherwise, a cross sign(X) is displayed instead. ![browse project](img/content_trust.png) -**Video demo:** ![content trust](img/demos/content_trust.png) [youtube](https://www.youtube.com/watch?v=pPklSTJZY2E) , [Tencent Video](https://v.qq.com/x/page/n0553fzzrnf.html) - ### Vulnerability scanning via Clair **CAUTION: Clair is an optional component, please make sure you have already installed it in your Harbor instance before you go through this section.** @@ -383,8 +375,8 @@ Once the database is ready, an overall database updated timestamp will be shown **Scanning an image** -Enter your project and locate the specified repository. Expand the tag list via clicking the arrow icon on the left side. For each tag there will be an 'Vulnerability' column to display vulnerability scanning status and related information. You can click on the vertical ellipsis to open a popup menu and then click on 'Scan' to start the vulnerability analysis process. -![browse project](img/scan_menu_item.png) +Enter your project, select the repository. For each tag there will be an 'Vulnerability' column to display vulnerability scanning status and related information. You can select the image and click the "SCAN" button to trigger the vulnerability scan process. +![browse project](img/scan_image.png) **NOTES: Only the users with 'Project Admin' role have the privilege to launch the analysis process.** The analysis process may have the following status that are indicated in the 'Vulnerability' column: @@ -433,8 +425,6 @@ You can set policies to control the vulnerability analysis process. Currently, t **NOTES: Once the scheduled job is executed, the completion time of scanning all images will be updated accordingly. Please be aware that the completion time of the images may be different because the execution of analysis for each image may be carried out at different time.** -**Video demo:** ![vulnerability scanning](img/demos/vul_scan.png) [youtube](https://www.youtube.com/watch?v=K4tJ6B2cGR4) , [Tencent Video](https://v.qq.com/x/page/s0553k9692d.html) - ### Pull image from Harbor in Kubernetes Kubernetes users can easily deploy pods with images stored in Harbor. The settings are similar to that of another private registry. There are two major issues: