Initial guide on Quay operator usage

adam.marton 2025-11-11 10:45:31 +00:00
parent 6ab70d5873
commit e43d214142

@ -1 +1,70 @@
[This feature is work in progress]
# Deploying Quay Instances on OpenShift
## Table of Contents
- [Overview](#overview)
- [Prerequisites](#prerequisites)
- [Creating a Quay Registry Instance](#creating-a-quay-registry-instance)
- [Advanced Installation](#advanced-installation)
- [References](#references)
## Overview
The [Quay Operator](https://docs.redhat.com/en/documentation/red_hat_quay/3.15/html/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index) is preinstalled and managed centrally on our OpenShift cluster.
It enables you to deploy your own Red Hat Quay container registry instances in a self-service way.
You can create and manage isolated Quay instances (with their own Redis, Postgres, and storage) directly in your namespace by defining a `QuayRegistry` custom resource.
Each Quay instance is fully isolated and runs under your project.
## Prerequisites
Before creating a Quay instance, ensure you have:
- Access to a dedicated OpenShift project/namespace
- Familiarity with basic `oc` or `kubectl` commands
- The Quay Operator is already installed and managed cluster-wide (no need to install it yourself)
## Creating a Quay Registry Instance
For a basic installation, create a `QuayRegistry` custom resource with the following YAML manifest:
```yaml
kind: QuayRegistry
apiVersion: quay.redhat.com/v1
metadata:
name: <<[your-quay-instance-name]>>
namespace: <<[your-namespace]>>
spec:
components:
- kind: clair
managed: true
- kind: postgres
managed: true
- kind: objectstorage
managed: true
- kind: redis
managed: true
- kind: horizontalpodautoscaler
managed: true
- kind: route
managed: true
- kind: mirror
managed: true
- kind: monitoring
managed: true
- kind: tls
managed: true
- kind: quay
managed: true
- kind: clairpostgres
managed: true
```
## Advanced Installation
For advanced installations, refer to the official documentation:
[Deploying Quay Registry](https://docs.redhat.com/en/documentation/red_hat_quay/3.15/html/deploying_the_red_hat_quay_operator_on_openshift_container_platform/deploying-quay-registry)
## References
- [Quay Operator Documentation](https://docs.redhat.com/en/documentation/red_hat_quay/3.15/html/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index)