Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention cloud dashboard and enhanced deployment instructions #198

Merged
merged 13 commits into from
Jun 8, 2021
Merged
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ grafana-operator.v3.2.0 Grafana Operator
...
----

. To launch a Grafana instance, create or modify the `ServiceTelemetry` object. Set `graphing.enabled` to `true`.
. To launch a Grafana instance, create or modify the `ServiceTelemetry` object. Set `graphing.enabled` and `graphing.grafana.ingressEnabled` to `true`.
+
----
$ oc edit stf default
Expand All @@ -87,6 +87,8 @@ spec:
...
graphing:
enabled: true
grafana:
ingressEnabled: true
----

. Verify that the Grafana instance deployed:
Expand All @@ -101,8 +103,29 @@ NAME READY STATUS RESTARTS AGE
grafana-deployment-7fc7848b56-sbkhv 1/1 Running 0 1m
----

. Verify the Grafana data sources installed correctly:
+
[source,bash]
----
$ oc get grafanadatasources
----
+
----
NAME AGE
default-datasources 20h
----


. Verify the Grafana route exists:
+
[source,bash]
----
$ oc get route grafana-route
----
+
----
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
grafana-route grafana-route-service-telemetry.apps.infra.watch grafana-service 3000 edge None
----

[id="importing-dashboards_{context}"]
= Importing dashboards
Expand All @@ -111,7 +134,7 @@ The Grafana Operator can import and manage dashboards by creating `GrafanaDashbo

.Procedure

. Import a dashboard:
. Import the infrastructure dashboard:
+
[source,bash,options="nowrap"]
----
Expand All @@ -121,53 +144,52 @@ $ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/dep
----
grafanadashboard.integreatly.org/rhos-dashboard created
----

. Verify that the resources installed correctly:
. Import the cloud dashboard:
+
[source,bash]
[source,bash,options="nowrap"]
----
$ oc get grafanadashboards
$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/rhos-cloud-dashboard.yaml
----
+
----
NAME AGE
rhos-dashboard 7d21h
grafanadashboard.integreatly.org/rhos-cloud-dashboard created
----
[WARNING]
Some panels in the cloud dashboard require specific values be configured for the collectd virt plugin hostname_format parameter in the stf-connectors.yaml. If not configured some panels in the dashboard will be affected.
[source,yaml]
---
parameter_defaults:
ExtraConfig:
collectd::plugin::virt::hostname_format: name uuid hostname
---

. Verify that the dashboards are available:
+
[source,bash]
----
$ oc get grafanadatasources
----
+
----
NAME AGE
default-ds-prometheus 20h
$ oc get grafanadashboards
----

. Expose the grafana service as a route:
+
[source,bash,options="nowrap"]
----
$ oc create route edge dashboards --service=grafana-service --insecure-policy="Redirect" --port=3000
NAME AGE
rhos-dashboard 7d21h
rhos-cloud-dashboard 7d21h
----

. Retrieve the Grafana route address:

+
[source,bash]
----
$ oc get route dashboards
$ oc get route grafana-route -ojsonpath='{.spec.host}'
----
+
[source,bash,options="nowrap"]
----
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
dashboards dashboards-service-telemetry.apps.stfcloudops1.lab.upshift.rdu2.redhat.com grafana-service 3000 edge/Redirect None
grafana-route-service-telemetry.apps.infra.watch
----
+
The `HOST/PORT` value is the Grafana route address.

. Navigate to https://<GRAFANA-ROUTE-ADDRESS> in a web browser. Replace <GRAFANA-ROUTE-ADDRESS> with the `HOST/PORT` value that you retrieved in the previous step.
. Navigate to https://<GRAFANA-ROUTE-ADDRESS> in a web browser. Replace <GRAFANA-ROUTE-ADDRESS> with the value retrieved in the previous step.

. To view the dashboard, click *Dashboards* and *Manage*.

Expand Down