Merge branch 'master' into v6.1

Author: Helene

.circleci/config.yml

@@ -31,13 +31,10 @@ jobs:
           command: |
             . venv/bin/activate
             cd source
-            docker build -t bridge_image:gpfs505 .
+            docker build -t bridge_image:latest .
 
 
 workflows:
   main:
     jobs:
-      - build-and-test:
-          filters:
-            branches:
-              only: v6.1
+      - build-and-test

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: Helene
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - IBM Spectrum Scale system type:
+    - [ ] IBM Spectrum Scale classic cluster.
+    - [ ] IBM Spectrum Scale Container Native Storage Access (CNSA).
+    - [ ] IBM Elastic Storage Server (ESS).
+ - IBM Spectrum Scale cluster version:
+ - IBM Spectrum Scale bridge for Grafana version:
+ - Grafana version:
+ - OS Grafana is installed on:
+
+**Additional context**
+Add any other context about the problem here.

README.md

@@ -18,10 +18,10 @@ Grafana Bridge is a standalone Python application. It translates the IBM Spectru
 
 * [Setup the grafana bridge on a classic IBM Spectrum Scale cluster](/docs/CLASSIC_SETUP.md)
 * [Run the grafana bridge in a docker container](/docs/RUNNING_AS_DOCKER_CONTAINER.md)
-* [Deploying the grafana bridge for an IBM Spectrum Scale cloud native project in a k8s/OCP environment](/docs/grafana_bridge_deployment_ocp.md)
-* [Deploying a Grafana instance for the IBM Spectrum Scale cloud native project in a k8s/OCP environment](/docs/grafana_deployment_ocp.md)
+* [Deploying the grafana bridge for an IBM CNSA project in a k8s/OCP environment](/docs/grafana_bridge_deployment_ocp.md)
+* [Deploying a Grafana instance for the IBM CNSA project in a k8s/OCP environment](/docs/grafana_deployment_ocp.md)
 * [Connecting the grafana-bridge datasource to the Grafana instance in a k8s/OCP environment](/docs/connect_bridge_to_grafana_ocp.md)
-* [Explore the Grafana WEB interface for the CNSS project in a k8s/OCP environment](/docs/explore_grafana_ocp.md)
+* [Explore the Grafana WEB interface for the IBM CNSA project in a k8s/OCP environment](/docs/explore_grafana_ocp.md)
 
 
 

docs/BUILDING_DOCKER_IMAGE.md

@@ -0,0 +1,22 @@
+## Building a docker image for the IBM Spectrum Scale Performance Monitoring Bridge
+
+
+
+**IMPORTANT:** for the building an image you need a host running docker/podman on it.
+
+
+1. Clone this repository using git in your favourite directory
+
+```shell
+# git clone https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana.git grafana_bridge
+```
+
+
+2. Create the bridge container image
+
+```shell
+# cd grafana_bridge/source
+
+# podman build -t bridge_image:latest .
+```
+

docs/RUNNING_AS_DOCKER_CONTAINER.md

@@ -20,7 +20,7 @@ IMPORTANT The IBM Spectrum Scale system must run 5.0.5.2 or above.
 
 
 
-### On the host running docker/podman perform the following steps:
+### On a host running docker/podman perform the following steps:
 
 
 1. Clone this repository using git in your favourite directory

docs/SUPPORT_MATRIX.md

@@ -4,7 +4,7 @@ The following matrix gives a quick overview of the supported software for the IB
 - Python 3.6
 - CherryPy 18.0.0
 - IBM Spectrum Scale system must run 5.0.5 FP2 and above or
-- IBM Spectrum Scale cloud native (CNSS) devices having minReleaseLevel 5.1.0.1
+- IBM Spectrum Scale Container Native Storage Access(CNSA) devices having minReleaseLevel 5.1.0.1
 - Grafana 7.1.0 and above
 
 # Version 6 (11/01/2020)

docs/connect_bridge_to_grafana_ocp.md

@@ -1,4 +1,4 @@
-# Connecting the grafana-bridge datasource to the Grafana for CNSS instance
+# Connecting the grafana-bridge datasource to the Grafana for CNSA instance
 
 
 ![](/docs/bridge_connect_grafana_ocp.png)
@@ -42,6 +42,9 @@ eyJhbGciOiJSUzI1NiIsImtpZCI6IlFIV0dLT1ZITlpqQ1lXc05TNUNkVjZ2MDFJVUp2SjFnR3lkR2Iz
 
 Substituite ${BEARER_TOKEN} with the output of the command above in the grafana-bridge-datasource.yaml
 Also 'TLS cert ${TLS_CERT}', 'TLS key ${TLS_KEY}' need to be replaced with TLS key and certificate, we have generated for the grafana-bridge.
+Replace ${namespace-name of the CNSA project} in the grafana-bridge service URL with the namespace name of your CNSA cluster project.
+
+Finally modify the 'namespace: <grafana-instance namespace>' field to point to your Grafana instance project name.
 
 The GrafanaDataSource deployment script for the grafana-bridge datasource will look as below:
 

docs/explore_grafana_ocp.md

