Cluster Observability Operator

Procedure

1. In the OpenShift Container Platform web console, click Operators → OperatorHub.
2. Type cluster observability operator in the Filter by keyword box.
3. Click Cluster Observability Operator in the list of results.

4. Read the information about the Operator, and review the following default installation settings:

   • Update channel → development
   • Version → <most_recent_version>
   • Installation mode → All namespaces on the cluster (default)
   • Installed Namespace → openshift-operators
   • Update approval → Automatic
5. Optional: Change default installation settings to suit your requirements. For example, you can select to subscribe to a different update channel, to install an older released version of the Operator, or to require manual approval for updates to new versions of the Operator.
6. Click Install.

Procedure

1. Go to Operators → Installed Operators.
2. Locate the Cluster Observability Operator entry in the list.
3. Click for this entry and select Uninstall Operator.

Procedure

1. Create a YAML file named prometheus-coo-example-app.yaml that contains the following configuration details for a namespace, deployment, and service:

   apiVersion: v1
   kind: Namespace
   metadata:
     name: ns1-coo
   ---
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     labels:
       app: prometheus-coo-example-app
     name: prometheus-coo-example-app
     namespace: ns1-coo
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: prometheus-coo-example-app
     template:
       metadata:
         labels:
           app: prometheus-coo-example-app
       spec:
         containers:
         - image: ghcr.io/rhobs/prometheus-example-app:0.4.2
           imagePullPolicy: IfNotPresent
           name: prometheus-coo-example-app
   ---
   apiVersion: v1
   kind: Service
   metadata:
     labels:
       app: prometheus-coo-example-app
     name: prometheus-coo-example-app
     namespace: ns1-coo
   spec:
     ports:
     - port: 8080
       protocol: TCP
       targetPort: 8080
       name: web
     selector:
       app: prometheus-coo-example-app
     type: ClusterIP

2. Save the file.

3. Apply the configuration to the cluster by running the following command:

   $ oc apply -f prometheus-coo-example-app.yaml

4. Verify that the pod is running by running the following command and observing the output:

   $ oc -n ns1-coo get pod

   Example output

   NAME                                      READY     STATUS    RESTARTS   AGE
   prometheus-coo-example-app-0927545cb7-anskj   1/1       Running   0          81m

Procedure

1. Create a YAML file named example-coo-app-service-monitor.yaml that contains the following ServiceMonitor object configuration details:

   apiVersion: monitoring.rhobs/v1
   kind: ServiceMonitor
   metadata:
     labels:
       k8s-app: prometheus-coo-example-monitor
     name: prometheus-coo-example-monitor
     namespace: ns1-coo
   spec:
     endpoints:
     - interval: 30s
       port: web
       scheme: http
     selector:
       matchLabels:
         app: prometheus-coo-example-app

   This configuration defines a ServiceMonitor object that the MonitoringStack object will reference to scrape the metrics data exposed by the prometheus-coo-example-app sample service.

2. Apply the configuration to the cluster by running the following command:

   $ oc apply -f example-coo-app-service-monitor.yaml

3. Verify that the ServiceMonitor resource is created by running the following command and observing the output:

   $ oc -n ns1-coo get servicemonitors.monitoring.rhobs

   Example output

   NAME                         AGE
   prometheus-coo-example-monitor   81m

Procedure

1. Create a YAML file for the MonitoringStack object configuration. For this example, name the file example-coo-monitoring-stack.yaml.

2. Add the following MonitoringStack object configuration details:

   Example MonitoringStack object

   apiVersion: monitoring.rhobs/v1alpha1
   kind: MonitoringStack
   metadata:
     name: example-coo-monitoring-stack
     namespace: ns1-coo
   spec:
     logLevel: debug
     retention: 1d
     resourceSelector:
       matchLabels:
         k8s-app: prometheus-coo-example-monitor

3. Apply the MonitoringStack object by running the following command:

   $ oc apply -f example-coo-monitoring-stack.yaml

4. Verify that the MonitoringStack object is available by running the following command and inspecting the output:

   $ oc -n ns1-coo get monitoringstack

   Example output

   NAME                         AGE
   example-coo-monitoring-stack   81m