Skip to main content
Version: 3.1

Configure the OpenShift monitoring solution

This article provides instructions for configuring monitoring for Portworx deployments on OpenShift. With the OpenShift versions 4.12 or newer, Portworx uses OpenShift’s Prometheus deployment for monitoring, rather than deploying its own. Perform the steps below to integrate the following with OpenShift’s Prometheus deployment:

  • Portworx
  • Grafana

Prerequisites

  • Portworx Operator version 23.10.3 or newer.

Fetch the Thanos Querier route host

Fetch the Thanos route host, which is part of the OpenShift monitoring stack:

oc get route thanos-querier -n openshift-monitoring -o json | jq -r '.spec.host'
thanos-querier-openshift-monitoring.tp-nextpx-iks-catalog-pl-80e1e1cd66534115bf44691bf8f01a6b-0000.us-south.containers.appdomain.cloud

Save this value for later, you'll use it to configure Autopilot and Grafana using the route host to enable access to Prometheus's statistics.

Configure Grafana

You can connect to Prometheus using Grafana to visualize your data. Grafana is a multi-platform open source analytics and interactive visualization web application. It provides charts, graphs, and alerts.

  1. Enter the following commands to download the Grafana dashboard and datasource configuration files:

    curl -O https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/grafana-dashboard-config.yaml
    % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
    Dload Upload Total Spent Left Speed
    100 211 100 211 0 0 596 0 --:--:-- --:--:-- --:--:-- 596
    curl -O https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/grafana-datasource-ocp.yaml
    % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
    Dload Upload Total Spent Left Speed
    100 1625 100 1625 0 0 4456 0 --:--:-- --:--:-- --:--:-- 4464
  2. Create the grafana service account:

    oc apply -f https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/grafana-service-account.yaml
  3. The grafana service account was created alongside the Grafana instance. Grant it the cluster-monitoring-view cluster role:

    oc -n kube-system adm policy add-cluster-role-to-user cluster-monitoring-view -z grafana
  4. The bearer token for this service account is used to authenticate access to OpenShift Prometheus. Create a service account token secret:

    oc -n kube-system create token grafana --duration=8760h
  5. Modify the grafana-datasource-ocp.yaml file:

    • On the url: https://<THANOS_QUERIER_HOST> line, replace <THANOS_QUERIER_HOST> with the URL you retrieved in the Fetch the Thanos Querier route host section:

    • On the httpHeaderValue1: 'Bearer <BEARER_TOKEN>' line, replace <BEARER_TOKEN> with the bearer token value you created in the step above.

  6. Create a configmap for the dashboard and data source:

    oc -n kube-system create configmap grafana-dashboard-config --from-file=grafana-dashboard-config.yaml
    oc -n kube-system create configmap grafana-source-config --from-file=grafana-datasource-ocp.yaml
  7. Download and install Grafana dashboards using the following commands:

    curl "https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/portworx-cluster-dashboard.json" -o portworx-cluster-dashboard.json && \
    curl "https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/portworx-node-dashboard.json" -o portworx-node-dashboard.json && \
    curl "https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/portworx-volume-dashboard.json" -o portworx-volume-dashboard.json && \
    curl "https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/portworx-performance-dashboard.json" -o portworx-performance-dashboard.json && \
    curl "https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/portworx-etcd-dashboard.json" -o portworx-etcd-dashboard.json
    oc -n kube-system create configmap grafana-dashboards \
    --from-file=portworx-cluster-dashboard.json \
    --from-file=portworx-performance-dashboard.json \
    --from-file=portworx-node-dashboard.json \
    --from-file=portworx-volume-dashboard.json \
    --from-file=portworx-etcd-dashboard.json
  8. Enter the following command to download and install the Grafana YAML file:

    oc apply -f https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/grafana-ocp.yaml
  9. Verify if the Grafana pod is running using the following command:

    oc -n kube-system get pods | grep -i grafana
    grafana-7d789d5cf9-bklf2                   1/1     Running   0              3m12s
  10. Access Grafana by setting up port forwarding and browsing to the specified port. In this example, port forwarding is provided for ease of access to the Grafana service from your local machine using the port 3000:

    oc -n kube-system port-forward service/grafana 3000:3000
  11. Navigate to Grafana by browsing to http://localhost:3000.

  12. Enter the default credentials to log in.

  • login: admin

  • password: admin

    Grafana Dashboard

Was this page helpful?