Jump To Close Expand all Collapse all Table of contents Manage Red Hat Quay Preface 1. Advanced Red Hat Quay configuration Expand section "1. Advanced Red Hat Quay configuration" Collapse section "1. Advanced Red Hat Quay configuration" 1.1. Using Red Hat Quay Config Tool to modify Red Hat Quay Expand section "1.1. Using Red Hat Quay Config Tool to modify Red Hat Quay" Collapse section "1.1. Using Red Hat Quay Config Tool to modify Red Hat Quay" 1.1.1. Running the Config Tool from the command line 1.1.2. Deploying the config tool using TLS certificates 1.2. Using the API to modify Red Hat Quay 1.3. Editing the config.yaml file to modify Red Hat Quay Expand section "1.3. Editing the config.yaml file to modify Red Hat Quay" Collapse section "1.3. Editing the config.yaml file to modify Red Hat Quay" 1.3.1. Adding name and company to Red Hat Quay sign-in 2. Using the configuration API Expand section "2. Using the configuration API" Collapse section "2. Using the configuration API" 2.1. Retrieving the default configuration 2.2. Retrieving the current configuration 2.3. Validating configuration using the API 2.4. Determining the required fields 3. Getting Red Hat Quay release notifications 4. Using SSL to protect connections to Red Hat Quay Expand section "4. Using SSL to protect connections to Red Hat Quay" Collapse section "4. Using SSL to protect connections to Red Hat Quay" 4.1. Using SSL/TLS 4.2. Creating a Certificate Authority Expand section "4.2. Creating a Certificate Authority" Collapse section "4.2. Creating a Certificate Authority" 4.2.1. Signing the certificate 4.3. Configuring SSL/TLS using the command line interface 4.4. Configuring SSL/TLS using the Red Hat Quay UI 4.5. Testing the SSL/TLS configuration using the CLI 4.6. Testing the SSL/TLS configuration using a browser 4.7. Configuring Podman to trust the Certificate Authority 4.8. Configuring the system to trust the certificate authority 5. Adding TLS Certificates to the Red Hat Quay Container Expand section "5. Adding TLS Certificates to the Red Hat Quay Container" Collapse section "5. Adding TLS Certificates to the Red Hat Quay Container" 5.1. Add TLS certificates to Red Hat Quay 5.2. Adding custom SSL/TLS certificates when Red Hat Quay is deployed on Kubernetes 6. Configuring action log storage for Elasticsearch and Splunk Expand section "6. Configuring action log storage for Elasticsearch and Splunk" Collapse section "6. Configuring action log storage for Elasticsearch and Splunk" 6.1. Configuring action log storage for Elasticsearch 6.2. Configuring action log storage for Splunk Expand section "6.2. Configuring action log storage for Splunk" Collapse section "6.2. Configuring action log storage for Splunk" 6.2.1. Installing and creating a username for Splunk 6.2.2. Generating a Splunk token Expand section "6.2.2. Generating a Splunk token" Collapse section "6.2.2. Generating a Splunk token" 6.2.2.1. Generating a Splunk token using the Splunk UI 6.2.2.2. Generating a Splunk token using the CLI 6.2.3. Configuring Red Hat Quay to use Splunk 6.2.4. Creating an action log 7. Clair security scanner Expand section "7. Clair security scanner" Collapse section "7. Clair security scanner" 7.1. Clair vulnerability databases Expand section "7.1. Clair vulnerability databases" Collapse section "7.1. Clair vulnerability databases" 7.1.1. Information about Open Source Vulnerability (OSV) database for Clair 7.2. Setting up Clair on standalone Red Hat Quay deployments 7.3. Clair on OpenShift Container Platform 7.4. Testing Clair 8. Repository mirroring Expand section "8. Repository mirroring" Collapse section "8. Repository mirroring" 8.1. Repository mirroring 8.2. Repository mirroring compared to geo-replication 8.3. Using repository mirroring 8.4. Mirroring configuration UI 8.5. Mirroring configuration fields 8.6. Mirroring worker 8.7. Creating a mirrored repository Expand section "8.7. Creating a mirrored repository" Collapse section "8.7. Creating a mirrored repository" 8.7.1. Repository mirroring settings 8.7.2. Advanced settings 8.7.3. Synchronize now 8.8. Event notifications for mirroring 8.9. Mirroring tag patterns Expand section "8.9. Mirroring tag patterns" Collapse section "8.9. Mirroring tag patterns" 8.9.1. Pattern syntax 8.9.2. Example tag patterns 8.10. Working with mirrored repositories 8.11. Repository mirroring recommendations 9. IPv6 and dual-stack deployments Expand section "9. IPv6 and dual-stack deployments" Collapse section "9. IPv6 and dual-stack deployments" 9.1. Enabling the IPv6 protocol family 9.2. Enabling the dual-stack protocol family 9.3. IPv6 and dua-stack limitations 10. LDAP Authentication Setup for Red Hat Quay Expand section "10. LDAP Authentication Setup for Red Hat Quay" Collapse section "10. LDAP Authentication Setup for Red Hat Quay" 10.1. Considerations when enabling LDAP 10.2. Configuring LDAP for Red Hat Quay 10.3. Enabling the LDAP_RESTRICTED_USER_FILTER configuration field 10.4. Enabling the LDAP_SUPERUSER_FILTER configuration field 10.5. Common LDAP configuration issues 10.6. LDAP configuration fields 11. Configuring OIDC for Red Hat Quay Expand section "11. Configuring OIDC for Red Hat Quay" Collapse section "11. Configuring OIDC for Red Hat Quay" 11.1. Configuring Red Hat Single Sign-On for Red Hat Quay Expand section "11.1. Configuring Red Hat Single Sign-On for Red Hat Quay" Collapse section "11.1. Configuring Red Hat Single Sign-On for Red Hat Quay" 11.1.1. Configuring the Red Hat Single Sign-On Operator for the Red Hat Quay Operator 11.1.2. Configuring the Red Hat Quay Operator to use Red Hat Single Sign-On 11.2. Configuring Azure AD OIDC for Red Hat Quay Expand section "11.2. Configuring Azure AD OIDC for Red Hat Quay" Collapse section "11.2. Configuring Azure AD OIDC for Red Hat Quay" 11.2.1. Configuring Azure AD by using the Red Hat Quay config tool 11.2.2. Configuring Azure AD by updating the Red Hat Quay config.yaml file 12. Prometheus and Grafana metrics under Red Hat Quay Expand section "12. Prometheus and Grafana metrics under Red Hat Quay" Collapse section "12. Prometheus and Grafana metrics under Red Hat Quay" 12.1. Exposing the Prometheus endpoint Expand section "12.1. Exposing the Prometheus endpoint" Collapse section "12.1. Exposing the Prometheus endpoint" 12.1.1. Standalone Red Hat Quay 12.1.2. Red Hat Quay Operator 12.1.3. Setting up Prometheus to consume metrics 12.1.4. DNS configuration under Kubernetes 12.1.5. DNS configuration for a manual cluster 12.2. Introduction to metrics Expand section "12.2. Introduction to metrics" Collapse section "12.2. Introduction to metrics" 12.2.1. General registry statistics 12.2.2. Queue items 12.2.3. Garbage collection metrics Expand section "12.2.3. Garbage collection metrics" Collapse section "12.2.3. Garbage collection metrics" 12.2.3.1. Multipart uploads metrics 12.2.4. Image push / pull metrics Expand section "12.2.4. Image push / pull metrics" Collapse section "12.2.4. Image push / pull metrics" 12.2.4.1. Image pulls total 12.2.4.2. Image bytes pulled 12.2.4.3. Image pushes total 12.2.4.4. Image bytes pushed 12.2.5. Authentication metrics 13. Red Hat Quay quota management and enforcement overview Expand section "13. Red Hat Quay quota management and enforcement overview" Collapse section "13. Red Hat Quay quota management and enforcement overview" 13.1. Quota management limitations 13.2. Quota management for Red Hat Quay 3.9 Expand section "13.2. Quota management for Red Hat Quay 3.9" Collapse section "13.2. Quota management for Red Hat Quay 3.9" 13.2.1. Option A: Configuring quota management for Red Hat Quay 3.9 by adjusting the QUOTA_TOTAL_DELAY feature flag 13.2.2. Option B: Configuring quota management for Red Hat Quay 3.9 by setting QUOTA_TOTAL_DELAY_SECONDS to 0 13.3. Testing quota management for Red Hat Quay 3.9 13.4. Setting default quota 13.5. Establishing quota in Red Hat Quay UI 13.6. Establishing quota with the Red Hat Quay API Expand section "13.6. Establishing quota with the Red Hat Quay API" Collapse section "13.6. Establishing quota with the Red Hat Quay API" 13.6.1. Setting the quota 13.6.2. Viewing the quota 13.6.3. Modifying the quota 13.6.4. Pushing images Expand section "13.6.4. Pushing images" Collapse section "13.6.4. Pushing images" 13.6.4.1. Pushing ubuntu:18.04 13.6.4.2. Using the API to view quota usage 13.6.4.3. Pushing another image 13.6.5. Rejecting pushes using quota limits Expand section "13.6.5. Rejecting pushes using quota limits" Collapse section "13.6.5. Rejecting pushes using quota limits" 13.6.5.1. Setting reject and warning limits 13.6.5.2. Viewing reject and warning limits 13.6.5.3. Pushing an image when the reject limit is exceeded 13.6.5.4. Notifications for limits exceeded 13.7. Calculating the total registry size in Red Hat Quay 3.9 13.8. Permanently deleting an image tag Expand section "13.8. Permanently deleting an image tag" Collapse section "13.8. Permanently deleting an image tag" 13.8.1. Permanently deleting an image tag using the Red Hat Quay v2 UI 13.8.2. Permanently deleting an image tag using the Red Hat Quay legacy UI 14. Red Hat Quay namespace auto-pruning overview Expand section "14. Red Hat Quay namespace auto-pruning overview" Collapse section "14. Red Hat Quay namespace auto-pruning overview" 14.1. Prerequisites and limitations for namespace auto-pruning 14.2. Managing namespace auto-pruning policies using the Red Hat Quay UI Expand section "14.2. Managing namespace auto-pruning policies using the Red Hat Quay UI" Collapse section "14.2. Managing namespace auto-pruning policies using the Red Hat Quay UI" 14.2.1. Configuring the Red Hat Quay namespace auto-pruning feature 14.2.2. Creating an auto-prune policy using the Red Hat Quay v2 UI 14.2.3. Creating an auto-prune policy using the Red Hat Quay API 14.2.4. Creating an auto-prune policy for the current user using the API 15. Geo-replication Expand section "15. Geo-replication" Collapse section "15. Geo-replication" 15.1. Geo-replication features 15.2. Geo-replication requirements and constraints Expand section "15.2. Geo-replication requirements and constraints" Collapse section "15.2. Geo-replication requirements and constraints" 15.2.1. Enable storage replication - standalone Quay 15.2.2. Run Red Hat Quay with storage preferences 15.2.3. Removing a geo-replicated site from your standalone Red Hat Quay deployment 15.2.4. Setting up geo-replication on OpenShift Container Platform Expand section "15.2.4. Setting up geo-replication on OpenShift Container Platform" Collapse section "15.2.4. Setting up geo-replication on OpenShift Container Platform" 15.2.4.1. Configuring geo-replication for the Red Hat Quay on OpenShift Container Platform 15.2.5. Removing a geo-replicated site from your Red Hat Quay on OpenShift Container Platform deployment 15.3. Mixed storage for geo-replication 16. Backing up and restoring Red Hat Quay on a standalone deployment Expand section "16. Backing up and restoring Red Hat Quay on a standalone deployment" Collapse section "16. Backing up and restoring Red Hat Quay on a standalone deployment" 16.1. Backing up Red Hat Quay on standalone deployments 16.2. Restoring Red Hat Quay on standalone deployments 17. Migrating a standalone Red Hat Quay deployment to a Red Hat Quay Operator deployment Expand section "17. Migrating a standalone Red Hat Quay deployment to a Red Hat Quay Operator deployment" Collapse section "17. Migrating a standalone Red Hat Quay deployment to a Red Hat Quay Operator deployment" 17.1. Backing up a standalone deployment of Red Hat Quay 17.2. Using backed up standalone content to migrate to OpenShift Container Platform. 18. Configuring artifact types Expand section "18. Configuring artifact types" Collapse section "18. Configuring artifact types" 18.1. Configuring OCI artifact types 18.2. Configuring additional artifact types 18.3. Configuring unknown media types 19. Red Hat Quay garbage collection Expand section "19. Red Hat Quay garbage collection" Collapse section "19. Red Hat Quay garbage collection" 19.1. Red Hat Quay garbage collection in practice Expand section "19.1. Red Hat Quay garbage collection in practice" Collapse section "19.1. Red Hat Quay garbage collection in practice" 19.1.1. Measuring storage reclamation 19.2. Garbage collection configuration fields 19.3. Disabling garbage collection 19.4. Garbage collection and quota management 19.5. Garbage collection in practice 19.6. Red Hat Quay garbage collection metrics 20. Using the v2 UI Expand section "20. Using the v2 UI" Collapse section "20. Using the v2 UI" 20.1. v2 user interface configuration Expand section "20.1. v2 user interface configuration" Collapse section "20.1. v2 user interface configuration" 20.1.1. Creating a new organization using the v2 UI 20.1.2. Deleting an organization using the v2 UI 20.1.3. Creating a new repository using the v2 UI 20.1.4. Deleting a repository using the v2 UI 20.1.5. Pushing an image to the v2 UI 20.1.6. Deleting an image using the v2 UI 20.1.7. Creating a new team using the Red Hat Quay v2 UI 20.1.8. Creating a robot account using the v2 UI Expand section "20.1.8. Creating a robot account using the v2 UI" Collapse section "20.1.8. Creating a robot account using the v2 UI" 20.1.8.1. Bulk managing robot account repository access using the Red Hat Quay v2 UI 20.1.9. Creating default permissions using the Red Hat Quay v2 UI 20.1.10. Organization settings for the v2 UI 20.1.11. Viewing image tag information using the v2 UI 20.1.12. Adjusting repository settings using the v2 UI 20.2. Viewing Red Hat Quay tag history 20.3. Adding and managing labels on the Red Hat Quay v2 UI 20.4. Setting tag expirations on the Red Hat Quay v2 UI 20.5. Enabling the legacy UI 21. Performing health checks on Red Hat Quay deployments Expand section "21. Performing health checks on Red Hat Quay deployments" Collapse section "21. Performing health checks on Red Hat Quay deployments" 21.1. Red Hat Quay health check endpoints 21.2. Navigating to a Red Hat Quay health check endpoint 22. Branding a Red Hat Quay deployment on the legacy UI 23. Schema for Red Hat Quay configuration Legal Notice Settings Close Language: 简体中文 日本語 English Language: 简体中文 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 简体中文 日本語 English Language: 简体中文 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Manage Red Hat Quay Red Hat Quay 3Manage Red Hat QuayRed Hat OpenShift Documentation TeamLegal NoticeAbstract Manage Red Hat Quay Next