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 Red Hat Quay Operator 1.1.2. Running the Config Tool from the command line 1.1.3. 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. Add name and company to Red Hat Quay sign-in 1.3.2. Disable TLS Protocols 1.3.3. Rate limit API calls 1.3.4. Adjust database connection pooling Expand section "1.3.4. Adjust database connection pooling" Collapse section "1.3.4. Adjust database connection pooling" 1.3.4.1. Database connection arguments 1.3.4.2. Database SSL configuration Expand section "1.3.4.2. Database SSL configuration" Collapse section "1.3.4.2. Database SSL configuration" 1.3.4.2.1. PostgreSQL SSL connection arguments 1.3.4.2.2. MySQL SSL connection arguments 1.3.4.3. HTTP connection counts 1.3.4.4. Dynamic process counts 1.3.4.5. Environment variables 1.3.4.6. Turning off connection pooling 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 and signing a certificate Expand section "4.2. Creating a certificate authority and signing a certificate" Collapse section "4.2. Creating a certificate authority and signing a certificate" 4.2.1. Creating a certificate authority 4.2.2. Signing a certificate 4.3. Configuring SSL using the command line interface 4.4. Configuring SSL/TLS using the Red Hat Quay UI 4.5. Testing SSL configuration using the command line 4.6. Testing SSL configuration using the 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. Add certs when deployed on Kubernetes 6. Configuring action log storage for Elasticsearch 7. Clair for Red Hat Quay Expand section "7. Clair for Red Hat Quay" Collapse section "7. Clair for Red Hat Quay" 7.1. Clair vulnerability databases 7.2. Setting up Clair on standalone Red Hat Quay deployments 7.3. Clair on OpenShift Container Platform 7.4. Testing Clair 8. Integrating Red Hat Quay into OpenShift Container Platform with the Quay Bridge Operator Expand section "8. Integrating Red Hat Quay into OpenShift Container Platform with the Quay Bridge Operator" Collapse section "8. Integrating Red Hat Quay into OpenShift Container Platform with the Quay Bridge Operator" 8.1. Setting up Red Hat Quay for the Quay Bridge Operator 8.2. Installing the Quay Bridge Operator on OpenShift Container Platform 8.3. Creating an OpenShift Container Platform secret for the OAuth token 8.4. Creating the QuayIntegration custom resource Expand section "8.4. Creating the QuayIntegration custom resource" Collapse section "8.4. Creating the QuayIntegration custom resource" 8.4.1. Optional: Creating the QuayIntegration custom resource using the CLI Expand section "8.4.1. Optional: Creating the QuayIntegration custom resource using the CLI" Collapse section "8.4.1. Optional: Creating the QuayIntegration custom resource using the CLI" 8.4.1.1. Optional: Creating the QuayIntegration custom resource using the web console 8.5. QuayIntegration configuration fields 9. Repository mirroring Expand section "9. Repository mirroring" Collapse section "9. Repository mirroring" 9.1. Repository mirroring 9.2. Repository mirroring compared to geo-replication 9.3. Using repository mirroring 9.4. Mirroring configuration UI 9.5. Mirroring configuration fields 9.6. Mirroring worker 9.7. Creating a mirrored repository Expand section "9.7. Creating a mirrored repository" Collapse section "9.7. Creating a mirrored repository" 9.7.1. Repository mirroring settings 9.7.2. Advanced settings 9.7.3. Synchronize now 9.8. Event notifications for mirroring 9.9. Mirroring tag patterns Expand section "9.9. Mirroring tag patterns" Collapse section "9.9. Mirroring tag patterns" 9.9.1. Pattern syntax 9.9.2. Example tag patterns 9.10. Working with mirrored repositories 9.11. Repository mirroring recommendations 10. IPv6 and dual-stack deployments Expand section "10. IPv6 and dual-stack deployments" Collapse section "10. IPv6 and dual-stack deployments" 10.1. Enabling the IPv6 protocol family 10.2. Enabling the dual-stack protocol family 10.3. IPv6 and dua-stack limitations 11. LDAP Authentication Setup for Red Hat Quay Expand section "11. LDAP Authentication Setup for Red Hat Quay" Collapse section "11. LDAP Authentication Setup for Red Hat Quay" 11.1. Considerations prior to enabling LDAP Expand section "11.1. Considerations prior to enabling LDAP" Collapse section "11.1. Considerations prior to enabling LDAP" 11.1.1. Existing Quay deployments 11.1.2. Manual User Creation and LDAP authentication 11.2. Set Up LDAP Configuration Expand section "11.2. Set Up LDAP Configuration" Collapse section "11.2. Set Up LDAP Configuration" 11.2.1. Full LDAP URI 11.2.2. Team Synchronization 11.2.3. Base and Relative Distinguished Names 11.2.4. Additional User Filters Expand section "11.2.4. Additional User Filters" Collapse section "11.2.4. Additional User Filters" 11.2.4.1. Enabling the LDAP_RESTRICTED_USER_FILTER configuration field 11.2.5. Administrator DN 11.2.6. UID and Mail attributes 11.2.7. Validation 11.3. Common Issues 11.4. Configure an LDAP user as superuser 11.5. Enabling the LDAP_SUPERUSER_FILTER configuration field 12. Configuring OIDC for Red Hat Quay Expand section "12. Configuring OIDC for Red Hat Quay" Collapse section "12. Configuring OIDC for Red Hat Quay" 12.1. Configuring Red Hat Single Sign-On for Red Hat Quay Expand section "12.1. Configuring Red Hat Single Sign-On for Red Hat Quay" Collapse section "12.1. Configuring Red Hat Single Sign-On for Red Hat Quay" 12.1.1. Configuring the Red Hat Single Sign-On Operator for the Red Hat Quay Operator 12.1.2. Configuring the Red Hat Quay Operator to use Red Hat Single Sign-On 12.2. Configuring Azure AD OIDC for Red Hat Quay Expand section "12.2. Configuring Azure AD OIDC for Red Hat Quay" Collapse section "12.2. Configuring Azure AD OIDC for Red Hat Quay" 12.2.1. Configuring Azure AD by using the Red Hat Quay config tool 12.2.2. Configuring Azure AD by updating the Red Hat Quay config.yaml file 13. Prometheus and Grafana metrics under Red Hat Quay Expand section "13. Prometheus and Grafana metrics under Red Hat Quay" Collapse section "13. Prometheus and Grafana metrics under Red Hat Quay" 13.1. Exposing the Prometheus endpoint Expand section "13.1. Exposing the Prometheus endpoint" Collapse section "13.1. Exposing the Prometheus endpoint" 13.1.1. Standalone Red Hat Quay 13.1.2. Red Hat Quay Operator 13.1.3. Setting up Prometheus to consume metrics 13.1.4. DNS configuration under Kubernetes 13.1.5. DNS configuration for a manual cluster 13.2. Introduction to metrics Expand section "13.2. Introduction to metrics" Collapse section "13.2. Introduction to metrics" 13.2.1. General registry statistics 13.2.2. Queue items 13.2.3. Garbage collection metrics Expand section "13.2.3. Garbage collection metrics" Collapse section "13.2.3. Garbage collection metrics" 13.2.3.1. Multipart uploads metrics 13.2.4. Image push / pull metrics Expand section "13.2.4. Image push / pull metrics" Collapse section "13.2.4. Image push / pull metrics" 13.2.4.1. Image pulls total 13.2.4.2. Image bytes pulled 13.2.4.3. Image pushes total 13.2.4.4. Image bytes pushed 13.2.5. Authentication metrics 14. Red Hat Quay quota management and enforcement Expand section "14. Red Hat Quay quota management and enforcement" Collapse section "14. Red Hat Quay quota management and enforcement" 14.1. Quota management configuration Expand section "14.1. Quota management configuration" Collapse section "14.1. Quota management configuration" 14.1.1. Default quota 14.2. Quota management architecture 14.3. Establishing quota in Red Hat Quay UI 14.4. Establishing quota with the Red Hat Quay API Expand section "14.4. Establishing quota with the Red Hat Quay API" Collapse section "14.4. Establishing quota with the Red Hat Quay API" 14.4.1. Setting the quota 14.4.2. Viewing the quota 14.4.3. Modifying the quota 14.4.4. Pushing images Expand section "14.4.4. Pushing images" Collapse section "14.4.4. Pushing images" 14.4.4.1. Pushing ubuntu:18.04 14.4.4.2. Using the API to view quota usage 14.4.4.3. Pushing another image 14.4.5. Rejecting pushes using quota limits Expand section "14.4.5. Rejecting pushes using quota limits" Collapse section "14.4.5. Rejecting pushes using quota limits" 14.4.5.1. Setting reject and warning limits 14.4.5.2. Viewing reject and warning limits 14.4.5.3. Pushing an image when the reject limit is exceeded 14.4.5.4. Notifications for limits exceeded 14.5. Quota management limitations 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 15.3. Geo-replication using standalone Red Hat Quay Expand section "15.3. Geo-replication using standalone Red Hat Quay" Collapse section "15.3. Geo-replication using standalone Red Hat Quay" 15.3.1. Enable storage replication - standalone Quay 15.3.2. Run Red Hat Quay with storage preferences 15.4. Geo-replication using the Red Hat Quay Operator Expand section "15.4. Geo-replication using the Red Hat Quay Operator" Collapse section "15.4. Geo-replication using the Red Hat Quay Operator" 15.4.1. Setting up geo-replication on Openshift Expand section "15.4.1. Setting up geo-replication on Openshift" Collapse section "15.4.1. Setting up geo-replication on Openshift" 15.4.1.1. Configuration 15.4.2. Mixed storage for geo-replication 16. Backing up and restoring Red Hat Quay managed by the Red Hat Quay Operator Expand section "16. Backing up and restoring Red Hat Quay managed by the Red Hat Quay Operator" Collapse section "16. Backing up and restoring Red Hat Quay managed by the Red Hat Quay Operator" 16.1. Backing up Red Hat Quay Expand section "16.1. Backing up Red Hat Quay" Collapse section "16.1. Backing up Red Hat Quay" 16.1.1. Red Hat Quay configuration backup 16.1.2. Scale down your Red Hat Quay deployment 16.1.3. Red Hat Quay managed database backup Expand section "16.1.3. Red Hat Quay managed database backup" Collapse section "16.1.3. Red Hat Quay managed database backup" 16.1.3.1. Red Hat Quay managed object storage backup 16.1.4. Scale the Red Hat Quay deployment back up 16.2. Restoring Red Hat Quay Expand section "16.2. Restoring Red Hat Quay" Collapse section "16.2. Restoring Red Hat Quay" 16.2.1. Restoring Red Hat Quay and its configuration from a backup 16.2.2. Scale down your Red Hat Quay deployment 16.2.3. Restore your Red Hat Quay database 16.2.4. Restore your Red Hat Quay object storage data 16.2.5. Scale up your Red Hat Quay deployment 17. Migrating a standalone Quay deployment to a Red Hat Quay Operator managed deployment Expand section "17. Migrating a standalone Quay deployment to a Red Hat Quay Operator managed deployment" Collapse section "17. Migrating a standalone Quay deployment to a Red Hat Quay Operator managed 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. Backing up and restoring Red Hat Quay on a standalone deployment Expand section "18. Backing up and restoring Red Hat Quay on a standalone deployment" Collapse section "18. Backing up and restoring Red Hat Quay on a standalone deployment" 18.1. Backing up Red Hat Quay on standalone deployments 18.2. Restoring Red Hat Quay on standalone deployments 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. Performing health checks on Red Hat Quay deployments Expand section "20. Performing health checks on Red Hat Quay deployments" Collapse section "20. Performing health checks on Red Hat Quay deployments" 20.1. Red Hat Quay health check endpoints 20.2. Navigating to a Red Hat Quay health check endpoint 21. Branding a Red Hat Quay deployment on the legacy UI 22. 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 3.8Manage Red Hat QuayRed Hat OpenShift Documentation TeamLegal NoticeAbstract Manage Red Hat Quay Next