Chapter 9. Customizing Red Hat Quay on OpenShift Container Platform

Procedure

1. On the Red Hat Quay Registry overview screen, click the link for the Config Bundle Secret.

   

2. To edit the secret, click Actions Edit Secret.

   

3. Modify the configuration and save the changes.

   

4. Monitor the deployment to ensure successful completion and that the configuration changes have taken effect.

Procedure

1. You can examine the QuayRegistry resource, using oc describe quayregistry or oc get quayregistry -o yaml, to find the current endpoints and secrets by entering the following command:

   Copy to Clipboard Toggle word wrap

   $ oc get quayregistry example-registry -n quay-enterprise -o yaml

   Example output

   Copy to Clipboard Toggle word wrap

   apiVersion: quay.redhat.com/v1
   kind: QuayRegistry
   metadata:
     ...
     name: example-registry
     namespace: quay-enterprise
     ...
   spec:
     components:
     - kind: quay
       managed: true
     ...
     - kind: clairpostgres
       managed: true
     configBundleSecret: init-config-bundle-secret 

   1

   
   status:
     currentVersion: 3.7.0
     lastUpdated: 2022-05-11 13:28:38.199476938 +0000 UTC
     registryEndpoint: https://example-registry-quay-quay-enterprise.apps.docs.gcp.quaydev.org 

   2

   1

   The config bundle secret, containing the config.yaml file and any SSL/TLS certificates.

   2

   The URL for your registry, for browser access to the registry UI, and for the registry API endpoint.

Procedure

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

   Copy to Clipboard Toggle word wrap

   $ oc describe quayregistry -n <quay_namespace>

   Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap

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

   Example output

   Copy to Clipboard Toggle word wrap

   {
       "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:

   Copy to Clipboard Toggle word wrap

   $ 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.

   Copy to Clipboard Toggle word wrap

   $ touch <new_configBundleSecret_name>.yaml

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

   Copy to Clipboard Toggle word wrap

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

   1

   
     --dry-run=client -o yaml > <new_configBundleSecret_name>.yaml

   1

   Where <config.yaml> is your base64 decoded config.yaml file.

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

   Copy to Clipboard Toggle word wrap

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

   Example output

   Copy to Clipboard Toggle word wrap

   secret/config-bundle created

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

   Copy to Clipboard Toggle word wrap

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

   Example output

   Copy to Clipboard Toggle word wrap

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

Verification

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

   Copy to Clipboard Toggle word wrap

   $ oc describe quayregistry -n <quay_namespace>

   Copy to Clipboard Toggle word wrap

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

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