Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions modules/config-api-mirroring-organization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[id="mirroring-creating-org-api"]
= Creating a mirrored organization by using the API

[role="abstract"]
[role="_abstract"]
To create a mirrored organization in {productname} by using the API, you can send HTTP requests to the organization mirror API endpoints with `curl` and an OAuth bearer token. You can create and update mirror settings, read the configuration and mirrored repositories, start or cancel a sync, verify the external registry, and delete the setup.

[NOTE]
Expand Down Expand Up @@ -47,7 +47,6 @@ $ curl -X GET \
----
+
.Example output
+
[source,terminal]
----
{"is_enabled": true, "external_registry_type": "quay", "external_registry_url": "http://quay.io", "external_namespace": "test", "external_registry_username": null, "external_registry_config": {}, "repository_filters": [], "robot_username": "example+test", "visibility": "private", "sync_interval": 3600, "sync_start_date": "2025-01-01T00:00:00Z", "sync_expiration_date": null, "sync_status": "NEVER_RUN", "sync_retries_remaining": 3, "skopeo_timeout": 300, "creation_date": "2026-03-09T18:39:21.993431Z"}
Expand All @@ -64,7 +63,6 @@ $ curl -X GET \
----
+
.Example output
+
[source,terminal]
----
{"repositories": [], "page": 1, "limit": 100, "total": 0, "has_next": false}
Expand Down Expand Up @@ -107,7 +105,6 @@ $ curl -X PUT \
----
+
.Example output
+
[source,terminal]
----
" "
Expand Down
14 changes: 12 additions & 2 deletions modules/enabling-organization-mirroring-quay.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[id="enabling-organization-mirroring-quay"]
= Enabling organization mirroring for {productname}

[role="abstract"]
[role="_abstract"]
To use mirrored organizations, you can set `FEATURE_ORG_MIRROR` to `true` in your `config.yaml` file. Restart the registry after you update the configuration.

.Procedure
Expand Down Expand Up @@ -30,16 +30,26 @@ SSRF_ALLOWED_HOSTS:
where:
+
--
`FEATURE_PROXY_CACHE::` Specifies whether to enable or disable proxy caching. This field must be set to `true` to use the organization mirroring feature.
`FEATURE_PROXY_CACHE::` Specifies whether to enable or disable proxy caching. This field must be set to `true` to use the organization mirroring feature
.
`FEATURE_REPO_MIRROR`:: Specifies whether to enable or disable repository-level mirroring. This field must be set to `true` to use the organization mirroring feature.

`FEATURE_ORG_MIRROR`:: Specifies whether to enable or disable organization-level mirroring.

`ORG_MIRROR_INTERVAL`:: Specifies the worker processing interval in seconds.

`ORG_MIRROR_BATCH_SIZE`:: Specifies the number of organization mirrors to process for each iteration.

`ORG_MIRROR_MAX_SYNC_DURATION`:: Specifies the maximum sync duration in seconds.

`ORG_MIRROR_DEFAULT_SKOPEO_TIMEOUT`:: Specifies the default skopeo timeout in seconds.

`ORG_MIRROR_DISCOVERY_TIMEOUT`:: Specifies the discovery timeout in seconds.

`ORG_MIRROR_MAX_REPOS_PER_ORG`:: Specifies the maximum repositories to discover for each organization.

`ORG_MIRROR_MAX_RETRIES`:: Specifies the maximum sync retries for a failure operation.

`SSRF_ALLOWED_HOSTS`:: Specifies the allowed hosts for the Server Side Request Forgery (SSRF) protection. Use optional field to allow specific hosts to be accessed by the registry.
--

Expand Down
2 changes: 1 addition & 1 deletion modules/mirroring-creating-repository.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[id="mirroring-creating-repository"]
= Creating a mirrored repository by using the UI

[role="abstract"]
[role="_abstract"]
When mirroring a repository from an external container registry, you must create a new private repository. Typically, the same name is used as the target repository, for example, `quay-rhel9`.

.Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion modules/mirroring-starting-sync.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[id="mirroring-starting-sync"]
= Starting a mirroring synchronization

[role="abstract"]
[role="_abstract"]
To initiate a mirroring sync, you can navigate to the *Mirroring* tab of your repository and press the *Sync Now* button.

.Procedure
Expand Down
2 changes: 1 addition & 1 deletion modules/mirroring-worker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[id="mirroring-worker"]
= Creating a mirroring worker worker

[role="abstract"]
[role="_abstract"]
To use mirroring in a standalone deployment of {productname}, you must create a mirroring worker by running a Podman container with the `repomirror` option. Mount your `/root/ca.crt` CA bundle when you use TLS with that certificate.

.Procedure
Expand Down
Loading