Chapter 8. Advanced Concepts

Procedure

1. Enter the following command to check whether the cluster-monitoring-config ConfigMap object exists:

   $ oc -n openshift-monitoring get configmap cluster-monitoring-config

   Copy to Clipboard Toggle word wrap

   Example output

   Error from server (NotFound): configmaps "cluster-monitoring-config" not found

   Copy to Clipboard Toggle word wrap

2. Optional: If the ConfigMap object does not exist, create a YAML manifest. In the following example, the file is called cluster-monitoring-config.yaml.

   cat <<EOF > cluster-monitoring-config.yaml
   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
   EOF

   Copy to Clipboard Toggle word wrap

3. Optional: If the ConfigMap object does not exist, create the ConfigMap object:

   $ oc apply -f cluster-monitoring-config.yaml configmap/cluster-monitoring-config created

   Copy to Clipboard Toggle word wrap

4. Ensure that the ConfigMap object exists by running the following command:

   $ oc -n openshift-monitoring get configmap cluster-monitoring-config

   Copy to Clipboard Toggle word wrap

   Example output

   NAME                        DATA   AGE
   cluster-monitoring-config   1      12s

   Copy to Clipboard Toggle word wrap

Procedure

1. Enter the following command to check whether the user-workload-monitoring-config ConfigMap object exists:

   $ oc -n openshift-user-workload-monitoring get configmap user-workload-monitoring-config

   Copy to Clipboard Toggle word wrap

   Example output

   Error from server (NotFound): configmaps "user-workload-monitoring-config" not found

   Copy to Clipboard Toggle word wrap

2. If the ConfigMap object does not exist, create a YAML manifest. In the following example, the file is called user-workload-monitoring-config.yaml.

   cat <<EOF > user-workload-monitoring-config.yaml
   
   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: user-workload-monitoring-config
     namespace: openshift-user-workload-monitoring
   data:
     config.yaml: |
   EOF

   Copy to Clipboard Toggle word wrap

3. Optional: Create the ConfigMap object by entering the following command:

   $ oc apply -f user-workload-monitoring-config.yaml

   Copy to Clipboard Toggle word wrap

   Example output

   configmap/user-workload-monitoring-config created

   Copy to Clipboard Toggle word wrap

Procedure

1. Enter the following command to check if monitoring for user-defined projects is running:

   $ oc get pods -n openshift-user-workload-monitoring

   Copy to Clipboard Toggle word wrap

   Example output

   No resources found in openshift-user-workload-monitoring namespace.

   Copy to Clipboard Toggle word wrap

2. Edit the cluster-monitoring-config ConfigMap by entering the following command:

   $ oc -n openshift-monitoring edit configmap cluster-monitoring-config

   Copy to Clipboard Toggle word wrap

3. Set enableUserWorkload: true in your config.yaml file to enable monitoring for user-defined projects on the cluster:

   apiVersion: v1
   data:
     config.yaml: |
       enableUserWorkload: true
   kind: ConfigMap
   metadata:
     annotations:

   Copy to Clipboard Toggle word wrap

4. Enter the following command to save the file, apply the changes, and ensure that the appropriate pods are running:

   $ oc get pods -n openshift-user-workload-monitoring

   Copy to Clipboard Toggle word wrap

   Example output

   NAME                                   READY   STATUS    RESTARTS   AGE
   prometheus-operator-6f96b4b8f8-gq6rl   2/2     Running   0          15s
   prometheus-user-workload-0             5/5     Running   1          12s
   prometheus-user-workload-1             5/5     Running   1          12s
   thanos-ruler-user-workload-0           3/3     Running   0          8s
   thanos-ruler-user-workload-1           3/3     Running   0          8s

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a YAML file for the Service object:

   $ cat <<EOF >  quay-service.yaml
   
   apiVersion: v1
   kind: Service
   metadata:
     annotations:
     labels:
       quay-component: monitoring
       quay-operator/quayregistry: example-registry
     name: example-registry-quay-metrics
     namespace: quay-enterprise
   spec:
     ports:
     - name: quay-metrics
       port: 9091
       protocol: TCP
       targetPort: 9091
     selector:
       quay-component: quay-app
       quay-operator/quayregistry: example-registry
     type: ClusterIP
   EOF

   Copy to Clipboard Toggle word wrap

2. Create the Service object by entering the following command:

   $  oc apply -f quay-service.yaml

   Copy to Clipboard Toggle word wrap

   Example output

   service/example-registry-quay-metrics created

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a YAML file for the ServiceMonitor resource:

   $ cat <<EOF >  quay-service-monitor.yaml
   
   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     labels:
       quay-operator/quayregistry: example-registry
     name: example-registry-quay-metrics-monitor
     namespace: quay-enterprise
   spec:
     endpoints:
     - port: quay-metrics
     namespaceSelector:
       any: true
     selector:
       matchLabels:
         quay-component: monitoring
   EOF

   Copy to Clipboard Toggle word wrap

2. Create the ServiceMonitor resource by entering the following command:

   $ oc apply -f quay-service-monitor.yaml

   Copy to Clipboard Toggle word wrap

   Example output

   servicemonitor.monitoring.coreos.com/example-registry-quay-metrics-monitor created

   Copy to Clipboard Toggle word wrap

Procedure

1. Log into the OpenShift Container Platform console and select Storage Persistent Volume Claims.
2. Select the PersistentVolumeClaim named like noobaa-default-backing-store-noobaa-pvc-*.
3. From the Action menu, select Expand PVC.
4. Enter the new size of the Persistent Volume Claim and select Expand.

Procedure

1. The ClusterServiceVersion object is OLM’s representation of a running Operator in the cluster. Find the Red Hat Quay Operator’s ClusterServiceVersion by using a Kubernetes UI or the kubectl/oc CLI tool. For example:

   $ oc get clusterserviceversions -n <your-namespace>

   Copy to Clipboard Toggle word wrap

2. Using the UI, oc edit, or another method, modify the Red Hat Quay ClusterServiceVersion to include the environment variables outlined above to point to the override images:

   JSONPath: spec.install.spec.deployments[0].spec.template.spec.containers[0].env

   - name: RELATED_IMAGE_COMPONENT_QUAY
     value: quay.io/projectquay/quay@sha256:c35f5af964431673f4ff5c9e90bdf45f19e38b8742b5903d41c10cc7f6339a6d
   - name: RELATED_IMAGE_COMPONENT_CLAIR
     value: quay.io/projectquay/clair@sha256:70c99feceb4c0973540d22e740659cd8d616775d3ad1c1698ddf71d0221f3ce6
   - name: RELATED_IMAGE_COMPONENT_POSTGRES
     value: centos/postgresql-10-centos7@sha256:de1560cb35e5ec643e7b3a772ebaac8e3a7a2a8e8271d9e91ff023539b4dfb33
   - name: RELATED_IMAGE_COMPONENT_REDIS
     value: centos/redis-32-centos7@sha256:06dbb609484330ec6be6090109f1fa16e936afcf975d1cbc5fff3e6c7cae7542

   Copy to Clipboard Toggle word wrap

Procedure

1. Submit the API key request form to obtain the Quay-specific CRDA remote matcher.

2. Set the CRDA configuration in your clair-config.yaml file:

   matchers:
     config:
       crda:
         url: https://gw.api.openshift.io/api/v2/
         key: <CRDA_API_KEY> 

   1

   
         source: <QUAY_SERVER_HOSTNAME> 

   2

   Copy to Clipboard Toggle word wrap

   1

   Insert the Quay-specific CRDA remote matcher from the API key request form here.

   2

   The hostname of your Quay server.