Merge pull request #109 from Helene/v7.0.9

publish V7.0.9
IBM · Aug 20, 2023 · ad8dc2b · ad8dc2b
2 parents c1d518e + df878f6
commit ad8dc2b
Show file tree

Hide file tree

Showing 91 changed files with 8,497 additions and 79 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,9 +1,9 @@
-ARG BASE=registry.access.redhat.com/ubi8/ubi:8.7
+ARG BASE=registry.access.redhat.com/ubi9/ubi:9.2
 FROM $BASE
 
 LABEL com.ibm.name="IBM Spectrum Scale bridge for Grafana"
 LABEL com.ibm.vendor="IBM"
-LABEL com.ibm.version="7.0.8"
+LABEL com.ibm.version="7.0.9"
 LABEL com.ibm.url="https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana"
 LABEL com.ibm.description="This tool translates the IBM Spectrum Scale performance data collected internally \
 to the query requests acceptable by the Grafana integrated openTSDB plugin"
@@ -59,13 +59,18 @@ ARG DEFAULTLOGPATH='/var/log/ibm_bridge_for_grafana'
 ENV LOGPATH=$DEFAULTLOGPATH
 RUN echo "the log will use $LOGPATH"
 
-COPY ./requirements/requirements_ubi8.txt  /root/requirements_ubi8.txt
+COPY ./requirements/requirements_ubi9.txt  /root/requirements_ubi9.txt
+# COPY ./requirements/requirements_ubi.in  /root/requirements_ubi.in
 
-RUN yum install -y python36 python36-devel && \
-    /usr/bin/pip3 install --upgrade pip && \
-    /usr/bin/pip3 install -r /root/requirements_ubi8.txt && \
+RUN yum install -y python39 python3-pip
+
+# RUN /usr/bin/python3 -m pip install pip-tools && \
+#     /usr/bin/python3 -m piptools compile /root/requirements_ubi.in  --output-file /root/requirements_ubi9.txt && \
+#     echo "Compiled python packages: $(cat /root/requirements_ubi9.txt)"
+
+RUN /usr/bin/python3 -m pip install -r /root/requirements_ubi9.txt && \
     echo "Installed python version: $(/usr/bin/python3 -V)" && \
-    echo "Installed python packages: $(/usr/bin/pip3 list)"
+    echo "Installed python packages: $(/usr/bin/python3 -m pip list)"
 
 USER root
 
@@ -95,7 +100,6 @@ RUN chgrp -R $GID /opt/IBM/bridge && \
     chgrp -R $GID /opt/IBM/zimon && \
     chgrp -R $GID /var/mmfs/gen && \
     chgrp -R $GID /etc/ssl/certs && \
-    chgrp -R $GID /var/mmfs/gen && \
     chgrp -R $GID /etc/perfmon-api-keys && \
     chgrp -R $GID $TLSKEYPATH && \
     chgrp -R $GID $LOGPATH
@@ -105,7 +109,6 @@ RUN chmod -R g=u /opt/IBM/bridge && \
     chmod -R g=u /opt/IBM/zimon && \
     chmod -R g=u /var/mmfs/gen && \
     chmod -R g=u /etc/ssl/certs && \
-    chmod -R g=u /var/mmfs/gen && \
     chmod -R g=u /etc/perfmon-api-keys && \
     chmod -R g=u $TLSKEYPATH && \
     chmod -R g=u $LOGPATH

