Skip to content

Commit 1137ccd

Browse files
committed
update http(ssl) documentation
1 parent 16f35c4 commit 1137ccd

File tree

4 files changed

+12
-17
lines changed

4 files changed

+12
-17
lines changed

docs/CLASSIC_SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,6 @@ Define a new data source (Data Sources -> Add New)
7575

7676
![](/docs/Example_Add_DataSource.png)
7777

78-
**NOTE**: The IBM Spectrum Scale bridge listens on port 4242 for HTTP connections, and on port 8443 for HTTPS connections
78+
**NOTE**: The IBM Spectrum Scale bridge listens on port 4242 for HTTP connections, and on port 8443 for HTTPS(SSL) connections. Follow the instructions [Generate SSL certificates](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki/How-to-setup-HTTPS%28SSL%29-connection-for-the-IBM-Spectrum-Scale-bridge-for-Grafana#generate-ssl-certificates) to generate a private ssl key and a ssl certificate
7979

8080
Grafana now can talk to Spectrum Scale Performance Monitoring tool via the bridge. Follow the grafana instructions to create dashboards.

docs/RUNNING_AS_DOCKER_CONTAINER.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ cp grafana_bridge/source/gpfsConfig
4444
```shell
4545
# cd grafana_bridge/source
4646

47-
# podman build -t bridge_image:gpfs505 .
47+
# podman build -t bridge_image:latest .
4848
```
4949

5050

5151
4. Start the bridge running in a container:
5252

5353
```shell
54-
# podman run -dt -p 4242:4242 -e "SERVER=9.XXX.XXX.XXX" --pod new:my-pod --name grafana_bridge bridge_image:gpfs505
54+
# podman run -dt -p 4242:4242 -e "SERVER=9.XXX.XXX.XXX" --pod new:my-pod --name grafana_bridge bridge_image:latest
5555

5656
# podman logs grafana_bridge
5757

@@ -64,12 +64,12 @@ Now you can add the host running the bridge container to the Grafana monitoring
6464
### Using HTTPS(SSL) connection for the IBM Spectrum Scale Performance Monitoring Bridge running in a container
6565

6666

67-
1. Follow the instructions [How to setup HTTPS(SSL)](./SETUP_SSL_CONNECTION.md) to generate a private key and certificate for
67+
1. Follow the instructions [Generate SSL certificates](https://github.com/IBM/ibm-spectrum-scale-bridge-for-grafana/wiki/How-to-setup-HTTPS%28SSL%29-connection-for-the-IBM-Spectrum-Scale-bridge-for-Grafana#generate-ssl-certificates) to generate a private ssl key and a ssl certificate
6868

6969
2. Start the bridge running in a container:
7070

7171
```shell
72-
# podman run -dt -p 4242:4242,8443:8443 -e "SERVER=9.XXX.XXX.XXX" -e "PORT=8443" -e "KEYPATH=/opt/registry/certs" \ -v /tmp:/opt/IBM/bridge/logs -v /opt/registry/certs:/opt/registry/certs \ --pod new:my-bridge-ssl-test-pod --name bridge-ssl-test bridge_ssl_test:grafana
72+
# podman run -dt -p 4242:4242,8443:8443 -e "SERVER=9.XXX.XXX.XXX" -e "PORT=8443" -e "TLSKEYPATH=/etc/bridge_ssl/certs" -e "TLSKEYFILE=privkey.pem" -e "TLSCERTFILE=cert.pem" \ -v /tmp:/var/log/ibm_bridge_for_grafana -v /etc/bridge_ssl/certs:/etc/bridge_ssl/certs \ --pod new:my-bridge-ssl-test-pod --name bridge-ssl-test bridge_image:latest
7373

7474
# podman logs bridge-ssl-test
7575
Connection to the collector server established successfully

docs/SETUP_SSL_CONNECTION.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,18 @@ To set up SSL communication between the bridge and the Grafana complete the foll
1313
2. Generate a certificate.
1414

1515
```shell
16-
# openssl req -new -x509 -days 365 -key privkey.pem -out cert.pem
16+
# openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/bridge_ssl/certs/privkey.pem -out /etc/bridge_ssl/certs/cert.pem
1717
```
1818

1919
Openssl will then ask you a series of questions. You can enter whatever values are applicable, or leave most fields blank. The one field you must fill in is the ‘Common Name’: enter the hostname which will be used to access the bridge (where the Grafana server running).
2020

21-
Note: The file names for key and the certificate should be ‘privkey.pem’ and ‘cert.pem’.
21+
Note: The file names for the key and the certificate should be ‘privkey.pem’ and ‘cert.pem’.
2222

2323

24-
3. Install CherryPy (version 5.0 or above)from the [CherryPy](https://cherrypy.org/) download page.
25-
26-
Note: If you are using python3, please check which cherryPy version is compatible with your setup. In our lab, we have tested python version 3.4.3 with cherryPy version 8.2.0.
27-
28-
29-
4. Start the bridge listening on the socket port 8443. Don't forget to provide the location of ‘privkey.pem’ and ‘cert.pem’ (-k option), otherwise you will get the error message:
24+
3. Start the bridge listening on the socket port 8443. Don't forget to provide the location and the file name of the tls private key and the tls certificate:
3025

3126
```shell
32-
# python3 zimonGrafanaIntf.py -p 8443 -k /opt/registry/certs
27+
# python3 zimonGrafanaIntf.py -p 8443 -t /etc/bridge_ssl/certs -k privkey.pem -m cert.pem
3328
```
3429

3530

docs/grafana_bridge_deployment_ocp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,18 @@ Additionally perform the following modifications in the files before you start w
5050
4. Create the TLS certificate and the private key
5151

5252
```
53-
[root@mycluster-inf ~]# openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /tmp/privkey.pem -out /tmp/cert.pem -subj "/CN=grafana-bridge/O=grafana-bridge"
53+
[root@mycluster-inf ~]# openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/bridge_ssl/certs/privkey.pem -out /etc/bridge_ssl/certs/cert.pem -subj "/CN=grafana-bridge/O=grafana-bridge"
5454
Generating a 2048 bit RSA private key
5555
........................+++
5656
..............................................+++
57-
writing new private key to '/tmp/privkey.pem'
57+
writing new private key to '/etc/bridge_ssl/certs/privkey.pem'
5858
-----
5959
```
6060

6161
Check that the both .pem files are created in the /tmp directory
6262

6363
```
64-
[root@mycluster-inf ~]# cd /tmp
64+
[root@mycluster-inf ~]# cd /etc/bridge_ssl/certs
6565
[root@mycluster-inf tmp]# cat privkey.pem
6666
-----BEGIN PRIVATE KEY-----
6767
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDZ7v0Oq9n9zx8T

0 commit comments

Comments
 (0)