upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor synced 2024-09-20 13:35:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2139 from vmware/stuclem-patch-1

Browse Source 
Update user_guide_ova.md
This commit is contained in:
Daniel Jiang 2017-04-26 16:52:47 +08:00 committed by GitHub
commit 2b1bfaf2e7
1 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/user_guide_ova.md
View File

@ -1,5 +1,7 @@
#User Guide of Harbor Virtual Appliance # User Guide of Harbor Virtual Appliance
##Overview
## Overview
This guide walks you through the fundamentals of using Harbor virtual appliance. You'll learn how to use Harbor to: This guide walks you through the fundamentals of using Harbor virtual appliance. You'll learn how to use Harbor to:
* Manage your projects. * Manage your projects.
@ -14,7 +16,7 @@ This guide walks you through the fundamentals of using Harbor virtual appliance.
* Delete repositories and images. * Delete repositories and images.
##Role Based Access Control ## Role Based Access Control
![rbac](img/rbac.png) ![rbac](img/rbac.png)
@ -29,7 +31,7 @@ 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 and delete users. The public project "library" is also owned by the administrator. * **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 and delete users. 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. * **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.
##User account ## User account
Harbor supports two authentication modes: Harbor supports two authentication modes:
* **Database(db_auth)** * **Database(db_auth)**
@ -55,7 +57,7 @@ Harbor supports two authentication modes:
Self-registration, changing password and resetting password are not supported anymore under LDAP/AD authentication mode because the users are managed by LDAP or AD. Self-registration, changing password and resetting password are not supported anymore under LDAP/AD authentication mode because the users are managed by LDAP or AD.
##Managing projects ## Managing projects
A project in Harbor contains all repositories of an application. No images can be pushed to Harbor before the project is created. RBAC is applied to a project. There are two types of projects in Harbor: A project in Harbor contains all repositories of an application. No images can be pushed to Harbor before the project is created. RBAC is applied to a project. There are two types of projects in Harbor:
* **Public**: All users have the read privilege to a public project, it's convenient for you to share some repositories with others in this way. * **Public**: All users have the read privilege to a public project, it's convenient for you to share some repositories with others in this way.
@ -73,18 +75,18 @@ All logs can be listed by clicking "Logs". You can apply a filter by username, o
![browse project](img/new_project_log.png) ![browse project](img/new_project_log.png)
##Managing members of a project ## Managing members of a project
###Adding members ### Adding members
You can add members with different roles to an existing project. You can add members with different roles to an existing project.
![browse project](img/new_add_member.png) ![browse project](img/new_add_member.png)
###Updating and removing members ### Updating and removing members
You can update or remove a member by clicking the icon on the right. You can update or remove a member by clicking the icon on the right.
![browse project](img/new_remove_update_member.png) ![browse project](img/new_remove_update_member.png)
##Replicating images ## Replicating images
Images can be replicated between Harbor instances. It can be used to transfer images from one data center to another, or from an on-prem registry to an instance in the cloud. Images can be replicated between Harbor instances. It can be used to transfer images from one data center to another, or from an on-prem registry to an instance in the cloud.
A replication policy needs to be set up on the source instance to govern the replication process. A replication policy needs to be set up on the source instance to govern the replication process.
@ -117,28 +119,28 @@ Click on a policy, jobs belonging to this policy will be listed. A job represent
![browse project](img/new_policy_list.png) ![browse project](img/new_policy_list.png)
##Searching projects and repositories ## Searching projects and repositories
Entering a keyword in the search field at the top lists all matching projects and repositories. The search result includes both public and private repositories you have access privilege to. Entering a keyword in the search field at the top lists all matching projects and repositories. The search result includes both public and private repositories you have access privilege to.
![browse project](img/new_search.png) ![browse project](img/new_search.png)
##Administrator options ## Administrator options
###Managing user ### Managing users
Administrator can add "administrator" role to an ordinary user by toggling the switch under "Administrator". To delete a user, click on the recycle bin icon. Administrator can add "administrator" role to an ordinary user by toggling the switch under "Administrator". To delete a user, click on the recycle bin icon.
![browse project](img/new_set_admin_remove_user.png) ![browse project](img/new_set_admin_remove_user.png)
###Managing destination ### Managing destination
You can list, add, edit and delete destinations in the "Destination" tab. Only destinations which are not referenced by any policies can be edited. You can list, add, edit and delete destinations in the "Destination" tab. Only destinations which are not referenced by any policies can be edited.
![browse project](img/new_manage_destination.png) ![browse project](img/new_manage_destination.png)
###Managing replication ### Managing replication
You can list, edit, enable and disable policies in the "Replication" tab. Make sure the policy is disabled before you edit it. You can list, edit, enable and disable policies in the "Replication" tab. Make sure the policy is disabled before you edit it.
![browse project](img/new_manage_replication.png) ![browse project](img/new_manage_replication.png)
##Pulling and pushing images using Docker client ## Pulling and pushing images using Docker client
**NOTE: Harbor only supports Registry V2 API. You need to use Docker client 1.6.0 or higher.** **NOTE: Harbor only supports Registry V2 API. You need to use Docker client 1.6.0 or higher.**
@ -153,7 +155,7 @@ If Harbor is configured as using HTTP, just set the "--insecure-registry" option
If the certificate used by Harbor is signed by a trusted authority, Docker should work without any additional configuration. If the certificate used by Harbor is signed by a trusted authority, Docker should work without any additional configuration.
###Pulling images ### Pulling images
If the project that the image belongs to is private, you should sign in first: If the project that the image belongs to is private, you should sign in first:
```sh ```sh
@ -168,7 +170,7 @@ $ docker pull 10.117.169.182/library/ubuntu:14.04
**Note: Replace "10.117.169.182" with the IP address or domain name of your Harbor node.** **Note: Replace "10.117.169.182" with the IP address or domain name of your Harbor node.**
###Pushing images ### Pushing images
Before pushing an image, you must create a corresponding project on Harbor web UI. Before pushing an image, you must create a corresponding project on Harbor web UI.
First, log in from Docker client: First, log in from Docker client:
@ -191,7 +193,7 @@ $ docker push 10.117.169.182/demo/ubuntu:14.04
**Note: Replace "10.117.169.182" with the IP address or domain name of your Harbor node.** **Note: Replace "10.117.169.182" with the IP address or domain name of your Harbor node.**
##Deleting repositories ## Deleting repositories
Repository deletion runs in two steps. Repository deletion runs in two steps.