Installing The OpenShift Advanced Cluster Management (ACM) Observability

This turns on the observability component of ACM. The common use case is for virtualization metrics.

Steps

1. Install ACM using the Ecosystem -> Software Catalog and accept all defaults, wait until done.

   

2. Create the MultiClusterHub object. You will want to ensure the following are enabled, multicluster-engine and multicluster-observability.

   

3. Assuming OpenShift Data Foundation (ODF) is installed, create an Object Bucket Claim.

   

4. Click on the Secret.

   

5. View secret.

   

6. Scroll down and click Reveal values and copy AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY and keep in a safe place for now.

   

7. Click Buckets and get the name of the bucket, here it is named acm-observability-bucket-7a634fec-559f-4018-9d9f-ca0825575eed.

   

8. Create the following secret using the plus icon in the upper right corner of the OpenShift Web interface.

   

   apiVersion: v1
   kind: Secret
   metadata:
     name: thanos-object-storage
     namespace: open-cluster-management-observability
   type: Opaque
   stringData:
     thanos.yaml: |
       type: s3
       config:
         bucket: <your_bucketname_here, for example acm-observability-bucket-7a634fec-559f-4018-9d9f-ca0825575eed>
         endpoint: s3.openshift-storage.svc
         insecure: true
         access_key: <your_AWS_ACCESS_KEY_ID_here>
         secret_key: <your_AWS_SECRET_ACCESS_KEY_here>

9. Create the MultiClusterObservability object by clicking the plus icon again in the upper right of the OpenShift Web interface.

   

   apiVersion: observability.open-cluster-management.io/v1beta2
   kind: MultiClusterObservability
   metadata:
     name: observability
   spec:
     observabilityAddonSpec: {}
     storageConfig:
       metricObjectStorage:
         name: thanos-object-storage
         key: thanos.yaml

10. Go to Workloads -> Pods and select the open-cluster-management project. Then click the first button with a filter symbol and select Name and then type in multicluster-observability-operator and wait for that to be 1/1 in the Ready column.

    

11. Done! 🎉

Setup Custom Grafana

# make sure you have oc installed and are logged in as an admin
oc whoami

git clone https://github.com/open-cluster-management/multicluster-observability-operator.git
cd multicluster-observability-operator/tools
./setup-grafana-dev.sh --deploy
./switch-to-grafana-admin.sh $(oc whoami)

# open a browser to the URL returned from the setup-grafana.sh command

Docs

1. OpenShift ACM Docs
2. OpenShift ACM Custom Grafana Dashboards