diff --git a/README.md b/README.md
@@ -2,21 +2,21 @@
 [![CircleCI](https://circleci.com/gh/IBM/ibm-spectrum-scale-bridge-for-grafana.svg?style=svg)](https://app.circleci.com/pipelines/github/IBM/ibm-spectrum-scale-bridge-for-grafana?branch=master)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5787/badge)](https://bestpractices.coreinfrastructure.org/projects/5787)
 
-The ***IBM Spectrum Scale bridge for Grafana*** could be used for exploring IBM Spectrum Scale performance data on [Grafana dashboards](https://grafana.com/grafana/).
+The ***IBM Spectrum Scale bridge for Grafana*** could be used for exploring IBM Storage Scale performance data on [Grafana dashboards](https://grafana.com/grafana/).
 
-Grafana Bridge is a standalone Python application. It translates the IBM Spectrum Scale metadata and performance data collected by the [IBM Spectrum Scale performance monitoring tool (ZiMon)](https://www.ibm.com/support/knowledgecenter/en/STXKQY_4.2.3/com.ibm.spectrum.scale.v4r23.doc/bl1adv_PMToverview.htm) to the query requests acceptable by the [Grafana integrated openTSDB plugin](https://grafana.com/docs/features/datasources/opentsdb/).
+Grafana Bridge is a standalone Python application. It translates the IBM Storage Scale metadata and performance data collected by the [IBM Storage Scale performance monitoring tool (ZiMon)](https://www.ibm.com/docs/en/storage-scale/5.1.8?topic=monitoring-using-performance-tool) to the query requests acceptable by the [Grafana integrated openTSDB plugin](https://grafana.com/docs/features/datasources/opentsdb/).
 
 
 <p align="center">
-  <img src="/docs/bridge_overview.PNG" />
+  <img src="/docs/grafana_bridge_overview.png" />
 </p>
 
 
 ## Getting started
 
 ### Installation guides:
 
-* [Setup the grafana bridge on a classic IBM Spectrum Scale cluster](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki/Setup-the-IBM-Spectrum-Scale-Performance-Monitoring-Bridge-for-classic-IBM-Spectrum-Scale-devices)
+* [Setup the grafana bridge on a classic IBM Storage Scale cluster](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki/Setup-the-IBM-Spectrum-Scale-Performance-Monitoring-Bridge-for-classic-IBM-Spectrum-Scale-devices)
 * [Run the grafana bridge in a docker container](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki/Running-the-IBM-Spectrum-Scale-Performance-Monitoring-Bridge-in-a-docker-container)
 * [Setup the grafana bridge for performance monitoring of a CNSA cluster in a k8s OCP environment](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki/Setup-Grafana-for-monitoring-a-CNSA-cluster--in-a-k8s-OCP-environment)
 

diff --git a/docs/RELEASE_NOTES.md b/docs/RELEASE_NOTES.md
@@ -1,3 +1,15 @@
+# Version 7.0.9 (08/20/2023)
+Changed the Dockerfile parent image to the registry.access.redhat.com/ubi9/ubi:9.2 \
+Added example yaml files for Deploying Grafana instance on an Openshift cluster via Grafana-operator v5. \
+Added example yaml files for Deploying grafana-bridge as Grafanadatasource on an Openshift cluster via Grafana-operator v5. \
+Added example yaml file for grafana-bridge service route allowing an external Grafana instance query data from grafana-bridge running inside an Openshift cluster\
+Added example Dashboards compatible with Grafana 9.5 \
+
+Tested with Grafana version 9.5
+Tested with RedHat community-powered Grafana operator v.5
+
+
+
 # Version 7.0.8 (12/06/2022)
 Changed the Dockerfile parent image to the registry.access.redhat.com/ubi8/ubi:8.7 \
 Made Dockerfile compatibe with OpenShift style allowing to specify user/group settings at the image build time. \

diff --git a/docs/SUPPORT_MATRIX.md b/docs/SUPPORT_MATRIX.md
@@ -1,4 +1,15 @@
 The following matrix gives a quick overview of the supported software for the IBM Spectrum Scale bridge for Grafana packages by version number:
+# Version 7.0.9 (08/20/2023)
+Classic Scale:
+ - Python 3.9
+ - CherryPy 18.8.0
+ - IBM Storage Scale system must run 5.1.7 and above
+ - Grafana 9.5.0 and above
+
+ Cloud native:
+ - IBM Storage Scale Container Native Storage Access(CNSA) devices having minReleaseLevel 5.1.7
+ - RedHat community-powered Grafana-Operator v5
+
 # Version 7.0.8 (12/06/2022)
 Classic Scale:
  - Python 3.8

diff --git a/docs/bridge_overview.PNG b/docs/bridge_overview.PNG
diff --git a/docs/grafana_bridge_overview.png b/docs/grafana_bridge_overview.png
diff --git a/...s Capacity Utilization-1596990065073.json → ...s Capacity Utilization-1596990065073.json b/...s Capacity Utilization-1596990065073.json → ...s Capacity Utilization-1596990065073.json
diff --git a/...hboard_set/GPFSWaiters-1596990141866.json → ...hboard_set/GPFSWaiters-1596990141866.json b/...hboard_set/GPFSWaiters-1596990141866.json → ...hboard_set/GPFSWaiters-1596990141866.json
diff --git a/...set/Memory_utilization-1596990182106.json → ...set/Memory_utilization-1596990182106.json b/...set/Memory_utilization-1596990182106.json → ...set/Memory_utilization-1596990182106.json
diff --git a/...set/Templating Options-1596991127355.json → ...set/Templating Options-1596991127355.json b/...set/Templating Options-1596991127355.json → ...set/Templating Options-1596991127355.json
diff --git a/...e System Capacity View-1596986743960.json → ...e System Capacity View-1596986743960.json b/...e System Capacity View-1596986743960.json → ...e System Capacity View-1596986743960.json
diff --git a/..._set/File Systems View-1653317252584.json → ..._set/File Systems View-1653317252584.json b/..._set/File Systems View-1653317252584.json → ..._set/File Systems View-1653317252584.json
diff --git a/...rds_set/Fileset Quotas-1653423900595.json → ...rds_set/Fileset Quotas-1653423900595.json b/...rds_set/Fileset Quotas-1653423900595.json → ...rds_set/Fileset Quotas-1653423900595.json
diff --git a/...t/Inodes Capacity View-1596986797679.json → ...t/Inodes Capacity View-1596986797679.json b/...t/Inodes Capacity View-1596986797679.json → ...t/Inodes Capacity View-1596986797679.json
diff --git a/...ards_set/Main Dashbord-1653317202416.json → ...ards_set/Main Dashbord-1653317202416.json b/...ards_set/Main Dashbord-1653317202416.json → ...ards_set/Main Dashbord-1653317202416.json
diff --git a/...t/NSD Server node View-1653424119574.json → ...t/NSD Server node View-1653424119574.json b/...t/NSD Server node View-1653424119574.json → ...t/NSD Server node View-1653424119574.json
diff --git a/...Dashboards_set/Network-1653317179495.json → ...Dashboards_set/Network-1653317179495.json b/...Dashboards_set/Network-1653317179495.json → ...Dashboards_set/Network-1653317179495.json
diff --git a/...set/Pool Capacity View-1596989290996.json → ...set/Pool Capacity View-1596989290996.json b/...set/Pool Capacity View-1596989290996.json → ...set/Pool Capacity View-1596989290996.json
diff --git a/...ls (NOT SUPPORTED NOW)-1596986715438.json → ...ls (NOT SUPPORTED NOW)-1596986715438.json b/...ls (NOT SUPPORTED NOW)-1596986715438.json → ...ls (NOT SUPPORTED NOW)-1596986715438.json
diff --git a/...bundle/AFM/AFM FS view-1620737087258.json → ...bundle/AFM/AFM FS view-1620737087258.json b/...bundle/AFM/AFM FS view-1620737087258.json → ...bundle/AFM/AFM FS view-1620737087258.json
diff --git a/...ndle/AFM/AFM FSET view-1620737156393.json → ...ndle/AFM/AFM FSET view-1620737156393.json b/...ndle/AFM/AFM FSET view-1620737156393.json → ...ndle/AFM/AFM FSET view-1620737156393.json
diff --git a/...me_cache cluster view)-1620736986309.json → ...me_cache cluster view)-1620736986309.json b/...me_cache cluster view)-1620736986309.json → ...me_cache cluster view)-1620736986309.json
diff --git a/...s Capacity Utilization-1596990065073.json → ...s Capacity Utilization-1596990065073.json b/...s Capacity Utilization-1596990065073.json → ...s Capacity Utilization-1596990065073.json
diff --git a/...Dashboards/GPFSWaiters-1596990141866.json → ...Dashboards/GPFSWaiters-1596990141866.json b/...Dashboards/GPFSWaiters-1596990141866.json → ...Dashboards/GPFSWaiters-1596990141866.json
diff --git a/...rds/Memory_utilization-1596990182106.json → ...rds/Memory_utilization-1596990182106.json b/...rds/Memory_utilization-1596990182106.json → ...rds/Memory_utilization-1596990182106.json
diff --git a/...rds/Templating Options-1596991127355.json → ...rds/Templating Options-1596991127355.json b/...rds/Templating Options-1596991127355.json → ...rds/Templating Options-1596991127355.json
diff --git a/... Scale infrastructure)-1596991423108.json → ... Scale infrastructure)-1596991423108.json b/... Scale infrastructure)-1596991423108.json → ... Scale infrastructure)-1596991423108.json
diff --git a/...ormation (table panel)-1596991455146.json → ...ormation (table panel)-1596991455146.json b/...ormation (table panel)-1596991455146.json → ...ormation (table panel)-1596991455146.json
diff --git a/... (all data in 1 graph)-1596991480795.json → ... (all data in 1 graph)-1596991480795.json b/... (all data in 1 graph)-1596991480795.json → ... (all data in 1 graph)-1596991480795.json
diff --git a/...ation over timeseries)-1596991518411.json → ...ation over timeseries)-1596991518411.json b/...ation over timeseries)-1596991518411.json → ...ation over timeseries)-1596991518411.json
diff --git a/...tion (disk operations)-1596991563655.json → ...tion (disk operations)-1596991563655.json b/...tion (disk operations)-1596991563655.json → ...tion (disk operations)-1596991563655.json
diff --git a/...rstanding Downsampling-1596991537621.json → ...rstanding Downsampling-1596991537621.json b/...rstanding Downsampling-1596991537621.json → ...rstanding Downsampling-1596991537621.json
diff --git a/...rds_bundle/Home/Available_Dashboards.json → ...rds_bundle/Home/Available_Dashboards.json b/...rds_bundle/Home/Available_Dashboards.json → ...rds_bundle/Home/Available_Dashboards.json
diff --git a/...rk and general metrics-1596991644321.json → ...rk and general metrics-1596991644321.json b/...rk and general metrics-1596991644321.json → ...rk and general metrics-1596991644321.json
diff --git a/...e System Capacity View-1596986743960.json → ...e System Capacity View-1596986743960.json b/...e System Capacity View-1596986743960.json → ...e System Capacity View-1596986743960.json
diff --git a/...ards/File Systems View-1653317252584.json → ...ards/File Systems View-1653317252584.json b/...ards/File Systems View-1653317252584.json → ...ards/File Systems View-1653317252584.json
diff --git a/...hboards/Fileset Quotas-1653423900595.json → ...hboards/Fileset Quotas-1653423900595.json b/...hboards/Fileset Quotas-1653423900595.json → ...hboards/Fileset Quotas-1653423900595.json
diff --git a/...s/Inodes Capacity View-1596986797679.json → ...s/Inodes Capacity View-1596986797679.json b/...s/Inodes Capacity View-1596986797679.json → ...s/Inodes Capacity View-1596986797679.json
diff --git a/...shboards/Main Dashbord-1653317202416.json → ...shboards/Main Dashbord-1653317202416.json b/...shboards/Main Dashbord-1653317202416.json → ...shboards/Main Dashbord-1653317202416.json
diff --git a/...s/NSD Server node View-1653424119574.json → ...s/NSD Server node View-1653424119574.json b/...s/NSD Server node View-1653424119574.json → ...s/NSD Server node View-1653424119574.json
diff --git a/...sic Dashboards/Network-1653317179495.json → ...sic Dashboards/Network-1653317179495.json b/...sic Dashboards/Network-1653317179495.json → ...sic Dashboards/Network-1653317179495.json
diff --git a/...rds/Pool Capacity View-1596989290996.json → ...rds/Pool Capacity View-1596989290996.json b/...rds/Pool Capacity View-1596989290996.json → ...rds/Pool Capacity View-1596989290996.json
diff --git a/...ls (NOT SUPPORTED NOW)-1596986715438.json → ...ls (NOT SUPPORTED NOW)-1596986715438.json b/...ls (NOT SUPPORTED NOW)-1596986715438.json → ...ls (NOT SUPPORTED NOW)-1596986715438.json
diff --git a/...s_bundle/Protocols/NFS-1596991842349.json → ...s_bundle/Protocols/NFS-1596991842349.json b/...s_bundle/Protocols/NFS-1596991842349.json → ...s_bundle/Protocols/NFS-1596991842349.json
diff --git a/... (all data in 1 graph)-1596991881160.json → ... (all data in 1 graph)-1596991881160.json b/... (all data in 1 graph)-1596991881160.json → ... (all data in 1 graph)-1596991881160.json
diff --git a/...rations (compare view)-1596991914053.json → ...rations (compare view)-1596991914053.json b/...rations (compare view)-1596991914053.json → ...rations (compare view)-1596991914053.json
diff --git a/...otocols/SMB operations-1596991861002.json → ...otocols/SMB operations-1596991861002.json b/...otocols/SMB operations-1596991861002.json → ...otocols/SMB operations-1596991861002.json
diff --git a/... Scale infrastructure)-1596991691908.json → ... Scale infrastructure)-1596991691908.json b/... Scale infrastructure)-1596991691908.json → ... Scale infrastructure)-1596991691908.json
diff --git a/...s point (compare view)-1596991711626.json → ...s point (compare view)-1596991711626.json b/...s point (compare view)-1596991711626.json → ...s point (compare view)-1596991711626.json
diff --git a/.../TCT fileset transfers-1596991728586.json → .../TCT fileset transfers-1596991728586.json b/.../TCT fileset transfers-1596991728586.json → .../TCT fileset transfers-1596991728586.json
diff --git a/...transfers (fs + fsets)-1596991766394.json → ...transfers (fs + fsets)-1596991766394.json b/...transfers (fs + fsets)-1596991766394.json → ...transfers (fs + fsets)-1596991766394.json
diff --git a/... filesystems transfers-1596991747316.json → ... filesystems transfers-1596991747316.json b/... filesystems transfers-1596991747316.json → ... filesystems transfers-1596991747316.json
diff --git a/examples/grafana_dashboards/Dashboards_older_versions/README.md b/examples/grafana_dashboards/Dashboards_older_versions/README.md
@@ -0,0 +1,34 @@
+# Example dashboards
+
+Example dashboards can easily be imported in a running Grafana environment.
+Follow these [instructions](https://grafana.com/docs/grafana/latest/reference/export_import/) to import your preferred dashboard into your Grafana installation.
+The Grafana provisioning feature might be helpful, if you are going to import multiple dashboards. For more info please read [Make usage of Grafana Provisioning feature](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki/Make-usage-of-Grafana-Provisioning-feature)
+
+
+## Default Dashboards set
+
+This directory contains such dashboards that could form the basis of a performance analysis for an IBM Spectrum Scale cluster. 
+
+
+## Advanced Dashboards set
+
+This directory summarizes those dashboards that allow a deeper analysis of individual components, such as GPFSWaiters or Filesets Capacity Utilization
+
+
+## Example Dashboards bundle
+
+With the bridge version 4, the new collection of example dashboards "Example Dashbords bundle" has been added to the available for free download resources. These new dashboards could be used for managing a multi-cluster environment. Also the "Default Dashboards set" and  "Advanced Dashboards set"  have been merged into this download package.
+
+The package content consists of several folders:
+
+- Predefined Basic Dashboards - including all dashboard examples from "Default Dashboard set" package
+- Advanced Dashboards -  including all dashboard examples from "Advanced Dashboards set" package
+- HOWTO - including dashboard examples with learning effect, f.e. Grafana's helpful features
+- NamedQueries - including dashboard examples for monitoring Linux(Network) metrics
+- Protocols - including dashboard examples for monitoring SMB and NFS metrics
+- TCT - including dashboard examples for monitoring TCT/cloud data transfers
+
+You can create the same folder structure in your running Grafana environment via provisioning folders structure from filesystem to Grafana.
+Follow [step-by-step instructions](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki/Make-usage-of-Grafana-Provisioning-feature#provision-the-example-dashboards-bundle-collection-with-folders-structure-to-grafana) available in the project Wiki.
+
+