Red Hat Summit Red Hat SummitSupportoConsoleSviluppatoriInizia una provaContatti

Questo contenuto non è disponibile nella lingua selezionata.

Chapter 14. Red Hat Quay namespace auto-pruning overview

Red Hat Quay administrators can set up auto-pruning policies on namespaces (both users and organization). This feature allows for image tags to be automatically deleted within a namespace based on specified criteria, which allows Red Hat Quay organization owners to stay below the storage quota by automatically pruning content.

Currently, two policies have been added:

  • Prune images by the number of tags. For this policy, when the actual number of tags exceeds the desired number of tags, the oldest tags are deleted by their creation date until the desired number of tags is achieved.
  • Prune image tags by creation date. For this policy, any tags with a creation date older than the given time span, for example, 10 days, are deleted.

After tags are automatically pruned, they go into the Red Hat Quay time machine, or the amount of time, after a tag is deleted, that the tag is accessible before being garbage collected. The expiration time of an image tag is dependent on your organization’s settings. For more information, see Red Hat Quay garbage collection.

Users can only configure one policy per namespace; this can be done through the Red Hat Quay v2 UI. Policies can also be set by using the API endpoints through the command-line interface (CLI).

14.1. Prerequisites and limitations for namespace auto-pruning
Copia collegamento

The following prerequisites and limitations apply to the namespace auto-pruning feature:

  • This feature is not available when using the Red Hat Quay legacy UI. You must use the v2 UI to create, view, or modify namespace pruning policies.
  • Namespace auto-pruning is only supported in databases that support the FOR UPDATE SKIP LOCKED SQL command.
  • Auto-pruning is unavailable on mirrored repositories and read-only repositories.

14.2. Managing namespace auto-pruning policies using the Red Hat Quay UI
Copia collegamento

Namespace auto-pruning policies are created using the Red Hat Quay UI v2. This can be done after you have configured your Red Hat Quay config.yaml file to enable the auto-pruning feature and the v2 UI.

Note

This feature is not available when using the Red Hat Quay legacy UI.

14.2.1. Configuring the Red Hat Quay namespace auto-pruning feature
Copia collegamento

Use the following procedure to configure your Red Hat Quay config.yaml file to enable the namespace auto-pruning feature.

Prerequisites

  • You have set FEATURE_UI_V2 to true in your config.yaml file.

Procedure

  • In your Red Hat Quay config.yaml file, add, and set, the FEATURE_AUTO_PRUNE environment variable to True. For example: 

    # ...
FEATURE_AUTO_PRUNE: true
# ...
    Copy to Clipboard Toggle word wrap

14.2.2. Creating an auto-prune policy using the Red Hat Quay v2 UI
Copia collegamento

Use the following procedure to create an auto-prune policy using the Red Hat Quay UI v2.

Prerequisites

  • You have enabled the FEATURE_AUTO_PRUNE feature.

Procedure

  1. Tag four sample images, for example, busybox, that will be pushed to the repository with auto-pruning enabled. For example: 

    $ podman tag docker.io/library/busybox <quay-server.example.com>/<quayadmin>/busybox:test
    Copy to Clipboard Toggle word wrap 
    $ podman tag docker.io/library/busybox <quay-server.example.com>/<quayadmin>/busybox:test2
    Copy to Clipboard Toggle word wrap 
    $ podman tag docker.io/library/busybox <quay-server.example.com>/<quayadmin>/busybox:test3
    Copy to Clipboard Toggle word wrap 
    $ podman tag docker.io/library/busybox <quay-server.example.com>/<quayadmin>/busybox:test4
    Copy to Clipboard Toggle word wrap

  2. Push the four sample images, for example, busybox, to the repository with auto-pruning enabled by entering the following commands: 

    $ podman push <quay-server.example.com>/quayadmin/busybox:test
    Copy to Clipboard Toggle word wrap 
    $ podman push <quay-server.example.com>/<quayadmin>/busybox:test2
    Copy to Clipboard Toggle word wrap 
    $ podman push <quay-server.example.com>/<quayadmin>/busybox:test3
    Copy to Clipboard Toggle word wrap 
    $ podman push <quay-server.example.com>/<quayadmin>/busybox:test4
    Copy to Clipboard Toggle word wrap
  3. Check that there are four tags in your repository.
  4. On the Red Hat Quay UI v2, click Organizations in the navigation pane.
  5. Select the name of an organization that you will apply the auto-pruning feature to, for example, test_organization.
  6. Click Settings.

  7. Click Auto-Prune Policies. For example:

    Auto-Prune Policies page

  8. Click the drop down menu and select the desired policy, for example, By number of tags.
  9. Select the desired number of tags to keep. By default, this is set at 20 tags. For this example, the number of tags to keep is set at 3.

Click Save. The following alert is received: Successfully updated auto-prune policy.

Verification

  • Navigate to the Tags page of your repository. After a few minutes, the auto-pruner worker removes tags that no longer fit within the established criteria. In this example, it removes the busybox:test tag, and keeps the busybox:test2, busybox:test3, and busybox:test4 tag.

    After tags are automatically pruned, they go into the Red Hat Quay time machine, or the amount of time, after a tag is deleted, that the tag is accessible before being garbage collected. The expiration time of an image tag is dependent on your organization’s settings. For more information, see Red Hat Quay garbage collection.