@@ -1,4 +1,4 @@
-# Explore Grafana WEB interface for CNSS project in a k8s/OCP environment
+# Explore Grafana WEB interface for CNSA project in a k8s/OCP environment
 
 
 
@@ -39,4 +39,9 @@ Click on Configuration > Data Sources in the side menu and you’ll be taken to
 ![](/docs/grafana_ui_datasource_view.png)
 
 
-Now, an editable Grafana interface appears and you can view your custom Grafana dashboards or create your own.
+In the grafana-bridge datasource settings make sure the OpenTSDB version 2.3 is selected. Finally click on 'Save & Test' button.
+
+![](/docs/grafana_ui_datasource_editor.png)
+
+
+Now you can import some predefined Grafana dashboards or create your own.

docs/grafana_bridge_deployment_ocp.md

@@ -4,14 +4,14 @@
 
 ### Dependencies
 This instructions could be used for: 
-- IBM Spectrum Scale cloud native (CNSS) devices having minimum release level 5.1.0.1 and above
+- IBM Spectrum Scale Container Native Storage Access(CNSA) devices having minimum release level 5.1.0.1 and above
 
 
-1. Follow the [instructions](/docs/RUNNING_AS_DOCKER_CONTAINER.md) and create the IBM Spectrum Scale bridge for Grafana image
+1. Follow the [instructions](/docs/BUILDING_DOCKER_IMAGE.md) and create the IBM Spectrum Scale bridge for Grafana image
 
 
-2. Make sure you have deployed the IBM Spectrum Scale cloud native (CNSS) cluster including the ibm-spectrum-scale-pmcollector pods.
-For more information about how to deploy a CNSS cluster please refer to the [IBM Spectrum Scale Knowledge Center](https://www.ibm.com/support/knowledgecenter/STXKQY_CNS_SHR/com.ibm.spectrum.scale.cns.v5r101.doc/introduction.html)
+2. Make sure you have deployed the IBM Spectrum Scale Container Native Storage Access(CNSA) cluster including the ibm-spectrum-scale-pmcollector pods.
+For more information about how to deploy a CNSA cluster please refer to the [IBM Spectrum Scale Knowledge Center](https://www.ibm.com/support/knowledgecenter/STXKQY_CNS_SHR/com.ibm.spectrum.scale.cns.v5r101.doc/introduction.html)
 
 ```
 [root@mycluster-inf ~]# oc get po -o wide
@@ -40,8 +40,11 @@ ibm-spectrum-scale-pmcollector    ClusterIP   None            <none>        9085
 
 3. Copy the content of the example_deployment_scripts directory to your favourite directory on the master node.
 Additionally perform the following modifications in the files before you start with the deployment:
-    - Open the example_deployment_scripts/bridge_deployment/bridge-service.yaml file with an editor and set the namespace name of your CNSS cluster project.
+    - Open the example_deployment_scripts/bridge_deployment/bridge-service.yaml file with an editor and set the namespace name of your CNSA cluster project.
     - Edit the example_deployment_scripts/bridge_deployment/bridge-deployment.yaml and modify the image: field to point to the bridge image location, you created before.
+    - In case you are pulling the image from a private Docker registry or repository you need to create a Secret based on existing Docker credentials and 
+      put the secret name under imagePullSecrets settings in the example_deployment_scripts/bridge_deployment/bridge-deployment.yaml
+      For more Information please refer to the Kubernetes documentation about [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/)
 
 
 4. Create the TLS certificate and the private key

docs/grafana_deployment_ocp.md

@@ -22,7 +22,7 @@
 
 
 
-## Deploying Grafana instance for the IBM Spectrum Scale cloud native (CNSS) project in a k8s/OCP environment
+## Deploying Grafana instance for the IBM Spectrum Scale Container Native Storage Access(CNSA) project in a k8s/OCP environment
 
 
 1. create a new project, for example: my-grafana
@@ -42,7 +42,10 @@ to build a new example application in Python. Or use kubectl to deploy a simple
 ```
 
 
-2. Navigate to OperatorHub and select the community-powered Grafana Operator. Press Continue to accept the disclaimer, press Install, and press Subscribe to accept the default configuration values and deploy to the my-grafana namespace.
+2. Update the 'namespace:' field in the example_deployment_scripts/grafana_deployment/grafana-instance-for-cnss.yaml script with the new created project name.
+
+
+3. Navigate to OperatorHub and select the community-powered Grafana Operator. Press Continue to accept the disclaimer, press Install, and press Subscribe to accept the default configuration values and deploy to the my-grafana namespace.
 
 ![](/docs/operator_hub.png)
 
@@ -62,7 +65,7 @@ grafana-operator-857c86c65d-62t7m   1/1     Running   0          78s
 ```
 
 
-3. Change to the directory example_deployment_scripts/grafana_deployment/ and apply the grafana-instance-for-cnss.yaml file
+4. Change to the directory example_deployment_scripts/grafana_deployment/ and apply the grafana-instance-for-cnss.yaml file
 
 ```
 [root@mycluster-inf ~]# cd /opt/example_deployment_scripts/grafana_deployment