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

Update doc for Robot Accounts per review comments

Browse Source 
Signed-off-by: wang yan <wangyan@vmware.com>
This commit is contained in:
wang yan 2019-04-09 17:08:20 +08:00
parent 8be3129f11
commit 57e7305104
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/user_guide.md
View File

@ -600,18 +600,18 @@ In Harbor portal, enter your project, select the repository, click on the link o
![build_ history](img/build_history.png)
## Robot Account
Robot accounts are accounts created by project admin that are intended for automated operations,
Robot Accounts are accounts created by project admins that are intended for automated operations. They have the following limitations:
1, Robot account cannot login Harbor portal.
2, Robot account can do docker pull/push only with token.
1, Robot Accounts cannot login Harbor portal
2, Robot Accounts can only perform `docker push`/`docker pull` operations with a token.
### Add a robot account
If you are a project admin, you can create a robot account by clicking "New Robot Account" in the **'Robot Accounts'** tab of a project, and enter a name, a description and permission.
### Add a Robot Account
If you are a project admin, you can create a Robot Account by clicking "New Robot Account" in the `Robot Accounts` tab of a project, and enter a name, a description and permission.
![add_robot_account](img/robotaccount/add_robot_account.png)
![add_robot_account](img/robotaccount/add_robot_account_2.png)
**NOTES:** The name will become robot$accountname that used to distinguish a robot account from harbor user.
> **NOTE:** The name will become `robot$<accountname>` and will be used to distinguish a robot account from a normal harbor user.
![copy_robot_account_token](img/robotaccount/copy_robot_account_token.png)
As Harbor doesn't store your account token, please make sure to copy it in the pop up dialog after creating, otherwise, there is no way to get it from Harbor.
@ -621,7 +621,7 @@ If you are a system admin, you can configure the robot account token duration in
![set_robot_account_token_duration](img/robotaccount/set_robot_account_token_duration.png)
### Authenticate with a robot account
To authenticate with a robot account, use `docker login` as below,
To authenticate with a Robot Account, use `docker login` as below,
```
docker login harbor.io
@ -630,10 +630,10 @@ Password: Thepasswordgeneratedbyprojectadmin
```
### Disable a robot account
If you are a project admin, you can disable a robot account by clicking "Disable Account" in the **'Robot Accounts'** tab of a project.
If you are a project admin, you can disable a Robot Account by clicking "Disable Account" in the `Robot Accounts` tab of a project.
![disable_robot_account](img/robotaccount/disable_delete_robot_account.png)
### Delete a robot account
If you are a project admin, you can delete a robot account by clicking "Delete" in the **'Robot Accounts'** tab of a project.
If you are a project admin, you can delete a Robot Account by clicking "Delete" in the `Robot Accounts` tab of a project.
![delete_robot_account](img/robotaccount/disable_delete_robot_account.png)