Skip to content

Commit cf9ca8f

Browse files
committed
Improve the documentation about required 'namespace name' updates
1 parent 265d382 commit cf9ca8f

File tree

4 files changed

+12
-7
lines changed

4 files changed

+12
-7
lines changed

docs/connect_bridge_to_grafana_ocp.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ eyJhbGciOiJSUzI1NiIsImtpZCI6IlFIV0dLT1ZITlpqQ1lXc05TNUNkVjZ2MDFJVUp2SjFnR3lkR2Iz
4242

4343
Substituite ${BEARER_TOKEN} with the output of the command above in the grafana-bridge-datasource.yaml
4444
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.
45+
Replace ${namespace-name of the CNSS project} in the grafana-bridge service URL with the namespace name of your CNSS cluster project.
46+
47+
Finally modify the 'namespace: <grafana-instance namespace>' field to point to your Grafana instance project name.
4548

4649
The GrafanaDataSource deployment script for the grafana-bridge datasource will look as below:
4750

docs/grafana_deployment_ocp.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@ to build a new example application in Python. Or use kubectl to deploy a simple
4242
```
4343

4444

45-
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.
45+
2. Update the 'namespace:' field in the example_deployment_scripts/bridge_deployment/bridge-service.yaml script with the new created project name.
46+
47+
48+
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.
4649

4750
![](/docs/operator_hub.png)
4851

@@ -62,7 +65,7 @@ grafana-operator-857c86c65d-62t7m 1/1 Running 0 78s
6265
```
6366

6467

65-
3. Change to the directory example_deployment_scripts/grafana_deployment/ and apply the grafana-instance-for-cnss.yaml file
68+
4. Change to the directory example_deployment_scripts/grafana_deployment/ and apply the grafana-instance-for-cnss.yaml file
6669

6770
```
6871
[root@mycluster-inf ~]# cd /opt/example_deployment_scripts/grafana_deployment

example_deployment_scripts/grafana_deployment/grafana-bridge-datasource.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
kind: GrafanaDataSource
33
metadata:
44
name: bridge-grafanadatasource
5-
namespace: my-grafana
5+
namespace: <grafana-instance namespace>
66
spec:
77
datasources:
88
- access: proxy
@@ -19,7 +19,6 @@ spec:
1919
tlsClientCert: 'TLS cert ${TLS_CERT}'
2020
tlsClientKey: 'TLS key ${TLS_KEY}'
2121
httpHeaderValue1: 'Bearer ${BEARER_TOKEN}'
22-
url: 'https://grafana-bridge.spectrum-scale-ns.svc.cluster.local:8443'
22+
url: 'https://grafana-bridge.${namespace-name of the CNSS project}.svc.cluster.local:8443'
2323
version: 1
24-
name: grafana-bridge-datasource.yaml
25-
24+
name: grafana-bridge-datasource.yaml

example_deployment_scripts/grafana_deployment/grafana-instance-for-cnss.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: integreatly.org/v1alpha1
22
kind: Grafana
33
metadata:
44
name: grafana-for-cnss
5-
namespace: my-grafana
5+
namespace: <grafana-instance namespace>
66
spec:
77
ingress:
88
enabled: true

0 commit comments

Comments
 (0)