Chapter 4. Creating the QuayIntegration custom resource


The QuayIntegration custom resource connects your OpenShift Container Platform cluster to a Red Hat Quay registry and defines the configuration that the Quay Bridge Operator uses to synchronize projects, organizations, and robot accounts.

The QuayIntegration custom resource can be created by using the OpenShift Container Platform web console, or from the command-line interface.

To create the QuayIntegration custom resource from the command line, you can define the configuration in a YAML file and apply it using the oc create command.

Prerequisites

  • You have installed the Quay Bridge Operator on OpenShift Container Platform.
  • You have created a secret containing the OAuth access token in OpenShift Container Platform.
  • You have installed the OpenShift CLI (oc).

Procedure

  1. Create a quay-integration.yaml:

    $ touch quay-integration.yaml
    Copy to Clipboard Toggle word wrap
  2. Use the following configuration for a minimal deployment of the QuayIntegration custom resource:

      apiVersion: quay.redhat.com/v1
      kind: QuayIntegration
      metadata:
        name: example-quayintegration
      spec:
        clusterID: openshift
        credentialsSecret:
          namespace: openshift-operators
          name: quay-integration
        quayHostname: https://<QUAY_URL>
        insecureRegistry: false
    Copy to Clipboard Toggle word wrap

    where:

    spec.clusterID
    Specifies the unique identifier for the OpenShift Container Platform cluster. This value is required and defaults to openshift.
    spec.credentialsSecret
    Specifies the namespace and name of the secret containing the token that was previously created.
    spec.quayHostname
    Specifies the hostname of your Red Hat Quay instance.
    spec.insecureRegistry
    Specifies whether Red Hat Quay is using self signed certificates. If it is, set the property to insecureRegistry: true.

    For a list of all configuration fields, see "`QuayIntegration` configuration fields".

  3. Create the QuayIntegration custom resource by entering the following command:

    $ oc create -f quay-integration.yaml
    Copy to Clipboard Toggle word wrap

To create the QuayIntegration custom resource using the web console, you can use the Create Instance option from the Quay Bridge Operator operator details page and enter the required configuration fields.

After the QuayIntegration custom resource is created, your OpenShift Container Platform cluster is linked to your Red Hat Quay instance. Organizations within your Red Hat Quay registry should be created for the related namespace for the OpenShift Container Platform environment.

Prerequisites

  • You have installed the Quay Bridge Operator on OpenShift Container Platform.
  • You have created a secret containing the OAuth access token in OpenShift Container Platform.
  • You are logged in to OpenShift Container Platform as a cluster administrator.

Procedure

  1. Open the Administrator perspective of the web console and navigate to Operators Installed Operators.
  2. Click Red Hat Quay Bridge Operator.
  3. On the Details page of the Quay Bridge Operator, click Create Instance on the Quay Integration API card.
  4. On the Create QuayIntegration page, enter the following required information in either Form view or YAML view:

    • Name: The name that will refer to the QuayIntegration custom resource object.
    • Cluster ID: The ID associated with this cluster. This value should be unique across the entire ecosystem. Defaults to openshift if left unspecified.
    • Credentials secret: Refers to the namespace and name of the secret containing the token that was previously created.
    • Quay hostname: The hostname of the Quay registry.
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red Hat
Back to top