Merge pull request #86 from Helene/v7.0.8

publish V7.0.8

Author: Helene

.circleci/config.yml

@@ -22,10 +22,10 @@ jobs:
           name: Test
           command: |
             . venv/bin/activate
-            flake8 --max-line-length=999 --ignore=E731,E741,E712,E722 --exclude=venv* --statistics
+            flake8 --max-line-length=999 --ignore=E731,E741,E712,E722,W503 --exclude=venv* --statistics
             nose2
       - setup_remote_docker:
-          version: 19.03.13
+          version: 20.10.17
       - run:
           name: Build Docker image
           command: |

Dockerfile

@@ -1,34 +1,28 @@
-ARG BASE=registry.access.redhat.com/ubi8/ubi:8.5
+ARG BASE=registry.access.redhat.com/ubi8/ubi:8.7
 FROM $BASE
 
 LABEL com.ibm.name="IBM Spectrum Scale bridge for Grafana"
-LABEL com.ibm.vendor="IBM" 
+LABEL com.ibm.vendor="IBM"
+LABEL com.ibm.version="7.0.8"
+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"
 LABEL com.ibm.summary="It allows the IBM Spectrum Scale users to perform performance monitoring for IBM Spectrum Scale devices using Grafana"
 
-COPY ./requirements/requirements_ubi8.txt  /root/requirements_ubi8.txt
-
-RUN yum install -y python36 python36-devel
-RUN /usr/bin/pip3 install --upgrade pip
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
 
-RUN /usr/bin/pip3 install -r /root/requirements_ubi8.txt
-RUN echo "Installed python version: $(/usr/bin/python3 -V)"
-RUN echo "Installed python packages: $(/usr/bin/pip3 list)"
+ARG USERNAME=bridge
+ENV USER=$USERNAME
 
-USER root
+ARG GROUPNAME=bridge
+ENV GROUP=$GROUPNAME
 
-RUN mkdir -p /opt/IBM/bridge
-RUN mkdir -p /opt/IBM/zimon
-RUN mkdir -p /var/mmfs/gen
-RUN mkdir -p /etc/ssl/certs
-RUN mkdir -p /etc/perfmon-api-keys
+ARG USERID=2001
+ENV UID=$USERID
 
-COPY LICENSE /licenses/
-
-COPY ./source/ /opt/IBM/bridge
-COPY ./source/gpfsConfig/mmsdrfs* /var/mmfs/gen/
-COPY ./source/gpfsConfig/ZIMon* /opt/IBM/zimon/
+ARG GROUPID=0
+ENV GID=$GROUPID
 
 ARG HTTPPROTOCOL=http
 ENV PROTOCOL=$HTTPPROTOCOL
@@ -44,7 +38,6 @@ RUN echo "the PERFMONPORT port is set to $SERVERPORT"
 
 ARG CERTPATH='/etc/bridge_ssl/certs'
 ENV TLSKEYPATH=$CERTPATH
-RUN mkdir -p $CERTPATH
 
 ARG KEYFILE=None
 ENV TLSKEYFILE=$KEYFILE
@@ -57,40 +50,77 @@ ENV APIKEYNAME=$KEYNAME
 
 ARG KEYVALUE=None
 ENV APIKEYVALUE=$KEYVALUE
-RUN if [ "${APIKEYVALUE:0:1}" = "/" ]; then ln -s $APIKEYVALUE /etc/perfmon-api-keys; echo "APIKEYVALUE is a PATH"; else echo "APIKEYVALUE not a PATH"; fi
-
-RUN if [ -z "$TLSKEYPATH" ] || [ -z "$TLSCERTFILE" ] || [ -z "$TLSKEYFILE" ] && [ "$PROTOCOL" = "https" ]; then echo "TLSKEYPATH FOR SSL CONNECTION NOT SET - ERROR"; exit 1; else echo "PASS"; fi
-RUN echo "the ssl certificates path is set to $TLSKEYPATH" 
 
 ARG PMCOLLECTORIP=0.0.0.0
 ENV SERVER=$PMCOLLECTORIP
 RUN echo "the pmcollector server ip is set to $SERVER"
 
 ARG DEFAULTLOGPATH='/var/log/ibm_bridge_for_grafana'
 ENV LOGPATH=$DEFAULTLOGPATH
