Chapter 5. Red Hat Quay on OpenShift Container Platform configuration overview

Procedure

1. On the OpenShift Container Platform web console, click Operators Installed Operators Red Hat Quay.
2. Click Quay Registry.
3. Click the name of your Red Hat Quay registry, for example, example-registry.
4. On the QuayRegistry details page, click the name of your Config Bundle Secret, for example, example-registry-config-bundle.
5. Click Actions Edit Secret.

6. In the Value box, add the desired key/value pair. For example, to add a superuser to your Red Hat Quay on OpenShift Container Platform deployment, add the following reference:

   SUPER_USERS:
   - quayadmin

7. Click Save.

   Note

   You must base64 encode any updated config.yaml file before placing it in the Secret. Ensure the Secret name matches the value specified in spec.configBundleSecret resource. Once the Secret is updated, the Operator detects the change and automatically rolls out updates to the Red Hat Quay pods.

   For detailed steps, see "Updating configuration secrets through the Red Hat Quay UI."

Verification

1. Verify that the changes have been accepted:

   1. On the OpenShift Container Platform web console, click Operators Installed Operators Red Hat Quay.
   2. Click Quay Registry.
   3. Click the name of your Red Hat Quay registry, for example, example-registry.

   4. Click Events. If successful, the following message is displayed:

      All objects created/updated successfully

Procedure

1. Describe the QuayRegistry resource by entering the following command:

   $ oc describe quayregistry -n <quay_namespace>

   # ...
     Config Bundle Secret: example-registry-config-bundle-v123x
   # ...

2. Obtain the secret data by entering the following command:

   $ oc get secret -n <quay_namespace> <example-registry-config-bundle-v123x> -o jsonpath='{.data}'

   {
       "config.yaml": "RkVBVFVSRV9VU0 ... MDAwMAo="
   }

3. Decode the data into a YAML file into the current directory by passing in the >> config.yaml flag. For example:

   $ echo 'RkVBVFVSRV9VU0 ... MDAwMAo=' | base64 --decode >> config.yaml

4. Make the desired changes to your config.yaml file, and then save the file as config.yaml.

5. Create a new configBundleSecret YAML by entering the following command.

   $ touch <new_configBundleSecret_name>.yaml

6. Create the new configBundleSecret resource, passing in the config.yaml file` by entering the following command:

   $ oc -n <namespace> create secret generic <secret_name> \
     --from-file=config.yaml=</path/to/config.yaml> \
     --dry-run=client -o yaml > <new_configBundleSecret_name>.yaml

   where:

   </path/to/config.yaml>

   Specifies your base64 decoded config.yaml file.

7. Create the configBundleSecret resource by entering the following command:

   $ oc create -n <namespace> -f <new_configBundleSecret_name>.yaml

   secret/config-bundle created

8. Update the QuayRegistry YAML file to reference the new configBundleSecret object by entering the following command:

   $ oc patch quayregistry <registry_name> -n <namespace> --type=merge -p '{"spec":{"configBundleSecret":"<new_configBundleSecret_name>"}}'

   quayregistry.quay.redhat.com/example-registry patched

Verification

1. Verify that the QuayRegistry CR has been updated with the new configBundleSecret:

   $ oc describe quayregistry -n <quay_namespace>

   # ...
     Config Bundle Secret: <new_configBundleSecret_name>
   # ...

   After patching the registry, the Red Hat Quay Operator automatically reconciles the changes.