Chapter 1. Getting started with Red Hat Quay configuration
Red Hat Quay is a secure artifact registry that can be deployed as a self-managed installation, or through the Red Hat Quay on OpenShift Container Platform Operator. Each deployment type offers a different approach to configuration and management, but each rely on the same set of configuration parameters to control registry behavior. Common configuration parameters allow administrators to define how their registry interacts with users, storage backends, authentication providers, security policies, and other integrated services.
There are one of two ways to configure Red Hat Quay that depend on your deployment type:
-
On prem Red Hat Quay: With an on prem Red Hat Quay deployment, a registry administrator provides a
config.yaml
file that includes all required parameters. For this deployment type, the registry is unable to start without a valid configuration. -
Red Hat Quay Operator: By default, the Red Hat Quay Operator automatically configures your Red Hat Quay deployment by generating the minimal required values and deploying the necessary components for you. After the initial deployment, you can customize your registry’s behavior by modifying the
QuayRegistry
custom resource, or by using the OpenShift Container Platform Web Console.
This guide offers an overview of the following configuration concepts:
- How to retrieve, inspect, and modify your current configuration for both on prem and Operator-based Red Hat Quay deployment types.
- The minimal configuration fields required for startup.
- An overview of all available Red Hat Quay configuration fields and YAML examples for those fields.