-RUN mkdir -p $LOGPATH
 RUN echo "the log will use $LOGPATH"
 
-# Switch to the working directory
-WORKDIR /opt/IBM/bridge
-RUN echo "$(pwd)"
+COPY ./requirements/requirements_ubi8.txt  /root/requirements_ubi8.txt
 
-# Create a user 'bridge' under 'root' group
-RUN groupadd -g 2099 bridge
-RUN useradd -rm -d /home/2001 -s /bin/bash -g 2099 -u 2001 bridge
+RUN yum install -y python36 python36-devel && \
+    /usr/bin/pip3 install --upgrade pip && \
+    /usr/bin/pip3 install -r /root/requirements_ubi8.txt && \
+    echo "Installed python version: $(/usr/bin/python3 -V)" && \
+    echo "Installed python packages: $(/usr/bin/pip3 list)"
 
-# Chown all the files to the grafanabridge 'bridge' user
-RUN chown -R 2001:2099 /opt/IBM/bridge
-RUN chown -R 2001:2099 /opt/IBM/zimon
-RUN chown -R 2001:2099 /var/mmfs/gen
-RUN chown -R 2001:2099 /etc/ssl/certs
-RUN chown -R 2001:2099 /etc/perfmon-api-keys
-RUN chown -R 2001:2099 $TLSKEYPATH
-RUN chown -R 2001:2099 $LOGPATH
+USER root
+
+RUN mkdir -p /opt/IBM/bridge /opt/IBM/zimon /var/mmfs/gen && \
+    mkdir -p /etc/ssl/certs /etc/perfmon-api-keys $CERTPATH $LOGPATH
+
+COPY LICENSE /licenses/
 
-# Switch to user 'bridge'
-USER 2001
+COPY ./source/ /opt/IBM/bridge
+COPY ./source/gpfsConfig/mmsdrfs* /var/mmfs/gen/
+COPY ./source/gpfsConfig/ZIMon* /opt/IBM/zimon/
+
+RUN if [ "${APIKEYVALUE:0:1}" = "/" ]; then ln -s $APIKEYVALUE /etc/perfmon-api-keys; echo "APIKEYVALUE is a PATH"; else echo "APIKEYVALUE not a PATH"; fi && \
+    if [ -z "$TLSKEYPATH" ] || [ -z "$TLSCERTFILE" ] || [ -z "$TLSKEYFILE" ] && [ "$PROTOCOL" = "https" ]; then echo "TLSKEYPATH FOR SSL CONNECTION NOT SET - ERROR"; exit 1; else echo "PASS"; fi
+RUN echo "the ssl certificates path is set to $TLSKEYPATH" 
+
+# Switch to the working directory
+WORKDIR /opt/IBM/bridge
+RUN echo "$(pwd)"
 
+# Create a container user 
+RUN if [ "$GID" -gt "0" ]; then groupadd -g $GID $GROUP; else echo "Since root GID specified skipping groupadd"; fi && \
+    useradd -rm -d /home/$UID -s /bin/bash -g $GID -u $UID $USER
+
+# Change group ownership
+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
+
+# Set group permissions 
+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
+
+# Chown all needed files 
+RUN chown -R $UID:$GID /opt/IBM/bridge && \
+    chown -R $UID:$GID /opt/IBM/zimon && \
+    chown -R $UID:$GID /var/mmfs/gen && \
+    chown -R $UID:$GID /etc/ssl/certs && \
+    chown -R $UID:$GID /etc/perfmon-api-keys && \
+    chown -R $UID:$GID $TLSKEYPATH && \
+    chown -R $UID:$GID $LOGPATH
+
+# Switch user
+USER $GID
 
 CMD ["sh", "-c", "python3 zimonGrafanaIntf.py -c 10 -s $SERVER -r $PROTOCOL -p $PORT -P $SERVERPORT -t $TLSKEYPATH -l $LOGPATH --tlsKeyFile $TLSKEYFILE --tlsCertFile $TLSCERTFILE --apiKeyName $APIKEYNAME --apiKeyValue $APIKEYVALUE"]
 

