More 1.10 migration
@ -68,8 +68,8 @@ This section describes how users with the developer, master, and project adminis
|
||||
- **[Implementing Content Trust](working_with_projects/implementing_content_trust.md)**
|
||||
- [Working with Images, Tags, and Helm Charts](working_with_projects/working_with_images.md)
|
||||
- [Pulling and Pushing Images](working_with_projects/pulling_pushing_images.md)
|
||||
- [Create Labels](working_with_projects/create_labels.md)
|
||||
- [Retag Images](retagging_images.md)
|
||||
- **[Create Labels](working_with_projects/create_labels.md)**
|
||||
- **[Retag Images](working_with_projects/retagging_images.md) **
|
||||
- [Create Tag Retention Rules](working_with_projects/create_tag_retention_rules.md)
|
||||
- [Manage Kubernetes Packages with Helm Charts](working_with_projects/managing_helm_charts.md)
|
||||
|
||||
|
@ -1,12 +1,12 @@
|
||||
# Configuring Replication
|
||||
|
||||
Replication allows users to replicate resources (images/charts) between Harbor and non-Harbor registries in both pull or push mode.
|
||||
Replication allows users to replicate resources, namely images and charts, between Harbor and non-Harbor registries, in both pull or push mode.
|
||||
|
||||
Once the system administrator has set a rule, all resources that match the defined [filter](#resource-filter) patterns will be replicated to the destination registry when the [triggering condition](#trigger-mode) is matched. Each resource will start a task to run. If the namespace does not exist on the destination registry, a new namespace will be created automatically. If it already exists and the user configured in the policy has no write privilege to it, the process will fail. The member information will not be replicated.
|
||||
When the Harbor system administrator has set a replication rule, all resources that match the defined filter patterns are replicated to the destination registry when the triggering condition is met. Each resource that is replicated starts a replication task. If the namespace does not exist in the destination registry, a new namespace is created automatically. If it already exists and the user account that is configured in the replication policy does not have write privileges in it, the process fails. Member information is not replicated.
|
||||
|
||||
There may be a bit of delay during replication based on the situation of the network. If a replication task fails, it will be re-scheduled a few minutes later and retried times.
|
||||
There might be some delay during replication based on the condition of the network. If a replication task fails, it is re-scheduled for a few minutes later and retried several times.
|
||||
|
||||
**Note:** Due to API changes, replication between different versions of Harbor is not supported.
|
||||
**NOTE:** Due to API changes, replication between different versions of Harbor is not supported.
|
||||
|
||||
- [Create Replication Endpoints](create_replication_endpoints.md)
|
||||
- [Create Replication Rules](create_replication_rules.md)
|
||||
|
@ -1,4 +1,4 @@
|
||||
# Create Replication Endpoints
|
||||
# Creating Replication Endpoints
|
||||
|
||||
To replicate image repositories from one instance of Harbor to another Harbor or non-Harbor registry, you first create replication endpoints.
|
||||
|
||||
@ -17,6 +17,9 @@ To replicate image repositories from one instance of Harbor to another Harbor or
|
||||
- Google Container Registry
|
||||
- Huawei SWR
|
||||
- Helm Hub
|
||||
- Gitlab
|
||||
- Quay.io
|
||||
- Jfrog Artifactory
|
||||
|
||||
![Replication providers](../../img/replication-endpoint2.png)
|
||||
|
||||
@ -37,6 +40,7 @@ To replicate image repositories from one instance of Harbor to another Harbor or
|
||||
1. Click **Test Connection**.
|
||||
1. When you have successfully tested the connection, click **OK**.
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
|
@ -1,31 +1,58 @@
|
||||
# Create Replication Rules
|
||||
# Creating a Replication Rule
|
||||
|
||||
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.
|
||||
A replication endpoint must exist before you create a replication rule. To create an endpoint, follow the instructions in [Creating Replication Endpoints](create_replication_endpoints.md).
|
||||
|
||||
![browse project](../../img/create_rule.png)
|
||||
1. Log in to the Harbor interface with an account that has Harbor system administrator privileges.
|
||||
1. Expand **Administration**, and select **Replications**.
|
||||
|
||||
#### Resource filter
|
||||
Three resource filters are supported:
|
||||
* **Name**: Filter resources according to the name.
|
||||
* **Tag**: Filter resources according to the tag.
|
||||
* **Resource**: Filter images according to the resource type.
|
||||
![Add a replication rule](../../img/replication-rule1.png)
|
||||
1. Click **New Replication Rule**.
|
||||
1. Provide a name and description for the replication rule.
|
||||
1. Select **Push-based** or **Pull-based** replication, depending on whether you want to replicate images to or from the remote registry.
|
||||
|
||||
The terms supported in the pattern used by name filter and tag filter are as follows:
|
||||
* **\***: Matches any sequence of non-separator characters `/`.
|
||||
* **\*\***: Matches any sequence of characters, including path separators `/`.
|
||||
* **?**: Matches any single non-separator character `/`.
|
||||
* **{alt1,...}**: Matches a sequence of characters if one of the comma-separated alternatives matches.
|
||||
![Replication mode](../../img/replication-rule2.png)
|
||||
1. For **Source resource filter**, identify the images to replicate.
|
||||
|
||||
**Note:** `library` must be added if you want to replicate the official images of Docker Hub. For example, `library/hello-world` matches the official hello-world images.
|
||||
![Replication filters](../../img/replication-rule3.png)
|
||||
|
||||
Pattern | String(Match or not)
|
||||
---------- | -------
|
||||
`library/*` | `library/hello-world`(Y)<br> `library/my/hello-world`(N)
|
||||
`library/**` | `library/hello-world`(Y)<br> `library/my/hello-world`(Y)
|
||||
`{library,goharbor}/**` | `library/hello-world`(Y)<br> `goharbor/harbor-core`(Y)<br> `google/hello-world`(N)
|
||||
`1.?` | `1.0`(Y)<br> `1.01`(N)
|
||||
* **Name**: Replicate resources with a given name by entering an image name or fragment.
|
||||
* **Tag**: Replicate resources with a given tag by entering a tag name or fragment.
|
||||
* **Label**: Replicate resources with a given label by using the drop-down menu to select from the available labels.
|
||||
* **Resource**: Replicate images, charts, or both.
|
||||
|
||||
The name filter and tag filters support the following patterns:
|
||||
|
||||
* **\***: Matches any sequence of non-separator characters `/`.
|
||||
* **\*\***: Matches any sequence of characters, including path separators `/`.
|
||||
* **?**: Matches any single non-separator character `/`.
|
||||
* **{alt1,...}**: Matches a sequence of characters if one of the comma-separated alternatives matches. are as follows:
|
||||
* **\***: Matches any sequence of non-separator characters `/`.
|
||||
* **\*\***: Matches any sequence of characters, including path separators `/`.
|
||||
* **?**: Matches any single non-separator character `/`.
|
||||
* **{alt1,...}**: Matches a sequence of characters if one of the comma-separated alternatives matches.
|
||||
|
||||
**NOTE:** You must add `library` if you want to replicate the official images of Docker Hub. For example, `library/hello-world` matches the official hello-world images.
|
||||
|
||||
Pattern | String(Match or not)
|
||||
---------- | -------
|
||||
`library/*` | `library/hello-world`(Y)<br> `library/my/hello-world`(N)
|
||||
`library/**` | `library/hello-world`(Y)<br> `library/my/hello-world`(Y)
|
||||
`{library,goharbor}/**` | `library/hello-world`(Y)<br> `goharbor/harbor-core`(Y)<br> `google/hello-world`(N)
|
||||
`1.?` | `1.0`(Y)<br> `1.01`(N)
|
||||
1. Use the **Destination Registry** drop-down menu to select from the configured replication endpoints.
|
||||
1. Enter the name of the namespace in which to replicate resources in the **Destination namespace** text box.
|
||||
|
||||
#### Trigger mode
|
||||
* **Manual**: Replicate the resources manually when needed. **Note**: The deletion operations are not replicated.
|
||||
* **Scheduled**: Replicate the resources periodically. **Note**: The deletion operations are not replicated.
|
||||
* **Event Based**: When a new resource is pushed to the project, it is replicated to the remote registry immediately. Same to the deletion operation if the `Delete remote resources when locally deleted` checkbox is selected.
|
||||
If you do not enter a namespace, resources are placed in the same namespace as in the source registry.
|
||||
|
||||
![Destination and namespaces](../../img/replication-rule4.png)
|
||||
1. Use the Trigger Mode drop-down menu to select how and when to run the rule.
|
||||
* **Manual**: Replicate the resources manually when needed. **Note**: Deletion operations are not replicated.
|
||||
* **Scheduled**: Replicate the resources periodically by defining a cron job. **Note**: Deletion operations are not replicated.
|
||||
* **Event Based**: When a new resource is pushed to the project, or an image is retagged, it is replicated to the remote registry immediately. If you select the `Delete remote resources when locally deleted`, if you delete an image, it is automatically deleted from the replication target.
|
||||
|
||||
**NOTE**: You can filter images for replication based on the labels that are applied to the images. However, changing a label on an image does not trigger replication. Event-based replication is limited to pushing, retagging, and deleting images.
|
||||
|
||||
![Trigger mode](../../img/replication-rule5.png)
|
||||
|
||||
1. Optionally select the Override checkbox to force replicated resources to replace resources at the destination with the same name.
|
||||
1. Click **Save** to create the replication rule.
|
||||
|
@ -1,26 +1,19 @@
|
||||
# Manage Replications
|
||||
# Running Replication Manually
|
||||
|
||||
You can list, add, edit and delete rules under `Administration->Replications`.
|
||||
1. Log in to the Harbor interface with an account that has Harbor system administrator privileges.
|
||||
1. Expand **Administration**, and select **Replications**.
|
||||
1. Select a replication rule and click **Replicate**.
|
||||
|
||||
![browse project](../../img/manage_replication.png)
|
||||
![Add a replication rule](../../img/replication-rule6.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.
|
||||
The resources to which the rule is applied start to replicate from the source registry to the destination immediately.
|
||||
1. Click the rule to see its execution status.
|
||||
1. Click the **ID** of the execution to see the details of the replication and the task list. The count of `IN PROGRESS` status in the summary includes both `Pending` and `In Progress` tasks.
|
||||
1. Optionally click **STOP** to stop the replication.
|
||||
1. Click the log icon to see detailed information about the replication task.
|
||||
|
||||
![browse project](../../img/start_replicate.png)
|
||||
![View replication task](../../img/list_tasks.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.
|
||||
To edit or delete a replication rule, select the replication rule in the **Replications** view and click **Edit** or **Delete**. Only rules which have no executions in progress can be edited deleted.
|
||||
|
||||
![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)
|
||||
|
||||
### 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)
|
||||
![Delete or edit rule](../../img/replication-rule6.png)
|
BIN
docs/harbor-doc-reorg/img/add_labels_to_images.png
Normal file
After Width: | Height: | Size: 231 KiB |
BIN
docs/harbor-doc-reorg/img/filter_images_by_label.png
Normal file
After Width: | Height: | Size: 232 KiB |
BIN
docs/harbor-doc-reorg/img/list_tasks.png
Normal file
After Width: | Height: | Size: 250 KiB |
BIN
docs/harbor-doc-reorg/img/manage_global_level_labels.png
Normal file
After Width: | Height: | Size: 192 KiB |
BIN
docs/harbor-doc-reorg/img/manage_project_level_labels.png
Normal file
After Width: | Height: | Size: 205 KiB |
BIN
docs/harbor-doc-reorg/img/manage_registry.png
Normal file
After Width: | Height: | Size: 79 KiB |
BIN
docs/harbor-doc-reorg/img/replication-endpoint1.png
Normal file
After Width: | Height: | Size: 39 KiB |
BIN
docs/harbor-doc-reorg/img/replication-endpoint2.png
Normal file
After Width: | Height: | Size: 33 KiB |
BIN
docs/harbor-doc-reorg/img/replication-rule1.png
Normal file
After Width: | Height: | Size: 44 KiB |
BIN
docs/harbor-doc-reorg/img/replication-rule2.png
Normal file
After Width: | Height: | Size: 13 KiB |
BIN
docs/harbor-doc-reorg/img/replication-rule3.png
Normal file
After Width: | Height: | Size: 11 KiB |
BIN
docs/harbor-doc-reorg/img/replication-rule4.png
Normal file
After Width: | Height: | Size: 9.4 KiB |
BIN
docs/harbor-doc-reorg/img/replication-rule5.png
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
docs/harbor-doc-reorg/img/replication-rule6.png
Normal file
After Width: | Height: | Size: 19 KiB |
BIN
docs/harbor-doc-reorg/img/retag_image.png
Normal file
After Width: | Height: | Size: 12 KiB |
@ -1,25 +1,26 @@
|
||||
# Create Labels
|
||||
# Managing Labels
|
||||
|
||||
Harbor provides two kinds of labels to isolate kinds of resources(only images for now):
|
||||
* **Global Level Label**: Managed by system administrators and used to manage the images of the whole system. They can be added to images under any projects.
|
||||
Harbor provides two kinds of labels to isolate different kinds of resources:
|
||||
|
||||
* **Global Level Label**: Managed by Harbor system administrators and used to manage the images of the whole system. They can be added to images under any projects.
|
||||
* **Project Level Label**: Managed by project administrators under a project and can only be added to the images of the project.
|
||||
|
||||
### Managing global level labels
|
||||
The system administrators can list, create, update and delete the global level labels under `Administration->Configuration->Labels`:
|
||||
## 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)
|
||||
|
||||
### Managing project level labels
|
||||
The project administrators and system administrators can list, create, update and delete the project level labels under `Labels` tab of the project detail page:
|
||||
## 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)
|
||||
|
||||
### Adding labels to/remove labels from images
|
||||
Users who have 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:
|
||||
## 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)
|
||||
|
||||
### Filtering images by labels
|
||||
## Filtering Images by Label
|
||||
The images can be filtered by labels:
|
||||
|
||||
![filter images by labels](../img/filter_images_by_label.png)
|
@ -12,4 +12,4 @@ In Harbor portal, select the image you'd like to retag, and click the enabled `R
|
||||
|
||||
![retag image](../img/retag_image.png)
|
||||
|
||||
In the retag dialog, project name, repository name and the new tag should be specified. On click the `CONFIRM` button, the new tag would be created instantly. You can check the new tag in the corresponding project.
|
||||
In the retag dialog, project name, repository name and the new tag should be specified. On click the `CONFIRM` button, the new tag would be created instantly. You can check the new tag in the corresponding project.
|
||||
|