Skip to content

Commit

Permalink
Merge pull request #10759 from lucperkins/lperkins/image-link-fixes
Browse files Browse the repository at this point in the history
Fix image links to match Hugo conventions
  • Loading branch information
michmike committed Feb 19, 2020
2 parents 22021a9 + c73bc0e commit fc5b145
Show file tree
Hide file tree
Showing 24 changed files with 94 additions and 94 deletions.
10 changes: 5 additions & 5 deletions docs/1.10/administration/configure-project-quotas.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,24 @@ By default, all projects have unlimited quotas for both tags and storage use.

1. Select the **Project Quotas** view.

![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 at a given time, or 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, or 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, you can see how much of their quotas each project has consumed.

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

### How Harbor Calculates Resource Usage

Expand Down
6 changes: 3 additions & 3 deletions docs/1.10/administration/garbage-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ When you delete images from Harbor, space is not automatically freed up. You mus
1. Expand **Administration**, and select **Garbage Collection**.
1. Select the **'Garbage Collection'** tab.

![Garbage collection](../img/garbage-collection.png)
![Garbage collection](../../img/garbage-collection.png)

1. To run garbage collection immediately, click **GC Now**.

Expand All @@ -25,7 +25,7 @@ To avoid triggering the garbage collection process too frequently, the availabil
1. Select the **'Garbage Collection'** tab.
1. Use the drop down-menu to select how often to run garbage collection.

![Schedule garbage collection](../img/gc-policy.png)
![Schedule garbage collection](../../img/gc-policy.png)

* **None**: No garbage collection is scheduled.
* **Hourly**: Run garbage collection at the beginning of every hour.
Expand All @@ -35,6 +35,6 @@ To avoid triggering the garbage collection process too frequently, the availabil
1. Click **Save**.
1. Select the **History** tab to view records of the 10 most recent garbage collection runs.

![Garbage collection history](../img/gc-history.png)
![Garbage collection history](../../img/gc-history.png)

1. Click on the **Logs** link to view the related logs.
8 changes: 4 additions & 4 deletions docs/1.10/administration/general-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ You can configure Harbor to connect to an email server, set the registry in read

You can configure Harbor to connect to an email server. The email server is only 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)

## Make the Registry Read Only

You can set Harbor to read-only mode. In read-only mode, Harbor allows `docker pull` but prevents `docker push` and the deletion of repositories and tags.

![Read-only mode](../img/read-only.png)
![Read-only mode](../../img/read-only.png)

If it set to true, deleting repositories, tags and pushing images are not permitted.

![browse project](../img/read-only-enable.png)
![browse project](../../img/read-only-enable.png)