README.md

@@ -1,6 +1,6 @@
 
 [![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/).
 

docs/RELEASE_NOTES.md

@@ -1,3 +1,13 @@
+# 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. \
+Added Workaround for Disk Capacity sensors allowing to query and fetch data from the archived (on disk data). \
+
+Tested with Grafana version 7.5.17 and 9.0.0
+Tested with RedHat community-powered Grafana operator v.4.8
+
+
+
 # Version 7.0.7 (09/21/2022)
 Fixed issue in parsing zimon sensors config, having new filter format for Network sensor
 

docs/SUPPORT_MATRIX.md

@@ -1,4 +1,14 @@
 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.8 (12/06/2022)
+Classic Scale:
+ - Python 3.8
+ - CherryPy 18.6.1
+ - IBM Spectrum Scale system must run 5.1.5.1 and above
+ - Grafana 9.0.0 and above
+ 
+ Cloud native:
+ - IBM Spectrum Scale Container Native Storage Access(CNSA) devices having minReleaseLevel 5.1.5
+ - RedHat community-powered Grafana-Operator v4.8
 
 # Version 7.0.7 (09/21/2022)
 Classic Scale:

docs/bridge_overview.PNG

@@ -1,13 +1,22 @@
 # Example deployment of a GrafanaDataSource instance in a k8s/OCP environment
 
 
-Using the scripts in this folder you can deploy a GrafanaDataSource instance for the IBM Spectrum Scale Performance Monitoring Bridge for Grafana running in container
+Using the scripts in this folder you can deploy a GrafanaDataSource instance for the IBM Spectrum Scale Performance Monitoring Bridge for Grafana running in in the project 'grafana-for-cnsa'
 
+```
+NAMESPACE=grafana-for-cnsa
+```
+```
+echo $NAMESPACE
+```
 ```
 oc adm policy add-cluster-role-to-user ibm-spectrum-scale-operator -z grafana-serviceaccount
-oc apply -f grafana-bridge-datasource.yaml
-oc describe GrafanaDataSource bridge-grafanadatasource
-
+```
+```
+oc apply -f grafana-bridge-datasource.yaml --namespace=$NAMESPACE
+```
+```
+oc describe GrafanaDataSource bridge-grafanadatasource --namespace=$NAMESPACE
 ```
 
 For complete deployment examples please check the project [Wiki](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki)

examples/openshift_deployment_scripts/grafana_datasource_deployment/README.md

@@ -2,7 +2,6 @@
 kind: GrafanaDataSource
 metadata:
   name: bridge-grafanadatasource
-  namespace: grafana-for-cnsa
 spec:
   datasources:
     - access: proxy

examples/openshift_deployment_scripts/grafana_datasource_deployment/grafana-bridge-datasource.yaml

@@ -4,11 +4,22 @@
 Using the scripts in this folder you can deploy a Grafana instance in the project 'grafana-for-cnsa'
 
 ```
-oc new-project grafana-for-cnsa
-oc apply -f operator-group.yaml
-oc apply -f grafana-operator-subscription.yaml
-oc apply -f grafana-instance-for-cnsa.yaml
-
+NAMESPACE=grafana-for-cnsa
+```
+```
+echo $NAMESPACE
+```
+```
+oc new-project $NAMESPACE
+```
+```
+oc apply -f operator-group.yaml --namespace=$NAMESPACE
+```
+```
+oc apply -f grafana-operator-subscription.yaml --namespace=$NAMESPACE
+```
+```
+oc apply -f grafana-instance-for-cnsa.yaml --namespace=$NAMESPACE
 ```
 
 Alternatively you can install a Grafana instance using the OpenShift Container Platform web console. Please check the instructions described in the deployment examples stored in the project [Wiki](/docs/grafana_deployment_ocp.md)

examples/openshift_deployment_scripts/grafana_deployment/README.md

@@ -1,7 +1,6 @@
 apiVersion: integreatly.org/v1alpha1
 kind: Grafana
 metadata:
-  namespace: grafana-for-cnsa
   name: grafana-for-cnsa
 spec:
   config: