Deploy Red Hat Quay on OpenShift with the Quay Operator
Preface
1. Introduction to the Red Hat Quay Operator
Expand section "1. Introduction to the Red Hat Quay Operator" Collapse section "1. Introduction to the Red Hat Quay Operator"
1. 1.1. QuayRegistry API
2. 1.2. Quay Operator components
3. 1.3. Using managed components
4. 1.4. Using unmanaged components for dependencies
5. 1.5. Config bundle secret
6. 1.6. Prerequisites for Red Hat Quay on OpenShift
  Expand section "1.6. Prerequisites for Red Hat Quay on OpenShift" Collapse section "1.6. Prerequisites for Red Hat Quay on OpenShift"
2. Installing the Quay Operator from OperatorHub
3. Configuring Quay before deployment
Expand section "3. Configuring Quay before deployment" Collapse section "3. Configuring Quay before deployment"
1. 3.1. Pre-configuring Quay for automation
  Expand section "3.1. Pre-configuring Quay for automation" Collapse section "3.1. Pre-configuring Quay for automation"
2. 3.2. Configuring object storage
  Expand section "3.2. Configuring object storage" Collapse section "3.2. Configuring object storage"
  1. 3.2.1. Unmanaged storage
    
    Expand section "3.2.1. Unmanaged storage" Collapse section "3.2.1. Unmanaged storage"
    
    3.2.1.1. AWS S3 storage
    
    3.2.1.2. Google Cloud storage
    
    3.2.1.3. Azure storage
    
    3.2.1.4. Ceph / RadosGW Storage / Hitachi HCP storage
    
    3.2.1.5. Swift storage
    
    3.2.1.6. NooBaa unmanaged storage
  2. 3.2.2. Managed storage
    
    Expand section "3.2.2. Managed storage" Collapse section "3.2.2. Managed storage"
    
    3.2.2.1. About The Standalone Object Gateway
    
    Expand section "3.2.2.1. About The Standalone Object Gateway" Collapse section "3.2.2.1. About The Standalone Object Gateway"
    
    3.2.2.1.1. Create A Standalone Object Gateway
3. 3.3. Configuring the database
  Expand section "3.3. Configuring the database" Collapse section "3.3. Configuring the database"
  1. 3.3.1. Using an existing Postgres database
  2. 3.3.2. Database configuration
    
    Expand section "3.3.2. Database configuration" Collapse section "3.3.2. Database configuration"
    
    3.3.2.1. Database URI
    
    3.3.2.2. Database connection arguments
    
    Expand section "3.3.2.2. Database connection arguments" Collapse section "3.3.2.2. Database connection arguments"
    
    3.3.2.2.1. PostgreSQL SSL connection arguments
    
    3.3.2.2.2. MySQL SSL connection arguments
  3. 3.3.3. Using the managed PostgreSQL
4. 3.4. Configuring TLS and routes
  Expand section "3.4. Configuring TLS and routes" Collapse section "3.4. Configuring TLS and routes"
  1. 3.4.1. Creating the config bundle secret with TLS cert, key pair:
5. 3.5. Configuring other components
  Expand section "3.5. Configuring other components" Collapse section "3.5. Configuring other components"
  1. 3.5.1. Using external Redis
    
    Expand section "3.5.1. Using external Redis" Collapse section "3.5.1. Using external Redis"
    
    3.5.1.1. Redis configuration fields
    
    Expand section "3.5.1.1. Redis configuration fields" Collapse section "3.5.1.1. Redis configuration fields"
    
    3.5.1.1.1. Build logs
    
    3.5.1.1.2. User events
    
    3.5.1.1.3. Example redis configuration
  2. 3.5.2. Disabling the Horizontal Pod Autoscaler
  3. 3.5.3. Disabling Route Component
  4. 3.5.4. Unmanaged monitoring
  5. 3.5.5. Unmanaged mirroring
4. Deploying Quay using the Quay Operator
Expand section "4. Deploying Quay using the Quay Operator" Collapse section "4. Deploying Quay using the Quay Operator"
1. 4.1. Deploying Red Hat Quay from the command line
  Expand section "4.1. Deploying Red Hat Quay from the command line" Collapse section "4.1. Deploying Red Hat Quay from the command line"
  1. 4.1.1. Viewing created components using the command line
  2. 4.1.2. Horizontal Pod Autoscaling (HPA)
  3. 4.1.3. Using the API to create the first user
    
    Expand section "4.1.3. Using the API to create the first user" Collapse section "4.1.3. Using the API to create the first user"
    
    4.1.3.1. Invoking the API
    
    4.1.3.2. Using the OAuth token
    
    Expand section "4.1.3.2. Using the OAuth token" Collapse section "4.1.3.2. Using the OAuth token"
    
    4.1.3.2.1. Create organization
    
    4.1.3.2.2. Get organization details
  4. 4.1.4. Monitoring and debugging the deployment process
