Skip to content

Commit

Permalink
Fixed image paths
Browse files Browse the repository at this point in the history
  • Loading branch information
stuclem committed Oct 18, 2019
1 parent e041f16 commit 4738d94
Show file tree
Hide file tree
Showing 14 changed files with 46 additions and 46 deletions.
4 changes: 2 additions & 2 deletions docs/harbor-doc-reorg/_index.md
Expand Up @@ -19,8 +19,8 @@ This section describes how to install Harbor and perform the required initial co
- [Customize the Harbor Token Service](install_config/configuration/customize_token_service.md)
- [Configure Notary Content Trust](install_config/configuration/configure_notary_content_trust.md)
- [Initial Configuration in the Harbor UI](install_config/configuration/initial_config_ui.md)
- [Configure Authentication](configure_authentication.md)
- [Other General Settings](general_settings.md)
- [Configure Authentication](install_config/configuration/configure_authentication.md)
- [Other General Settings](install_config/configuration/general_settings.md)

You can also use Helm to install Harbor on a Kubernetes cluster, to make it highly available. For information about installing Harbor with Helm on a Kubernetes cluster, see the [Harbor High Availability Guide](https://github.com/goharbor/harbor-helm/blob/master/docs/High%20Availability.md) in the https://github.com/goharbor/harbor-helm repository.

Expand Down
@@ -1,6 +1,6 @@
# Configure Project Settings

Use the **Project Creation** drop-down menu to set which users can create projects. Select **Everyone** to allow all users to create projects. Select **Admin Only** to allow only users with the Administrator role to create projects.
![browse project](../img/new_proj_create.png)
![browse project](../../img/new_proj_create.png)

[Set Project Quotas](set_project_quotas.md)
Expand Up @@ -9,25 +9,25 @@ You can also set quotas on individual projects. If you set a global default quot
By default, all projects have unlimited quotas for both tags and storage use.

1. Go to **Configuration** > **Project Quotas**.
![Project quotas](../img/project-quota1.png)
![Project quotas](../../img/project-quota1.png)
1. To set global default quotas on all projects, click **Edit**.
![Project quotas](../img/project-quota2.png)
![Project quotas](../../img/project-quota2.png)
1. For **Default artifact count**, enter the maximum number of tags that any project can contain.

Enter `-1` to set the default to unlimited.
1. For **Default storage consumption**, enter the maximum quantity of storage that any project can consume, selecting `MB`, `GB`, or `TB` from the drop-down menu.

Enter `-1` to set the default to unlimited.
![Project quotas](../img/project-quota3.png)
![Project quotas](../../img/project-quota3.png)
1. Click **OK**.
1. To set quotas on an individual project, click the 3 vertical dots next to a project and select **Edit**.
![Project quotas](../img/project-quota4.png)
![Project quotas](../../img/project-quota4.png)
1. For **Default artifact count**, enter the maximum number of tags that this individual project can contain, or enter `-1` to set the default to unlimited.
1. For **Default storage consumption**, enter the maximum quantity of storage that this individual project can consume, selecting `MB`, `GB`, or `TB` from the drop-down menu.

After you set quotas, the you can see how much of their quotas each project has consumed in the **Project Quotas** tab.

![Project quotas](../img/project-quota5.png)
![Project quotas](../../img/project-quota5.png)

### How Harbor Calculates Resource Usage

Expand Down
Expand Up @@ -4,7 +4,7 @@ To replicate image repositories from one instance of Harbor to another Harbor or

1. Go to **Registries** and click the **+ New Endpoint** button.

![New replication endpoint](../img/replication-endpoint1.png)
![New replication endpoint](../../img/replication-endpoint1.png)
1. For **Provider**, use the drop-down menu to select the type of registry to set up as a replication endpoint.

The endpoint can be another Harbor instance, or a non-Harbor registry. Currently, the following non-Harbor registries are supported:
Expand All @@ -18,7 +18,7 @@ To replicate image repositories from one instance of Harbor to another Harbor or
- Huawei SWR
- Helm Hub

![Replication providers](../img/replication-endpoint2.png)
![Replication providers](../../img/replication-endpoint2.png)

1. Enter a suitable name and description for the new replication endpoint.
1. Enter the full URL of the registry to set up as a replication endpoint.
Expand All @@ -40,4 +40,4 @@ To replicate image repositories from one instance of Harbor to another Harbor or
## Managing Registries
You can list, add, edit and delete registries under `Administration->Registries`. Only registries which are not referenced by any rules can be deleted.

![browse project](../img/manage_registry.png)
![browse project](../../img/manage_registry.png)
Expand Up @@ -2,7 +2,7 @@

Login as a system administrator user, click `NEW REPLICATION RULE` under `Administration->Replications` and fill in the necessary fields. You can choose different replication modes, [resource filters](#resource-filter) and [trigger modes](#trigger-mode) according to the different requirements. If there is no endpoint available in the list, follow the instructions in the [Creating replication endpoints](#creating-replication-endpoints) to create one. Click `SAVE` to create a replication rule.

![browse project](../img/create_rule.png)
![browse project](../../img/create_rule.png)

#### Resource filter
Three resource filters are supported:
Expand Down
Expand Up @@ -2,25 +2,25 @@

You can list, add, edit and delete rules under `Administration->Replications`.

![browse project](../img/manage_replication.png)
![browse project](../../img/manage_replication.png)

### Starting a replication manually
Select a replication rule and click `REPLICATE`, the resources which the rule is applied to will be replicated from the source registry to the destination immediately.

![browse project](../img/start_replicate.png)
![browse project](../../img/start_replicate.png)

### Listing and stopping replication executions
Click a rule, the execution records which belong to this rule will be listed. Each record represents the summary of one execution of the rule. Click `STOP` to stop the executions which are in progress.

![browse project](../img/list_stop_executions.png)
![browse project](../../img/list_stop_executions.png)

### Listing tasks
Click the ID of one execution, you can get the execution summary and the task list. Click the log icon can get the detail information for the replication progress.
**Note**: The count of `IN PROGRESS` status in the summary includes both `Pending` and `In Progress` tasks.

![browse project](../img/list_tasks.png)
![browse project](../../img/list_tasks.png)

### Deleting the replication rule
Select the replication rule and click `DELETE` to delete it. Only rules which have no in progress executions can be deleted.

![browse project](../img/delete_rule.png)
![browse project](../../img/delete_rule.png)
Expand Up @@ -8,22 +8,22 @@ For more information about Garbage Collection, please see [Garbage Collection](h
## Set up Garbage Collection
If you are a system admin, you can trigger garbage collection by clicking "GC Now" in the **'Garbage Collection'** tab of **'Configuration'** section under **'Administration'**.

![browse project](../img/gc_now.png)
![browse project](../../img/gc_now.png)
**NOTES:** Harbor is put into read-only mode when to execute Garbage Collection, and any modification on docker registry is prohibited.

To avoid frequently triggering the garbage collection process, the availability of the button is restricted. It can be only triggered once in one minute.
![browse project](../img/gc_now2.png)
![browse project](../../img/gc_now2.png)

## Scheduled Garbage Collection by Policy
* **None:** No policy is selected.
* **Daily:** Policy is activated daily. It means an analysis job is scheduled to be executed at the specified time everyday. The scheduled job will do garbage collection in Harbor.
* **Weekly:** Policy is activated weekly. It means an analysis job is scheduled to be executed at the specified time every week. The scheduled job will do garbage collection in Harbor.
Once the policy has been configured, you have the option to save the schedule.
![browse project](../img/gc_policy.png)
![browse project](../../img/gc_policy.png)

## Garbage Collection history
If you are a system admin, you can view the latest 10 records of garbage collection execution.
![browse project](../img/gc_history.png)
![browse project](../../img/gc_history.png)

You can click on the 'details' link to view the related logs.
![browse project](../img/gc_details.png)
![browse project](../../img/gc_details.png)
@@ -1,6 +1,6 @@
# Harbor Role Based Access Control (RBAC)

![rbac](../img/rbac.png)
![rbac](../../img/rbac.png)

Harbor manages images through projects. Users can be added into one project as a member with one of three different roles:

Expand All @@ -19,4 +19,4 @@ For full details of the permissions of the different roles, see [User Permission
## Managing user
Administrator can add "Administrator" role to one or more ordinary users by checking checkboxes and clicking `SET AS ADMINISTRATOR`. To delete users, checked checkboxes and select `DELETE`. Deleting user is only supported under database authentication mode.

![browse project](../img/new_set_admin_remove_user.png)
![browse project](../../img/new_set_admin_remove_user.png)
Expand Up @@ -11,12 +11,12 @@ Static analysis of vulnerabilities is provided through open source project [Clai
**Vulnerability metadata**

Clair depends on the vulnerability metadata to complete the analysis process. After the first initial installation, Clair will automatically start to update the metadata database from different vulnerability repositories. The updating process may take a while based on the data size and network connection. If the database has not been fully populated, there is a warning message at the footer of the repository datagrid view.
![browse project](../img/clair_not_ready.png)
![browse project](../../img/clair_not_ready.png)

The 'database not fully ready' warning message is also displayed in the **'Vulnerability'** tab of **'Configuration'** section under **'Administration'** for your awareness.
![browse project](../img/clair_not_ready2.png)
![browse project](../../img/clair_not_ready2.png)

Once the database is ready, an overall database updated timestamp will be shown in the **'Vulnerability'** tab of **'Configuration'** section under **'Administration'**.
![browse project](../img/clair_ready.png)
![browse project](../../img/clair_ready.png)

If your Harbor instance is not connected to the external internet, you must manually update the vulnerability metadata. For information about how to update Clair manually, see [Import Vulnerability Data to an Offline Harbor instance](import_vulnerability_data.md).
Expand Up @@ -3,7 +3,7 @@
In the **'Vulnerability'** tab of **'Configuration'** section under **'Administration'**, click on the **'SCAN NOW'** button to start the analysis process for all the existing images.

**NOTES: The scanning process is executed via multiple concurrent asynchronous tasks. There is no guarantee on the order of scanning or the returned results.**
![browse project](../img/scan_all.png)
![browse project](../../img/scan_all.png)

To avoid frequently triggering the resource intensive scanning process, the availability of the button is restricted. It can be only triggered once in a predefined period. The next available time will be displayed besides the button.
![browse project](../img/scan_all2.png)
![browse project](../../img/scan_all2.png)
@@ -1,7 +1,7 @@
# Scan an Individual Image

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)
![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:
Expand All @@ -13,20 +13,20 @@ The analysis process may have the following status that are indicated in the 'Vu

For the **'Not Scanned'** and **'Queued'** statuses, a text label with status information is shown. For the **'Scanning'**, a progress bar will be displayed.
If an error occurred, you can click on the **'View Log'** link to view the related logs.
![browse project](../img/log_viewer.png)
![browse project](../../img/log_viewer.png)

If the process was successfully completed, a result bar is created. The width of the different colored sections indicates the percentage of features with vulnerabilities for a particular severity level.
* **Red:** **High** level of vulnerabilities
* **Orange:** **Medium** level of vulnerabilities
* **Yellow:** **Low** level of vulnerabilities
* **Grey:** **Unknown** level of vulnerabilities
* **Green:** **No** vulnerabilities
![browse project](../img/bar_chart.png)
![browse project](../../img/bar_chart.png)

Move the cursor over the bar, a tooltip with summary report will be displayed. Besides showing the total number of features with vulnerabilities and the total number of features in the scanned image tag, the report also lists the counts of features with vulnerabilities of different severity levels. The completion time of the last analysis process is shown at the bottom of the tooltip.
![browse project](../img/summary_tooltip.png)
![browse project](../../img/summary_tooltip.png)

Click on the tag name link, the detail page will be opened. Besides the information about the tag, all the vulnerabilities found in the last analysis process will be listed with the related information. You can order or filter the list by columns.
![browse project](../img/tag_detail.png)
![browse project](../../img/tag_detail.png)

**NOTES: You can initiate the vulnerability analysis for a tag at anytime you want as long as the status is not 'Queued' or 'Scanning'.**
Expand Up @@ -3,6 +3,6 @@
You can set policies to control the vulnerability analysis process. Currently, two options are available:
* **None:** No policy is selected.
* **Daily:** Policy is activated daily. It means an analysis job is scheduled to be executed at the specified time everyday. The scheduled job will scan all the images in Harbor.
![browse project](../img/scan_policy.png)
![browse project](../../img/scan_policy.png)

**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.**
@@ -1,12 +1,12 @@
# Configure Authentication

You can change authentication mode between **Database**(default) and **LDAP** before any user is added, when there is at least one user(besides admin) in Harbor, you cannot change the authentication mode.
![browse project](../img/new_auth.png)
![browse project](../../img/new_auth.png)
When using LDAP mode, user's self-registration is disabled. The parameters of LDAP server must be filled in. For more information, refer to [User account](#user-account).
![browse project](../img/ldap_auth.png)
![browse project](../../img/ldap_auth.png)

When using OIDC mode, user will login Harbor via OIDC based SSO. A client has to be registered on the OIDC provider and Harbor's callback URI needs to be associated to that client as a redirectURI.
![OIDC settings](../img/oidc_auth_setting.png)
![OIDC settings](../../img/oidc_auth_setting.png)

The settings of this auth mode:
* OIDC Provider Name: The name of the OIDC Provider.
Expand Down Expand Up @@ -50,12 +50,12 @@ Harbor supports different authentication modes:
With this authentication mode, regular user will login to Harbor Portal via SSO flow.
After the system administrator configure Harbor to authenticate via OIDC (more details refer to [this section](#managing-authentication)),
a button `LOGIN VIA OIDC PROVIDER` will appear on the login page.
![oidc_login](../img/oidc_login.png)
![oidc_login](../../img/oidc_login.png)

By clicking this button user will kick off the SSO flow and be redirected to the OIDC Provider for authentication. After a successful
authentication at the remote site, user will be redirected to Harbor. There will be an "onboard" step if it's the first time the user
authenticate using his account, in which there will be a dialog popped up for him to set his user name in Harbor:
![oidc_onboar](../img/oidc_onboard_dlg.png)
![oidc_onboar](../../img/oidc_onboard_dlg.png)

This user name will be the identifier for this user in Harbor, which will be used in the cases such as adding member to a project, assigning roles, etc.
This has to be a unique user name, if another user has used this user name to onboard, user will be prompted to choose another one.
Expand All @@ -74,10 +74,10 @@ Having authenticated via OIDC SSO and onboarded to Harbor, you can use Docker/He
As the CLI cannot handle redirection for SSO, we introduced `CLI secret`, which is only available when Harbor's authentication mode
is configured to OIDC based.
After logging into Harbor, click the drop down list to view user's profile:
![user_profile](../img/user_profile.png)
![user_profile](../../img/user_profile.png)

You can copy your CLI secret via the dialog of profile:
![profile_dlg](../img/profile_dlg.png)
![profile_dlg](../../img/profile_dlg.png)

After that you can authenticate using your user name in Harbor that you set during onboard process, and CLI secret as the password
with Docker/Helm CLI, for example:
Expand Down
Expand Up @@ -2,18 +2,18 @@

## Managing self-registration
You can manage whether a user can sign up for a new account. This option is not available if you use LDAP authentication.
![browse project](../img/new_self_reg.png)
![browse project](../../img/new_self_reg.png)

## Managing email settings
You can change Harbor's email settings, the mail server is used to send out responses to users who request to reset their password.
![browse project](../img/new_config_email.png)
![browse project](../../img/new_config_email.png)

## Managing registry read only
You can change Harbor's registry read only settings, read only mode will allow 'docker pull' while preventing 'docker push' and the deletion of repository and tag.
![browse project](../img/read_only.png)
![browse project](../../img/read_only.png)

If it set to true, deleting repository, tag and pushing image will be disabled.
![browse project](../img/read_only_enable.png)
![browse project](../../img/read_only_enable.png)


```
Expand Down

0 comments on commit 4738d94

Please sign in to comment.