Skip to content

Commit a07512b

Browse files
stevsmitSteven Smith
andauthored
Adds proxy cache feature to v2 UI (quay#1181)
Co-authored-by: Steven Smith <[email protected]>
1 parent b8832ad commit a07512b

File tree

2 files changed

+26
-18
lines changed

2 files changed

+26
-18
lines changed

modules/proxy-cache-procedure.adoc

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,40 +12,36 @@ The following procedure describes how you can use {productname} to proxy a remot
1212

1313
.Procedure
1414

15-
. In your Quay organization on the UI, for example, `cache-quayio`, click *Organization Settings* on the left hand pane.
15+
. On the {productname} v2 UI, click the name of an organization, for example, *cache-org*.
1616

17-
. Optional: Click *Add Storage Quota* to configure quota management for your organization. For more information about quota management, see link:https://access.redhat.com//documentation/en-us/red_hat_quay/3.7/html-single/use_red_hat_quay#red-hat-quay-quota-management-and-enforcement[Quota Management].
18-
+
19-
[NOTE]
20-
====
21-
In some cases, pulling images with Podman might return the following error when quota limit is reached during a pull: `unable to pull image: Error parsing image configuration: Error fetching blob: invalid status code from registry 403 (Forbidden)`. Error `403` is inaccurate, and occurs because Podman hides the correct API error: `Quota has been exceeded on namespace`. This known issue will be fixed in a future Podman update.
22-
====
17+
. In the navigation pane, click *Settings*.
2318

24-
. In *Remote Registry* enter the name of the remote registry to be cached, for example, `quay.io`, and click *Save*.
19+
. In the *Remote Registry* box, enter the name of the remote registry to be cached, for example, `quay.io`, and click *Save*.
2520
+
2621
[NOTE]
2722
====
2823
By adding a namespace to the *Remote Registry*, for example, `quay.io/<namespace>`, users in your organization will only be able to proxy from that namespace.
2924
====
3025

31-
. Optional: Add a *Remote Registry Username* and *Remote Registry Password*.
32-
+
33-
[NOTE]
34-
====
35-
If you do not set a *Remote Registry Username* and *Remote Registry Password*, you cannot add one without removing the proxy cache and creating a new registry.
36-
====
26+
. Optional. In the *Remote Registry username* box, enter the username for authenticating into the remote registry specified in the previous step. For anonymous pulls from the upstream, you can leave this empty. If you do note set a username at the time of creation, you cannot add one without removing the proxy cache and creating a new registry.
27+
28+
. Optional. In the *Remote registry password* box, enter the password for authenticating into the remote registry. For anonymous pulls from the upstream, you can leave this empty. If you do note set a username at the time of creation, you cannot add one without removing the proxy cache and creating a new registry.
3729

38-
. Optional: Set a time in the *Expiration* field.
30+
. Optional. Set a time in the *Expiration* field.
3931
+
4032
[NOTE]
4133
====
42-
* The default tag *Expiration* field for cached images in a proxy organization is set to 86400 seconds. In the proxy organization, the tag expiration is refreshed to the value set in the UI's *Expiration* field every time the tag is pulled. This feature is different than Quay's default link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/use_red_hat_quay/index#tag-expiration[individual tag expiration] feature. In a proxy organization, it is possible to override the individual tag feature. When this happens, the individual tag's expiration is reset according to the *Expiration* field of the proxy organization.
43-
* Expired images will disappear after the allotted time, but are still stored in Quay. The time in which an image is completely deleted, or collected, depends on the *Time Machine* setting of your organization. The default time for garbage collection is 14 days unless otherwise specified.
34+
* The default tag *Expiration* field for cached images in a proxy organization is set to 86400 seconds. In the proxy organization, the tag expiration is refreshed to the value set in the UI's *Expiration* field every time the tag is pulled. This feature is different than Quay's default link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/use_red_hat_quay/index#tag-expiration[individual tag expiration] feature. In a proxy organization, it is possible to override the individual tag feature. When this happens, the individual tag's expiration is reset according to the *Expiration* field of the proxy organization.
35+
* Expired images will disappear after the allotted time, but are still stored in {productname}. The time in which an image is completely deleted, or collected, depends on the *Time Machine* setting of your organization. The default time for garbage collection is 14 days unless otherwise specified.
4436
====
4537

38+
. Optional. Check the *http* box if you want an unsecure protocol used. If not checked, https is used to request the remote registry.
39+
4640
. Click *Save*.
4741

48-
. On the CLI, pull a public image from the registry, for example, quay.io, acting as a proxy cache:
42+
.Verification
43+
44+
. On the CLI, pull a public image from the remote registry that was specified, for example, `quay.io`, acting as a proxy cache:
4945
+
5046
----
5147
$ podman pull <registry_url>/<organization_name>/<quayio_namespace>/<image_name>

modules/rn_3_13_0.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ Issued 2024-12-12
1111

1212
{productname} release 3.13.2 is now available with Clair {clairproductminv}. The bug fixes that are included in the update are listed in the link:https://access.redhat.com/errata/RHBA-2024:10967[RHBA-2024:10967] advisory.
1313

14+
[id="enhancements-313-2"]
15+
=== {productname} 3.13.2 new features
16+
17+
With this release, a pull-through cache organization can now be created when using the {productname} v2 UI. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/use_red_hat_quay/index#red-hat-quay-proxy-cache-procedure[Using {productname} to proxy a remote registry].
18+
19+
[id="known-issue-313-2"]
20+
=== {productname} 3.13.2 known issues
21+
22+
When using the pull-through proxy feature in {productname} with quota management enabled, and the organization quota fills up, it is expected that {productname} removes the least recently used image to free up space for new cached entries. However, images pull by digest are not evicted automatically when the quota is exceeded, which causes subsequent pull attempts to return a `Quota has been exceeded on namespace` error.
23+
24+
As a temporary workaround, you can run a bash shell inside of the {productname} database pod to make digest-pulled images visible for eviction with the following setting: `update tag set hidden = 0;`. For more information, see link:https://issues.redhat.com/browse/PROJQUAY-8071[PROJQUAY-8071].
25+
1426
[id="bug-fixes-313-2"]
1527
=== {productname} 3.13.2 bug fixes
1628

0 commit comments

Comments
 (0)