2. 4.2. Deploying Red Hat Quay from the OpenShift console
  Expand section "4.2. Deploying Red Hat Quay from the OpenShift console" Collapse section "4.2. Deploying Red Hat Quay from the OpenShift console"
  1. 4.2.1. Using the Quay UI to create the first user
5. Configuring Quay on OpenShift
Expand section "5. Configuring Quay on OpenShift" Collapse section "5. Configuring Quay on OpenShift"
1. 5.1. Editing the config bundle secret in the OpenShift console
2. 5.2. Determining QuayRegistry endpoints and secrets
3. 5.3. Downloading the existing configuration
4. 5.4. Using the config bundle to configure custom SSL certs
  Expand section "5.4. Using the config bundle to configure custom SSL certs" Collapse section "5.4. Using the config bundle to configure custom SSL certs"
  1. 5.4.1. Set TLS to unmanaged
  2. 5.4.2. Add certs to config bundle
6. Using the config tool to reconfigure Quay on OpenShift
Expand section "6. Using the config tool to reconfigure Quay on OpenShift" Collapse section "6. Using the config tool to reconfigure Quay on OpenShift"
1. 6.1. Accessing the config editor
  Expand section "6.1. Accessing the config editor" Collapse section "6.1. Accessing the config editor"
2. 6.2. Monitoring reconfiguration in the UI
  Expand section "6.2. Monitoring reconfiguration in the UI" Collapse section "6.2. Monitoring reconfiguration in the UI"
  1. 6.2.1. QuayRegistry resource
  2. 6.2.2. Events
3. 6.3. Accessing updated information after reconfiguration
  Expand section "6.3. Accessing updated information after reconfiguration" Collapse section "6.3. Accessing updated information after reconfiguration"
  1. 6.3.1. Accessing the updated config tool credentials in the UI
  2. 6.3.2. Accessing the updated config.yaml in the UI
4. 6.4. Custom SSL certificates UI
5. 6.5. External Access to the Registry
7. Quay Operator features
Expand section "7. Quay Operator features" Collapse section "7. Quay Operator features"
1. 7.1. Console monitoring and alerting
  Expand section "7.1. Console monitoring and alerting" Collapse section "7.1. Console monitoring and alerting"
2. 7.2. Manually updating the vulnerability databases for Clair in an air-gapped OpenShift cluster
  Expand section "7.2. Manually updating the vulnerability databases for Clair in an air-gapped OpenShift cluster" Collapse section "7.2. Manually updating the vulnerability databases for Clair in an air-gapped OpenShift cluster"
  1. 7.2.1. Obtaining clairctl
  2. 7.2.2. Retrieving the Clair config
    
    Expand section "7.2.2. Retrieving the Clair config" Collapse section "7.2.2. Retrieving the Clair config"
    
    7.2.2.1. Clair on OpenShift config
    
    7.2.2.2. Standalone Clair config
  3. 7.2.3. Exporting the updaters bundle
  4. 7.2.4. Configuring access to the Clair database in the air-gapped OpenShift cluster
  5. 7.2.5. Importing the updaters bundle into the air-gapped environment
3. 7.3. FIPS readiness and compliance
8. Advanced Concepts
Expand section "8. Advanced Concepts" Collapse section "8. Advanced Concepts"
1. 8.1. Deploying Quay on infrastructure nodes
  Expand section "8.1. Deploying Quay on infrastructure nodes" Collapse section "8.1. Deploying Quay on infrastructure nodes"
2. 8.2. Enabling monitoring when Operator is installed in a single namespace
  Expand section "8.2. Enabling monitoring when Operator is installed in a single namespace" Collapse section "8.2. Enabling monitoring when Operator is installed in a single namespace"
3. 8.3. Resizing Managed Storage
  Expand section "8.3. Resizing Managed Storage" Collapse section "8.3. Resizing Managed Storage"
  1. 8.3.1. Resize Noobaa PVC
  2. 8.3.2. Add Another Storage Pool
4. 8.4. Customizing Default Operator Images
  Expand section "8.4. Customizing Default Operator Images" Collapse section "8.4. Customizing Default Operator Images"
  1. 8.4.1. Environment Variables
  2. 8.4.2. Applying Overrides to a Running Operator
5. 8.5. AWS S3 CloudFront
  Expand section "8.5. AWS S3 CloudFront" Collapse section "8.5. AWS S3 CloudFront"
  1. 8.5.1. Advanced Clair configuration
    
    Expand section "8.5.1. Advanced Clair configuration" Collapse section "8.5.1. Advanced Clair configuration"
    
    8.5.1.1. Unmanaged Clair configuration
    
    Expand section "8.5.1.1. Unmanaged Clair configuration" Collapse section "8.5.1.1. Unmanaged Clair configuration"
    
    8.5.1.1.1. Unmanaging a Clair database
    
    8.5.1.1.2. Configuring a custom Clair database
    
    8.5.1.2. Running a custom Clair configuration with a managed database
