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.
4.1. Creating the QuayIntegration custom resource using the CLI Copy linkLink copied to clipboard!
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
Create a
quay-integration.yaml:touch quay-integration.yaml
$ touch quay-integration.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Use the following configuration for a minimal deployment of the
QuayIntegrationcustom resource:Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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".
Create the
QuayIntegrationcustom resource by entering the following command:oc create -f quay-integration.yaml
$ oc create -f quay-integration.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
4.2. Creating the QuayIntegration custom resource using the web console Copy linkLink copied to clipboard!
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
-
Open the Administrator perspective of the web console and navigate to Operators
Installed Operators. - Click Red Hat Quay Bridge Operator.
- On the Details page of the Quay Bridge Operator, click Create Instance on the Quay Integration API card.
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
QuayIntegrationcustom resource object. -
Cluster ID: The ID associated with this cluster. This value should be unique across the entire ecosystem. Defaults to
openshiftif 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.
-
Name: The name that will refer to the