```sh
docker push 10.117.169.182/demo/ubuntu:14.04
Expand All @@ -32,4 +32,4 @@ denied: The system is in read only mode. Any modification is prohibited.

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 Harbor system administrator role to create projects.

![browse project](../img/new-proj-create.png)
![browse project](../../img/new-proj-create.png)
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ System-wide CVE whitelists apply to all of the projects in a Harbor instance.

1. Go to **Configuration** > **System Settings**.
1. Under **Deployment security**, click **Add**.
![System-wide CVE whitelist](../../img/cve-whitelist1.png)
![System-wide CVE whitelist](../../../img/cve-whitelist1.png)
1. Enter the list of CVE IDs to ignore during vulnerability scanning.
![Add system CVE whitelist](../../img/cve-whitelist2.png)
![Add system CVE whitelist](../../../img/cve-whitelist2.png)

Either use a comma-separated list or newlines to add multiple CVE IDs to the list.
1. Click **Add** at the bottom of the window to add the list.
1. Optionally uncheck the **Never expires** checkbox and use the calendar selector to set an expiry date for the whitelist.
![Add system CVEs](../../img/cve-whitelist3.png)
![Add system CVEs](../../../img/cve-whitelist3.png)
1. Click **Save** at the bottom of the page to save your settings.

After you have created a system whitelist, you can remove CVE IDs from the list by clicking the delete button next to it in the list. You can click **Add** to add more CVE IDs to the system whitelist.

![Add and remove system CVEs](../../img/cve-whitelist4.png)
![Add and remove system CVEs](../../../img/cve-whitelist4.png)
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ To connect Harbor to additional vulnerability scanners, you must install and con

1. Log in to the Harbor interface with an account that has Harbor system administrator privileges.
1. Expand **Administration**, and select **Interrogation Services**.
![Interrogation Services](../../img/interrogation-services.png)
![Interrogation Services](../../../img/interrogation-services.png)
1. Click the **New Scanner** button.
1. Enter the information to identify the scanner.
- A unique name for this scanner instance, to display in the Harbor interface.
- An optional description of this scanner instance.
- The address of the API endpoint that the scanner exposes to Harbor.
![Add scanner](../../img/add-scanner.png)
![Add scanner](../../../img/add-scanner.png)
1. Select how to connect to the scanner from the **Authorization** drop-down menu.
![Select scanner authentication method](../../img/scanner-auth.png)
![Select scanner authentication method](../../../img/scanner-auth.png)
- **None**: The scanner allows all connections without any security.
- **Basic**: Enter a username and password for an account that can connect to the scanner.
- **Bearer**: Paste the contents of a bearer token in the **Token** text box.
Expand All @@ -25,7 +25,7 @@ To connect Harbor to additional vulnerability scanners, you must install and con

**NOTE**: To use this option, the scanner must be deployed in a network that allows the scanner to reach Harbor via Harbor's internal network.
1. Click **Test Connection** to make sure that Harbor can connect successfully to the scanner.
![Test scanner connection](../../img/test-scanner-connection.png)
![Test scanner connection](../../../img/test-scanner-connection.png)
1. Click **Add** to connect Harbor to the scanner.
1. Optionally repeat the procedure to add more scanners.
1. If you configure multiple scanners, select one and click **Set as Default** to designate it as the default scanner.
Expand All @@ -35,7 +35,7 @@ To connect Harbor to additional vulnerability scanners, you must install and con
Vulnerability scanners depend on the vulnerability metadata to complete the analysis process. After the first initial installation, the vulnerability scanner automatically starts to update the metadata database from different vulnerability repositories. The database update might take a while, based on the data size and network connection.

Depending on the scanner that you use, once the database is ready, the timestamp of the last update is shown in the **Interrogation Services** > **Vulnerability** tab. Currently, only Clair and Anchore provide timestamp information.
![browse project](../../img/clair-ready.png)
![browse project](../../../img/clair-ready.png)

Until the database has been fully populated, the timestamp is replaced by a warning symbol. When the database is ready, you can scan images individually or scan all images across all projects.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ In addition to scanning individual images in projects, you can run global scans
1. Expand **Administration**, and select **Interrogation Services**.
1. Select the **Vulnerability** tab and click **Scan Now** to scan all of the images in all projects.

![Scan all images](../../img/scan-all.png)
![Scan all images](../../../img/scan-all.png)

Scanning requires intensive resource consumption. If scanning is in progress, the **Scan Now** button is unavailable.
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ weight: 30

The **Scanner** tab shows the details of the scanner that is currently set as the scanner to use for this project.

![Project scanner tab](../../img/project-scanners.png)
![Project scanner tab](../../../img/project-scanners.png)

1. Click **Edit** to select a different scanner from the list of scanners that are connected to this Harbor instance, and click **OK**.

![Project scanner tab](../../img/select-scanner.png)
![Project scanner tab](../../../img/select-scanner.png)

{{< note >}}
If you have selected the **Prevent vulnerable images from running** option in the project **Configuration** tab, the prevention of pulling vulnerable images is determined by the scanner that is set in the project, or by the global default scanner if no scanner is configured specifically for the project. Different scanners might apply different levels of severity to image vulnerabilities.
Expand All @@ -23,11 +23,11 @@ weight: 30

For each tag in the repository, the **Vulnerabilities** column displays the vulnerability scanning status and related information.

![Tag vulnerability status](../../img/tag-vulnerability-status.png)
![Tag vulnerability status](../../../img/tag-vulnerability-status.png)

1. Select a tag, or use the check box at the top to select all tags in the repository, and click the **Scan** button to run the vulnerability scan on this image.

![Scan an image](../../img/scan-image.png)
![Scan an image](../../../img/scan-image.png)

**NOTE**: You can start a scan at any time, unless the status is **Queued** or **Scanning**. If the database has not been fully populated, you should not run a scan. The following statuses are displayed in the **Vulnerabilities** column:

Expand All @@ -39,7 +39,7 @@ weight: 30

If the process completes successfully, the result indicates the overall severity level, with the total number of vulnerabilities found for each severity level, and the number of fixable vulnerabilities.

![Scan result](../../img/scan-result.png)
![Scan result](../../../img/scan-result.png)

* **Red:** At least one critical vulnerability found
* **Orange:** At least one high level vulnerability found
Expand All @@ -50,10 +50,10 @@ weight: 30

1. Hover over the number of fixable vulnerabilities to see a summary of the vulnerability report.

![Vulnerability summary](../../img/vulnerability-summary.png)
![Vulnerability summary](../../../img/vulnerability-summary.png)

1. Click on the tag name to see a detailed vulnerability report.

![Vulnerability report](../../img/tag-detail.png)
![Vulnerability report](../../../img/tag-detail.png)

In addition to information about the tag, all of the vulnerabilities found in the last scan are listed. You can order or filter the list by the different columns. You can also click **Scan** in the report page to run a scan on this image tag.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can set policies to control when vulnerability scanning should run.
1. Select the **Vulnerability** tab and click the **Edit** button next to **Schedule to scan all**.
1. Use the drop down-menu to select how often to run scans.

![browse project](../../img/scan-policy.png)
![browse project](../../../img/scan-policy.png)

* **None**: No scans are scheduled.
* **Hourly**: Run a scan at the beginning of every hour.
Expand Down
2 changes: 1 addition & 1 deletion docs/1.10/install-config/harbor-ha-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Most of Harbor's components are stateless now. So we can simply increase the re

As for storage layer, it is expected that the user provide high available PostgreSQL, Redis cluster for application data and PVCs or object storage for storing images and charts.

![HA](../img/ha.png)
![HA](../../img/ha.png)

## Usage

Expand Down
10 changes: 5 additions & 5 deletions docs/1.10/working-with-projects/access-project-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@ Log in to Harbor with a Harbor administrator, project administrator, master, dev

1. Go to **Projects**, select a project, and select **Logs**.

![View logs](../img/project-logs.png)
![View logs](../../img/project-logs.png)

All logs for the project are displayed.

1. Click the **Search** icon and start typing to filter the logs by name.

![Filter logs](../img/log-filter.png)
![Filter logs](../../img/log-filter.png)

1. Click **Advanced**.

![Advanced log search](../img/log-search-advanced.png)
![Advanced log search](../../img/log-search-advanced.png)

1. Use the **Operations** drop-down menu to filter by operation type.

![Search logs by operation type](../img/new-project-log.png)
![Search logs by operation type](../../img/new-project-log.png)

1. Click the calendar icons to enter dates between which to search for logs of the types you set in the **Operations** drop-down menu.

![Filter logs by date](../img/log-search-advanced-date.png)
![Filter logs by date](../../img/log-search-advanced-date.png)
14 changes: 7 additions & 7 deletions docs/1.10/working-with-projects/add-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,24 @@ For more information about users and roles in Harbor, see [User Permissions By R
1. Go to **Projects** and select a project.
1. Select the **Members** tab and click **+User**.

![browse project](../img/project-members.png)
![browse project](../../img/project-members.png)
1. Enter the name of an existing database, LDAP/AD, or OIDC user and select a role for this user.

![browse project](../img/new-add-member.png)
![browse project](../../img/new-add-member.png)
1. Optionally select one or more members, click **Action**, and select a different role for the user or users, or select **Remove** to remove them from the project.

![browse project](../img/new-remove-update-member.png)
![browse project](../../img/new-remove-update-member.png)

## Add LDAP/AD Groups to Projects

1. Log in to the Harbor interface with an account that has at least project administrator privileges.
1. Go to **Projects** and select a project.
1. Select the **Members** tab and click **+Group**.

![Add group](../img/add-group.png)
![Add group](../../img/add-group.png)
1. Select **Add an existing user group to project members** or **Add a group from LDAP to project member**.

![Screenshot of add group dialog](../img/ldap-group-addgroup-dialog.png)
![Screenshot of add group dialog](../../img/ldap-group-addgroup-dialog.png)

- If you selected **Add an existing user group to project members**, enter the name of a group that you have already used in Harbor and assign a role to that group.
- If you selected **Add a group from LDAP to project member**, enter the LDAP Group DN and assign a role to that group.
Expand All @@ -47,10 +47,10 @@ To be able to add OIDC groups to projects, your OIDC provider and Harbor instanc
1. Go to **Projects** and select a project.
1. Select the **Members** tab and click **+Group**.

![Add group](../img/add-group.png)
![Add group](../../img/add-group.png)
1. Enter the name of a group that already exists in your OIDC provider and assign a role to that group.

![Add group](../img/add-oidc-group.png)
![Add group](../../img/add-oidc-group.png)

{{< note >}}
Unlike with LDAP groups, Harbor cannot check whether OIDC groups exist when you add them to a project. If you mistype the group name, or if the group does not exist in your OIDC provider, Harbor still creates the group.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Harbor administrators can set a system-wide CVE whitelist. For information about
1. Go to **Projects**, select a project, and select **Configuration**.
1. Under **CVE whitelist**, select **Project whitelist**.

![Project CVE whitelist](../img/cve-whitelist5.png)
![Project CVE whitelist](../../img/cve-whitelist5.png)

1. Optionally click **Copy From System** to add all of the CVE IDs from the system CVE whitelist to this project whitelist.
1. Click **Add** and enter a list of additional CVE IDs to ignore during vulnerability scanning of this project.

![Add project CVEs](../img/cve-whitelist6.png)
![Add project CVEs](../../img/cve-whitelist6.png)

Either use a comma-separated list or newlines to add multiple CVE IDs to the list.

Expand Down
8 changes: 4 additions & 4 deletions docs/1.10/working-with-projects/configure-webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ You can configure your continuous integration and development infrastructure so
1. Log in to the Harbor interface with an account that has at least project administrator privileges.
1. Go to **Projects**, select a project, and select **Webhooks**.

![Webhooks option](../img/webhooks1.png)
![Webhooks option](../../img/webhooks1.png)

1. Enter the URL for your webhook endpoint listener.
1. If your webhook listener implements authentication, enter the authentication header.
1. To implement `HTTPS POST` instead of `HTTP POST`, select the **Verifiy Remote Certficate** check box.

![Webhook URL](../img/webhooks2.png)
![Webhook URL](../../img/webhooks2.png)

1. Click **Test Endpoint** to make sure that Harbor can connect to the listener.
1. Click **Continue** to create the webhook.
Expand All @@ -83,7 +83,7 @@ When you have created the webhook, you see the status of the different notificat
You can only disable and reenable all notifications. You cannot disable and enable selected notifications.
{{< /note >}}

![Webhook Status](../img/webhooks3.png)
![Webhook Status](../../img/webhooks3.png)

If a webhook notification fails to send, or if it receives an HTTP error response with a code other than `2xx`, the notification is re-sent based on the configuration that you set in `harbor.yml`.

Expand All @@ -94,4 +94,4 @@ As a Harbor system administrator, you can enable and disable webhook notificatio
1. Go to **Configuration** > **System Settings**.
1. Scroll down and check or uncheck the **Webhooks enabled** check box.

![Enable/disable webhooks](../img/webhooks4.png)
![Enable/disable webhooks](../../img/webhooks4.png)
8 changes: 4 additions & 4 deletions docs/1.10/working-with-projects/create-labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ Harbor provides two kinds of labels to isolate different kinds of resources:
## Managing Global Labels
The Harbor system administrators can list, create, update and delete the global level labels under `Administration->Configuration->Labels`:

![manage global level labels](../img/manage-global-level-labels.png)
![manage global level labels](../../img/manage-global-level-labels.png)

## Managing Project-Level Labels
The project administrators and Harbor system administrators can list, create, update and delete the project level labels under `Labels` tab of the project detail page:

![manage project level labels](../img/manage-project-level-labels.png)
![manage project level labels](../../img/manage-project-level-labels.png)

## Adding and Removing Labels to and from Images
Users who have Harbor system administrator, project administrator or project developer role can click the `ADD LABELS` button to add labels to or remove labels from images. The label list contains both globel level labels(come first) and project level labels:

![add labels to images](../img/add-labels-to-images.png)
![add labels to images](../../img/add-labels-to-images.png)

## Filtering Images by Label
The images can be filtered by labels:

![filter images by labels](../img/filter-images-by-label.png)
![filter images by labels](../../img/filter-images-by-label.png)
Loading

0 comments on commit fc5b145

Please sign in to comment.