14.2.3. Creating an auto-prune policy using the Red Hat Quay API
Copia collegamento

You can use Red Hat Quay API endpoints to manage auto-pruning policies for an organization.

Prerequisites

  • You have set BROWSER_API_CALLS_XHR_ONLY: false in your config.yaml file.
  • You have created an OAuth access token.
  • You have logged into Red Hat Quay.

Procedure

  1. Enter the following POST command create a new policy that limits the number of tags allowed in an organization: 

    $ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{
    "method": "number_of_tags",
    "value": 10
}' http://<quay-server.example.com>/api/v1/organization/<quayadmin>/autoprunepolicy/
    Copy to Clipboard Toggle word wrap

    Alternatively, you can can set tags to expire for a specified time after their creation date: 

    $ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{
    "method": "creation_date",
    "value": "7d"
}' http://<quay-server.example.com>/api/v1/organization/<quayadmin>/autoprunepolicy/
    Copy to Clipboard Toggle word wrap

    Example output

    {"uuid": "73d64f05-d587-42d9-af6d-e726a4a80d6e"}
    Copy to Clipboard Toggle word wrap

    Attempting to create multiple policies returns the following error: 

    {"detail": "Policy for this namespace already exists, delete existing to create new policy", "error_message": "Policy for this namespace already exists, delete existing to create new policy", "error_type": "invalid_request", "title": "invalid_request", "type": "http://<quay-server.example.com>/api/v1/error/invalid_request", "status": 400}
    Copy to Clipboard Toggle word wrap

  2. Check your auto-prune policy by entering the following command: 

    $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/organization/<quayadmin>/autoprunepolicy/
    Copy to Clipboard Toggle word wrap

    Example output

    {"policies": [{"uuid": "73d64f05-d587-42d9-af6d-e726a4a80d6e", "method": "creation_date", "value": "7d"}]}
    Copy to Clipboard Toggle word wrap

  3. You can delete the auto-prune policy by entering the following command: 

    $ curl -X DELETE -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/organization/<quayadmin>/autoprunepolicy/
    Copy to Clipboard Toggle word wrap

14.2.4. Creating an auto-prune policy for the current user using the API
Copia collegamento

You can use Red Hat Quay API endpoints to manage auto-pruning policies for your account.

Note

The use of /user/ in the following commands represents the user that is currently logged into Red Hat Quay.

Prerequisites

  • You have set BROWSER_API_CALLS_XHR_ONLY: false in your config.yaml file.
  • You have created an OAuth access token.
  • You have logged into Red Hat Quay.

Procedure

  1. Enter the following POST command create a new policy that limits the number of tags for the current user: 

    $ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{
    "method": "number_of_tags",
    "value": 10
}' http://<quay-server.example.com>/api/v1/user/autoprunepolicy/
    Copy to Clipboard Toggle word wrap

    Example output

    {"uuid": "8c03f995-ca6f-4928-b98d-d75ed8c14859"}
    Copy to Clipboard Toggle word wrap

  2. Check your auto-prune policy by entering the following command: 

    $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/user/autoprunepolicy/8c03f995-ca6f-4928-b98d-d75ed8c14859
    Copy to Clipboard Toggle word wrap

    Alternatively, you can include the UUID: 

    $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/user/autoprunepolicy/8c03f995-ca6f-4928-b98d-d75ed8c14859
{"uuid": "8c03f995-ca6f-4928-b98d-d75ed8c14859", "method": "number_of_tags", "value": 10}
    Copy to Clipboard Toggle word wrap

    Example output

    {"policies": [{"uuid": "8c03f995-ca6f-4928-b98d-d75ed8c14859", "method": "number_of_tags", "value": 10}]}
    Copy to Clipboard Toggle word wrap

  3. You can delete the auto-prune policy by entering the following command. Note that deleting the policy require the UUID. 

    $ curl -X DELETE -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/user/autoprunepolicy/8c03f995-ca6f-4928-b98d-d75ed8c14859
    Copy to Clipboard Toggle word wrap

    Example output

    {"uuid": "8c03f995-ca6f-4928-b98d-d75ed8c14859"}
    Copy to Clipboard Toggle word wrap

Torna in cima
Red Hat logoGithubredditYoutubeTwitter

Formazione

Prova, acquista e vendi

Community

Informazioni sulla documentazione di Red Hat

Aiutiamo gli utenti Red Hat a innovarsi e raggiungere i propri obiettivi con i nostri prodotti e servizi grazie a contenuti di cui possono fidarsi. Esplora i nostri ultimi aggiornamenti.

Rendiamo l’open source più inclusivo

Red Hat si impegna a sostituire il linguaggio problematico nel codice, nella documentazione e nelle proprietà web. Per maggiori dettagli, visita il Blog di Red Hat.

Informazioni su Red Hat

Forniamo soluzioni consolidate che rendono più semplice per le aziende lavorare su piattaforme e ambienti diversi, dal datacenter centrale all'edge della rete.

Theme

© 2025 Red Hat