You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CLASSIC_SETUP.md
+31-9Lines changed: 31 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,17 @@
4
4
### Prerequisites
5
5
6
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:
7
+
1.[Performance Monitoring tool](https://www.ibm.com/docs/en/spectrum-scale/5.1.1?topic=monitoring-using-performance-tool) installed and configured on your IBM Spectrum Scale device
8
+
2.[Performance monitoring API key](https://www.ibm.com/docs/en/spectrum-scale/5.1.1?topic=tool-configuring-performance-monitoring-api-keys) generated for the IBM Spectrum Scale Performance Monitoring Bridge.
9
+
3. On the [collector node](https://www.ibm.com/docs/en/spectrum-scale/5.1.1?topic=tool-configuring-collector) the following software need to be installed:
- IBM Spectrum Scale devices having minimum release level 5.0.5 FP2 and above
17
+
- IBM Spectrum Scale devices having minimum release level 5.1.1 and above
17
18
- Grafana 7.1.0 and above
18
19
19
20
To use this tool on the **older** IBM Spectrum Scale devices please refer to the [SUPPORT_MATRIX](/docs/SUPPORT_MATRIX.md) file.
@@ -24,7 +25,7 @@ To use this tool on the **older** IBM Spectrum Scale devices please refer to the
24
25
25
26
#### Step 1. Ensure that IBM Spectrum Scale meets prerequisite conditions
26
27
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
+
The IBM Spectrum Scale system must run 5.1.1 or above. Run mmlsconfig to view the current configuration data of a GPFS™ cluster).
28
29
29
30
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
@@ -39,9 +40,28 @@ Check the SUPPORT_MATRIX file for the recommended version.
39
40
40
41
41
42
42
-
#### Step 3. Set up IBM Spectrum Scale Performance Monitoring Bridge
43
+
#### Step 3. Create Performance monitoring API key for the IBM Spectrum Scale Performance Monitoring Bridge
43
44
44
-
Clone the repository using git in your favorite directory on the collector node. Alternatively download the zip package and unpack it :
45
+
On the collector node run the following command:
46
+
47
+
```shell
48
+
# mmperfmon config add --apikey scale_grafana
49
+
```
50
+
51
+
Make a note of the displayed 32 hexadecimal digits sequence in the output, representing API key value.
52
+
53
+
```shell
54
+
{
55
+
"key": "ad270b0a-840b-494f-8513-110b6b28b479",
56
+
"comment": "user comment"
57
+
}
58
+
```
59
+
60
+
61
+
62
+
#### Step 4. Set up IBM Spectrum Scale Performance Monitoring Bridge
63
+
64
+
Clone the repository using git in your favourite directory on the collector node. Alternatively download the zip package and unpack it :
@@ -52,9 +72,11 @@ Start the bridge application by issuing:
52
72
```shell
53
73
# cd source/
54
74
55
-
# python3 zimonGrafanaIntf.py
75
+
# python3 zimonGrafanaIntf.py --apiKeyValue
56
76
```
57
77
78
+
You will be prompted by a command line interface to enter the 'password'. You can also pass the key value directly (not recommended) by the zimonGrafanaIntf.py invocation following the '--apiKeyValue' input parameter name, or alternatively, store the key value in the config.ini file. For more options configuring and invoking API key please read the [WiKi](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki/Configuring-a-performance-monitoring-API-key-for-the-IBM-Spectrum-Scale-Performance-Monitoring-Bridge) article.
79
+
58
80
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
81
60
82
```shell
@@ -63,13 +85,13 @@ If the bridge did establish the connection to the specified pmcollector and the
63
85
64
86
65
87
66
-
#### Step 4. Install Grafana
88
+
#### Step 5. Install Grafana
67
89
68
90
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
91
70
92
71
93
72
-
#### Step 5. Establish connection to the running bridge in Grafana
94
+
#### Step 6. Establish connection to the running bridge in Grafana
73
95
74
96
Define a new data source (Data Sources -> Add New)
0 commit comments