9. Red Hat Quay build enhancements
Expand section "9. Red Hat Quay build enhancements" Collapse section "9. Red Hat Quay build enhancements"
1. 9.1. Red Hat Quay enhanced build architecture
2. 9.2. Red Hat Quay build limitations
3. 9.3. Creating a Red Hat Quay builders environment with OpenShift
  Expand section "9.3. Creating a Red Hat Quay builders environment with OpenShift" Collapse section "9.3. Creating a Red Hat Quay builders environment with OpenShift"
  1. 9.3.1. OpenShift TLS component
  2. 9.3.2. Using OpenShift Container Platform for Red Hat Quay builders
    
    Expand section "9.3.2. Using OpenShift Container Platform for Red Hat Quay builders" Collapse section "9.3.2. Using OpenShift Container Platform for Red Hat Quay builders"
    
    9.3.2.1. Preparing OpenShift Container Platform for virtual builders
    
    9.3.2.2. Manually adding SSL certificates.
    
    Expand section "9.3.2.2. Manually adding SSL certificates." Collapse section "9.3.2.2. Manually adding SSL certificates."
    
    9.3.2.2.1. Create and sign certs
    
    9.3.2.2.2. Set TLS to unmanaged
    
    9.3.2.2.3. Create temporary secrets
    
    9.3.2.2.4. Copy secret data to config.yaml
    
    9.3.2.3. Using the UI to create a build trigger
    
    9.3.2.4. Modifying your AWS S3 storage bucket
10. Geo-replication
Expand section "10. Geo-replication" Collapse section "10. Geo-replication"
1. 10.1. Geo-replication features
2. 10.2. Geo-replication requirements and constraints
3. 10.3. Geo-replication using the Red Hat Quay Operator
  Expand section "10.3. Geo-replication using the Red Hat Quay Operator" Collapse section "10.3. Geo-replication using the Red Hat Quay Operator"
  1. 10.3.1. Setting up geo-replication on Openshift
    
    Expand section "10.3.1. Setting up geo-replication on Openshift" Collapse section "10.3.1. Setting up geo-replication on Openshift"
    
    10.3.1.1. Configuration
  2. 10.3.2. Mixed storage for geo-replication
11. Upgrading the Quay Operator Overview
Expand section "11. Upgrading the Quay Operator Overview" Collapse section "11. Upgrading the Quay Operator Overview"
1. 11.1. Operator Lifecycle Manager
2. 11.2. Upgrading the Quay Operator
  Expand section "11.2. Upgrading the Quay Operator" Collapse section "11.2. Upgrading the Quay Operator"
  1. 11.2.1. Upgrading Quay
  2. 11.2.2. Notes on upgrading directly from 3.3.z or 3.4.z to 3.6
    
    Expand section "11.2.2. Notes on upgrading directly from 3.3.z or 3.4.z to 3.6" Collapse section "11.2.2. Notes on upgrading directly from 3.3.z or 3.4.z to 3.6"
    
    11.2.2.1. Upgrading with edge routing enabled
    
    11.2.2.2. Upgrading with custom TLS certificate/key pairs without Subject Alternative Names
    
    11.2.2.3. Configuring Clair v4 when upgrading from 3.3.z or 3.4.z to 3.6 using the Quay Operator
  3. 11.2.3. Swift configuration when upgrading from 3.3.z to 3.6
  4. 11.2.4. Changing the update channel for an Operator
  5. 11.2.5. Manually approving a pending Operator upgrade
3. 11.3. Upgrading a QuayRegistry
4. 11.4. Enabling features in Quay 3.7
  Expand section "11.4. Enabling features in Quay 3.7" Collapse section "11.4. Enabling features in Quay 3.7"
5. 11.5. Enabling features in Quay 3.6
  Expand section "11.5. Enabling features in Quay 3.6" Collapse section "11.5. Enabling features in Quay 3.6"
  1. 11.5.1. Console monitoring and alerting
  2. 11.5.2. OCI and Helm support
6. 11.6. Upgrading a QuayEcosystem
  Expand section "11.6. Upgrading a QuayEcosystem" Collapse section "11.6. Upgrading a QuayEcosystem"
  1. 11.6.1. Reverting QuayEcosystem Upgrade
  2. 11.6.2. Supported QuayEcosystem Configurations for Upgrades
Legal Notice

Language:
Format:

Language:
Format:

Deploy Red Hat Quay on OpenShift with the Quay Operator

Red Hat Quay 3

Deploy Red Hat Quay on OpenShift with Quay Operator

Red Hat OpenShift Documentation Team

Abstract

Deploy Red Hat Quay on an OpenShift Cluster with the Red Hat Quay Operator