Skip to content

Commit 3f9211e

Browse files
HeleneHelene
committed
refactor installation guide for different environments
1 parent 348ec27 commit 3f9211e

File tree

3 files changed

+86
-79
lines changed

3 files changed

+86
-79
lines changed

‎README.md

Lines changed: 2 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -12,86 +12,9 @@ Grafana Bridge is a standalone Python application. It translates the IBM Spectru
1212
</p>
1313

1414

15-
## Setup
15+
## Getting started
1616

17-
If you want run the ***IBM Spectrum Scale bridge for Grafana*** in a docker container please follow this [link](/docs/RUNNING_AS_DOCKER_CONTAINER.md)
18-
19-
### Prerequisites
20-
21-
Before installing the IBM Spectrum Scale bridge for Grafana you must install the software prerequisites. Those are:
22-
1. [Performance Monitoring tool](https://www.ibm.com/support/knowledgecenter/en/STXKQY_5.0.5/com.ibm.spectrum.scale.v5r05.doc/bl1adv_PMToverview.htm) installed and configured on your IBM Spectrum Scale device
23-
2. On the [collector node](https://www.ibm.com/support/knowledgecenter/en/STXKQY_5.0.5/com.ibm.spectrum.scale.v5r05.doc/bl1adv_configurecollector.htm) the following software need to be installed:
24-
- [Python3.6](https://www.python.org/downloads/release/python-369/)
25-
- [CherryPy](https://cherrypy.org/)
26-
27-
28-
### Dependencies
29-
This package could be used for:
30-
- IBM Spectrum Scale devices having minimum release level 5.0.5 FP2 and above
31-
- Grafana 7.1.0 and above
32-
33-
To use this tool on the **older** IBM Spectrum Scale devices please refer to the [SUPPORT_MATRIX](/docs/SUPPORT_MATRIX.md) file.
34-
35-
36-
37-
### Installation, Configuration and Usage
38-
39-
#### Step 1. Ensure that IBM Spectrum Scale meets prerequisite conditions
40-
41-
The IBM Spectrum Scale system must run 5.0.5.2 or above. Run mmlsconfig to view the current configuration data of a GPFS™ cluster).
42-
43-
The bridge works in permanent communication with the pmcollector. Therefore it is recommended to install and run this tool directly on a pmcollector node.
44-
45-
In a multi-collector environment, there is no need to run the bridge on each pmcollector node separately, provided that they are configured in federated mode. Federation basically allows collectors to connect and collaborate with their peer collectors. If the peers have been specified, any query for measurement data must be directed to any of the collectors listed in the peer definition. The chosen collector will collect and assemble a response based on all relevant data from all collectors. For more information, see [Performance Monitoring tool overview](https://www.ibm.com/support/knowledgecenter/en/STXKQY_4.2.3/com.ibm.spectrum.scale.v4r23.doc/bl1adv_PMToverview.htm) in IBM Spectrum Scale: Advanced Administration Guide.
46-
47-
48-
49-
#### Step 2. Verify Python and CherryPy
50-
51-
Ensure that Python and CherryPy have been installed on the IBM Spectrum Scale system.
52-
Check the SUPPORT_MATRIX file for the recommended version.
53-
54-
55-
56-
#### Step 3. Set up IBM Spectrum Scale Performance Monitoring Bridge
57-
58-
Clone the repository using git in your favorite directory on the collector node. Alternatively download the zip package and unpack it :
59-
60-
```shell
61-
# git clone https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana.git
62-
```
63-
64-
Start the bridge application by issuing:
65-
66-
```shell
67-
# cd source/
68-
69-
# python3 zimonGrafanaIntf.py
70-
```
71-
72-
If the bridge did establish the connection to the specified pmcollector and the initialization of the metadata was performed successfully, you should get the message "server started" at the end of line. Otherwise check the zserver.log stored in the zimonGrafanaIntf directory. Additionally, check the pmcollector service running properly by issuing:
73-
74-
```shell
75-
# systemctl status pmcollector
76-
```
77-
78-
79-
80-
#### Step 4. Install Grafana
81-
82-
Download and install [Grafana](https://grafana.com/get) according to the given instructions. Before you start Grafana for the first time, check [the configuration options](http://docs.grafana.org/installation/configuration/) for port settings. Start the Grafana server as it described on the Grafana configuration pages.
83-
84-
85-
86-
#### Step 5. Establish connection to the running bridge in Grafana
87-
88-
Define a new data source (Data Sources -> Add New)
89-
90-
![](/docs/Example_Add_DataSource.png)
91-
92-
**NOTE**: The IBM Spectrum Scale bridge listens on port 4242 for HTTP connections, and on port 8443 for HTTPS connections
93-
94-
Grafana now can talk to Spectrum Scale Performance Monitoring tool via the bridge. Follow the grafana instructions to create dashboards.
17+
* [Installation guides](/docs/INSTALLATION.md)
9518

9619

9720

‎docs/CLASSIC_SETUP.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
## Setup
2+
3+
4+
### Prerequisites
5+
6+
Before installing the IBM Spectrum Scale bridge for Grafana you must install the software prerequisites. Those are:
7+
1. [Performance Monitoring tool](https://www.ibm.com/support/knowledgecenter/en/STXKQY_5.0.5/com.ibm.spectrum.scale.v5r05.doc/bl1adv_PMToverview.htm) installed and configured on your IBM Spectrum Scale device
8+
2. On the [collector node](https://www.ibm.com/support/knowledgecenter/en/STXKQY_5.0.5/com.ibm.spectrum.scale.v5r05.doc/bl1adv_configurecollector.htm) the following software need to be installed:
9+
- [Python3.6](https://www.python.org/downloads/release/python-369/)
10+
- [CherryPy](https://cherrypy.org/)
11+
12+
13+
14+
### Dependencies
15+
This package could be used for:
16+
- IBM Spectrum Scale devices having minimum release level 5.0.5 FP2 and above
17+
- Grafana 7.1.0 and above
18+
19+
To use this tool on the **older** IBM Spectrum Scale devices please refer to the [SUPPORT_MATRIX](/docs/SUPPORT_MATRIX.md) file.
20+
21+
22+
23+
### Installation, Configuration and Usage
24+
25+
#### Step 1. Ensure that IBM Spectrum Scale meets prerequisite conditions
26+
27+
The IBM Spectrum Scale system must run 5.0.5.2 or above. Run mmlsconfig to view the current configuration data of a GPFS™ cluster).
28+
29+
The bridge works in permanent communication with the pmcollector. Therefore it is recommended to install and run this tool directly on a pmcollector node.
30+
31+
In a multi-collector environment, there is no need to run the bridge on each pmcollector node separately, provided that they are configured in federated mode. Federation basically allows collectors to connect and collaborate with their peer collectors. If the peers have been specified, any query for measurement data must be directed to any of the collectors listed in the peer definition. The chosen collector will collect and assemble a response based on all relevant data from all collectors. For more information, see [Performance Monitoring tool overview](https://www.ibm.com/support/knowledgecenter/en/STXKQY_4.2.3/com.ibm.spectrum.scale.v4r23.doc/bl1adv_PMToverview.htm) in IBM Spectrum Scale: Advanced Administration Guide.
32+
33+
34+
35+
#### Step 2. Verify Python and CherryPy
36+
37+
Ensure that Python and CherryPy have been installed on the IBM Spectrum Scale system.
38+
Check the SUPPORT_MATRIX file for the recommended version.
39+
40+
41+
42+
#### Step 3. Set up IBM Spectrum Scale Performance Monitoring Bridge
43+
44+
Clone the repository using git in your favorite directory on the collector node. Alternatively download the zip package and unpack it :
45+
46+
```shell
47+
# git clone https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana.git
48+
```
49+
50+
Start the bridge application by issuing:
51+
52+
```shell
53+
# cd source/
54+
55+
# python3 zimonGrafanaIntf.py
56+
```
57+
58+
If the bridge did establish the connection to the specified pmcollector and the initialization of the metadata was performed successfully, you should get the message "server started" at the end of line. Otherwise check the zserver.log stored in the zimonGrafanaIntf directory. Additionally, check the pmcollector service running properly by issuing:
59+
60+
```shell
61+
# systemctl status pmcollector
62+
```
63+
64+
65+
66+
#### Step 4. Install Grafana
67+
68+
Download and install [Grafana](https://grafana.com/get) according to the given instructions. Before you start Grafana for the first time, check [the configuration options](http://docs.grafana.org/installation/configuration/) for port settings. Start the Grafana server as it described on the Grafana configuration pages.
69+
70+
71+
72+
#### Step 5. Establish connection to the running bridge in Grafana
73+
74+
Define a new data source (Data Sources -> Add New)
75+
76+
![](/docs/Example_Add_DataSource.png)
77+
78+
**NOTE**: The IBM Spectrum Scale bridge listens on port 4242 for HTTP connections, and on port 8443 for HTTPS connections
79+
80+
Grafana now can talk to Spectrum Scale Performance Monitoring tool via the bridge. Follow the grafana instructions to create dashboards.

‎docs/INSTALLATION.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Installing the IBM Spectrum Scale bridge for Grafana
2+
3+
* [setup on a classic IBM Spectrum Scale cluster](/docs/CLASSIC_SETUP.md)
4+
* [run in a docker container](/docs/RUNNING_AS_DOCKER_CONTAINER.md)

0 commit comments

Comments
 (0)