Fix for the issue #12

This commit includes the following documentation improvements:
-use the official name of the spectrum scale container native product
-add documentation about imagePullSecrets settings
-add documentation about the OpenTSDB used version settings

Author: Helene

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/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,7 +42,7 @@ 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 CNSS project} in the grafana-bridge service URL with the namespace name of your CNSS cluster project.
+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.
 

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/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

docs/grafana_ui_datasource_editor.png

@@ -78,8 +78,14 @@ spec:
       - name: init-scale-perf-query-service
         image: busybox:1.28
         command: ['sh', '-c', "until nslookup ibm-spectrum-scale-perf-query.$(cat /var/run/secrets/kubernetes.io/serviceaccount/namespace).svc.cluster.local; do echo waiting for ibm-spectrum-scale-perf-query service; sleep 2; done"]
-      imagePullSecrets:
-        - name: spectrumscale-registrykey
+      #######################################################################################################################
+      #
+      # 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
+      #
+      #######################################################################################################################
+      #imagePullSecrets:
+      #  - name: spectrumscale-registrykey
       volumes:
         - name: logfiles
           emptyDir: {}

example_deployment_scripts/bridge_deployment/bridge-deployment.yaml

@@ -3,7 +3,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: grafana-bridge
-  namespace: <namespace-name of the CNSS project>
+  namespace: <namespace-name of the CNSA project>
   labels:
     app: grafana-bridge
 spec:

example_deployment_scripts/bridge_deployment/bridge-service.yaml

@@ -19,6 +19,6 @@ spec:
         tlsClientCert: 'TLS cert ${TLS_CERT}'
         tlsClientKey: 'TLS key ${TLS_KEY}'
         httpHeaderValue1: 'Bearer ${BEARER_TOKEN}'
-      url: 'https://grafana-bridge.${namespace-name of the CNSS project}.svc.cluster.local:8443'
+      url: 'https://grafana-bridge.${namespace-name of the CNSA project}.svc.cluster.local:8443'
       version: 1
   name: grafana-bridge-datasource.yaml