Chapter 8. Advanced configuration

Procedure

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

6. Set the postgres field of the QuayRegistry CR to managed: false. For example:

       - kind: postgres
         managed: false

7. Click Save.
8. Click Details the name of your Config Bundle Secret resource.
9. On the Secret Details page, click Actions Edit Secret.

10. Add the DB_URI field to your config.yaml file. For example:

    DB_URI: postgresql://test-quay-database:postgres@test-quay-database:5432/test-quay-database

11. Optional: Add additional database configuration fields, such as DB_CONNECTION_ARGS or SSL/TLS connection arguments. For more information, see Database connection arguments.
12. Click Save.

Procedure

1. In the OpenShift Container Platform web console, navigate to Operators Installed Operators.
2. Click Red Hat Quay.
3. Click QuayRegistry.
4. Click the name of your Red Hat Quay registry, for example, example-registry.
5. Click YAML.

6. Set the redis component to unmanaged by adding the following entry under spec.components:

       - kind: redis
         managed: false

7. Click Save.
8. Click Details the name of your Config Bundle Secret resource.
9. On the Secret details page, click Actions Edit Secret.

10. In the config.yaml section, add entries for your external Redis instance. For example:

    BUILDLOGS_REDIS:
      host: redis.example.com
      port: 6379
      ssl: false
    
    USER_EVENTS_REDIS:
      host: redis.example.com
      port: 6379
      ssl: false

    Important

    If both the BUILDLOGS_REDIS and USER_EVENTS_REDIS fields reference the same Redis deployment, ensure that your Redis service can handle the combined connection load. For large or high-throughput registries, use separate Redis databases or clusters for these components.

11. Optional: Add additional database configuration fields, such as DB_CONNECTION_ARGS or SSL/TLS connection arguments. For more information, see Redis configuration fields.
12. Click Save.

Procedure

1. Edit your QuayRegistry CR:

   $ oc edit quayregistry <quay_registry_name> -n <quay_namespace>

   apiVersion: quay.redhat.com/v1
   kind: QuayRegistry
   metadata:
     name: quay-registry
     namespace: quay-enterprise
   spec:
     components:
       - kind: horizontalpodautoscaler
         managed: false
       - kind: quay
         managed: true
         overrides:
           replicas: null
       - kind: clair
         managed: true
         overrides:
           replicas: null
       - kind: mirror
         managed: true
         overrides:
           replicas: null
   # ...

2. Create a custom HorizontalPodAutoscaler resource with your desired configuration, for example:

   kind: HorizontalPodAutoscaler
   apiVersion: autoscaling/v2
   metadata:
     name: quay-registry-quay-app
     namespace: quay-enterprise
   spec:
     scaleTargetRef:
       kind: Deployment
       name: quay-registry-quay-app
       apiVersion: apps/v1
     minReplicas: 3
     maxReplicas: 20
     metrics:
       - type: Resource
         resource:
           name: memory
           target:
             type: Utilization
             averageUtilization: 90
       - type: Resource
         resource:
           name: cpu
           target:
             type: Utilization
             averageUtilization: 90

3. Apply the new HPA configuration to your cluster:

   $ oc apply -f <custom_hpa>.yaml

   horizontalpodautoscaler.autoscaling/quay-registry-quay-app created

Verification

1. Verify that your Red Hat Quay application pods are running:

   $ oc get pod | grep quay-app

   quay-registry-quay-app-5b8fd49d6b-7wvbk         1/1     Running     0          34m
   quay-registry-quay-app-5b8fd49d6b-jslq9         1/1     Running     0          3m42s
   quay-registry-quay-app-5b8fd49d6b-pskpz         1/1     Running     0          43m

2. Verify that your custom HPA is active:

   $ oc get hpa

   NAME                     REFERENCE                           TARGETS            MINPODS   MAXPODS   REPLICAS   AGE
   quay-registry-quay-app   Deployment/quay-registry-quay-app   67%/90%, 54%/90%   3         20        3          51m

Procedure

1. In your quayregistry.yaml file, set the route component as managed: false:

   apiVersion: quay.redhat.com/v1
   kind: QuayRegistry
   metadata:
     name: example-registry
     namespace: quay-enterprise
   spec:
     components:
       - kind: route
         managed: false

2. In your config.yaml file, configure Red Hat Quay to handle SSL/TLS. For example:

   # ...
   EXTERNAL_TLS_TERMINATION: false
   SERVER_HOSTNAME: example-registry-quay-quay-enterprise.apps.user1.example.com
   PREFERRED_URL_SCHEME: https
   # ...

   If the configuration is incomplete, the following error might appear:

   {
     "reason":"ConfigInvalid",
     "message":"required component `route` marked as unmanaged, but `configBundleSecret` is missing necessary fields"
   }

Procedure

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

5. In the spec.components field, you can override the resources of all components by setting values for the .overrides.resources.limits and the overrides.resources.requests fields. You can also specify a storageClassName for postgres and clairpostgres resources, however, these fields must be defined during initial installation of the component.. For example:

   spec:
     components:
       - kind: clair
         managed: true
         overrides:
           resources:
             limits:
               cpu: "5"     # Limiting to 5 CPU (equivalent to 5000m or 5000 millicpu)
               memory: "18Gi"  # Limiting to 18 Gibibytes of memory
             requests:
               cpu: "4"     # Requesting 4 CPU
               memory: "4Gi"   # Requesting 4 Gibibytes of memory
       - kind: postgres
         managed: true
         overrides:
           storageClassName: "local-path"
           resources:
             limits: {}
             requests:
               cpu: "700m"   # Requesting 700 millicpu or 0.7 CPU
               memory: "4Gi"   # Requesting 4 Gibibytes of memory
       - kind: mirror
         managed: true
         overrides:
           resources:
             limits:
             requests:
               cpu: "800m"   # Requesting 800 millicpu or 0.8 CPU
               memory: "1Gi"   # Requesting 1 Gibibyte of memory
       - kind: quay
         managed: true
         overrides:
           resources:
             limits:
               cpu: "4"    # Limiting to 4 CPU
               memory: "10Gi"   # Limiting to 10 Gibibytes of memory
             requests:
               cpu: "4"   # Requesting 4 CPU
               memory: "10Gi"   # Requesting 10 Gibi of memory
       - kind: clairpostgres
         managed: true
         overrides:
           storageClassName: "local-path"
           resources:
             limits:
               cpu: "800m"   # Limiting to 800 millicpu or 0.8 CPU
               memory: "3Gi"   # Limiting to 3 Gibibytes of memory
             requests: {}

   • limits: Setting the limits or requests fields to {} uses the default values for these resources.
   • limits: Leaving the limits or requests field empty puts no limitations on these resources.

Procedure

1. Edit the QuayRegistry CR by entering the following command:

   $ oc edit quayregistry <registry_name> -n <namespace>

2. Make any desired changes. For example:

       - kind: quay
         managed: true
         overrides:
           resources:
             limits: {}
             requests:
               cpu: "0.7"   # Requesting 0.7 CPU (equivalent to 500m or 500 millicpu)
               memory: "512Mi"   # Requesting 512 Mebibytes of memory

3. Save the changes.