Chapter 2. Multicluster storage health

To view the overall storage health status across all the clusters with OpenShift Data Foundation and manage its capacity, you must first enable the multicluster dashboard on the Hub cluster.

2.1. Enabling multicluster dashboard on Hub cluster

You can enable the multicluster dashboard on the install screen either before or after installing ODF Multicluster Orchestrator version 4.12 with the console plugin.

Prerequisites

  • Ensure that you have installed OpenShift Container Platform version 4.12 and have administrator privileges.
  • Ensure that you have installed Multicluster Orchestrator 4.12 operator with plugin for console enabled.
  • Ensure that you have installed Red Hat Advanced Cluster Management for Kubernetes 2.6 from Operator Hub. For instructions on how to install, see Installing RHACM.
  • Ensure you have enabled observability on RHACM. See Enabling observability guidelines.

Procedure

  1. Create the configmap file named observability-metrics-custom-allowlist.yaml and add the name of the custom metric to the metrics_list.yaml parameter.

    You can use the following YAML to list the OpenShift Data Foundation metrics on Hub cluster. For details, see Adding custom metrics. 

    kind: ConfigMap
apiVersion: v1
metadata:
  name: observability-metrics-custom-allowlist
  Namespace: open-cluster-management-observability
data:
  metrics_list.yaml: |
    names:
      - odf_system_health_status
      - odf_system_map
      - odf_system_raw_capacity_total_bytes
      - odf_system_raw_capacity_used_bytes
    matches:
      - __name__="csv_succeeded",exported_namespace="openshift-storage",name=~"odf-operator.*"

  2. Run the following command in the open-cluster-management-observability namespace: 

    # oc apply -n open-cluster-management-observability -f observability-metrics-custom-allowlist.yaml

    After observability-metrics-custom-allowlist yaml is created, RHACM will start collecting the listed OpenShift Data Foundation metrics from all the managed clusters.

    If you want to exclude specific managed clusters from collecting the observability data, add the following cluster label to your clusters: observability: disabled.

  3. To view the multicluster health, see chapter verifying multicluster storage dashboard.

2.2. Verifying multicluster storage health on hub cluster

Prerequisites

Ensure that you have enabled multicluster monitoring. For instructions, see chapter Enabling multicluster dashboard.

Procedure

  1. In the OpenShift web console of Hub cluster, ensure All Clusters is selected.
  2. Navigate to Data Services and click Storage System.
  3. On the Overview tab, verify that there are green ticks in front of OpenShift Data Foundation and Systems. This indicates that the operator is running and all storage systems are available.

  4. In the Status card,

    1. Click OpenShift Data Foundation to view the operator status.
    2. Click Systems to view the storage system status.

  5. The Storage system capacity card shows the following details:

    • Name of the storage system
    • Cluster name
    • Graphical representation of total and used capacity in percentage
    • Actual values for total and used capacity in TiB