diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc index 10413134..c7a64342 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc @@ -18,15 +18,10 @@ ifdef::include_when_16[] * xref:container-health-and-api-status_assembly-advanced-features[Monitoring container health and API status] endif::include_when_16[] - //Dashboards include::../modules/con_dashboards.adoc[leveloffset=+1] include::../modules/proc_setting-up-grafana-to-host-the-dashboard.adoc[leveloffset=+2] -ifdef::include_when_16[] -// TODO: either rewrite or drop this procedure. We now provide the preferred downstream RHEL Grafana workload image in the deployment procedure. -//include::../modules/proc_overriding-the-default-grafana-container-image.adoc[leveloffset=+2] include::../modules/proc_importing-dashboards.adoc[leveloffset=+2] -endif::include_when_16[] include::../modules/proc_connecting-an-external-dashboard-system.adoc[leveloffset=+2] //Editing the metrics retention time period @@ -68,13 +63,10 @@ include::../modules/con_resource-usage-of-openstack.adoc[leveloffset=+1] include::../modules/proc_disabling-resource-usage-monitoring-of-openstack-services.adoc[leveloffset=+2] //Monitoring container health - include::../modules/con_container-health-and-api-status.adoc[leveloffset=+1] include::../modules/proc_disabling-container-health-and-api-status-monitoring.adoc[leveloffset=+2] endif::include_when_16[] - - //reset the context ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc index e406ae5d..fa356b4f 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc @@ -24,7 +24,7 @@ EOF + [source,bash] ---- -$ for o in alertmanager/default prometheus/default elasticsearch/elasticsearch grafana/default; do oc delete $o; done +$ for o in alertmanagers.monitoring.rhobs/default prometheuses.monitoring.rhobs/default elasticsearch/elasticsearch grafana/default-grafana; do oc delete $o; done ---- + . To verify that all workloads are operating correctly, view the pods and the status of each pod: diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc index bbea3297..91bc7fad 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc @@ -17,7 +17,7 @@ $ source ~/stackrc . Add your data collection and {MessageBus} environment files to the stack with your other environment files and deploy the overcloud: + -[source,bash] +[source,bash,options="nowrap"] ---- (undercloud)$ openstack overcloud deploy --templates \ -e [your environment files] \ diff --git a/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc index c7d21999..21c4d2d6 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc @@ -1,78 +1,67 @@ [id="importing-dashboards_{context}"] -= Importing dashboards += Enabling dashboards [role="_abstract"] -The Grafana Operator can import and manage dashboards by creating `GrafanaDashboard` objects. You can view example dashboards at https://github.com/infrawatch/dashboards. +The Grafana Operator can import and manage dashboards by creating `GrafanaDashboard` objects. Service Telemetry Operator can enable a set of default dashboards that create the `GrafanaDashboard` objects that load dashboards into the Grafana instance. -.Procedure +Set the value of `graphing.grafana.dashboards.enabled` to `true` to load the following dashboards into Grafana : -. Import the infrastructure dashboard: -+ -[source,bash,options="nowrap"] ----- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/rhos-dashboard.yaml +* Infrastructure dashboard +* Cloud view dashboard +* Virtual machine view dashboard +* Memcached view dashboard -grafanadashboard.integreatly.org/rhos-dashboard-1 created ----- -. Import the cloud dashboard: -+ -[WARNING] -In the `enable-stf.yaml` file, ensure you set the value of the collectd `virt` plugin parameter `hostname_format` to `name uuid hostname`, otherwise some of the panels on the cloud dashboard display no information. -ifdef::include_before_17[] -For more information about the `virt` plugin, see link:{defaultURL}/operational_measurements/collectd-plugins_assembly[collectd plugins]. -endif::include_before_17[] -ifdef::include_when_17[] -For more information about the `virt` plugin, see link:{defaultURL}/managing_overcloud_observability/collectd-plugins_assembly[collectd plugins]. -endif::include_when_17[] -+ -[source,bash,options="nowrap"] ----- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/rhos-cloud-dashboard.yaml +You can use the `GrafanaDashboard` object to create and load additional dashboards into Grafana. For more information about managing dashboards with Grafana Operator, see link:https://grafana.github.io/grafana-operator/docs/dashboards/[Dashboards] in the _Grafana Operator project documentation_. -grafanadashboard.integreatly.org/rhos-cloud-dashboard-1 created ----- -. Import the virtual machine dashboard: -+ -[source,bash,options="nowrap"] ----- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/virtual-machine-view.yaml +.Prerequisites -grafanadashboard.integreatly.org/virtual-machine-view-1 configured ----- -. Import the memcached dashboard: +* You enabled graphing in the `ServiceTelemetry` object. For more information about graphing, see xref:setting-up-grafana-to-host-the-dashboard_assembly-advanced-features[]. + +.Procedure + +. To enable the managed dashboards, create or modify the `ServiceTelemetry` object. Set `graphing.grafana.dashboards.enabled` to `true`: + -[source,bash,options="nowrap"] +[source,bash] ---- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/memcached-dashboard.yaml +$ oc edit stf default -grafanadashboard.integreatly.org/memcached-dashboard-1 created +apiVersion: infra.watch/v1beta1 +kind: ServiceTelemetry +... +spec: + ... + graphing: + enabled: true + grafana: + dashboards: + enabled: true ---- -. Verify that the dashboards are available: +. Verify that the Grafana dashboards are created. The process of Service Telemetry Operator creating the dashboards might take some time. + -[source,bash] +[source,bash,options="nowrap"] ---- -$ oc get grafanadashboards +$ oc get grafanadashboards.grafana.integreatly.org -NAME AGE -memcached-dashboard-1 7s -rhos-cloud-dashboard-1 23s -rhos-dashboard-1 29s -virtual-machine-view-1 13s +NAME NO MATCHING INSTANCES LAST RESYNC AGE +memcached-dashboard-1 38s 38s +rhos-cloud-dashboard-1 39s 39s +rhos-dashboard-1 39s 39s +virtual-machine-dashboard-1 37s 37s ---- . Retrieve the Grafana route address: + [source,bash,options="nowrap"] ---- -$ oc get route grafana-route -ojsonpath='{.spec.host}' +$ oc get route default-grafana-route -ojsonpath='{.spec.host}' -grafana-route-service-telemetry.apps.infra.watch +default-grafana-route-service-telemetry.apps.infra.watch ---- . In a web browser, navigate to https://__. Replace __ with the value that you retrieved in the previous step. . Log in with OpenShift credentials. For more information about logging in, see xref:accessing-uis-for-stf-components_assembly-installing-the-core-components-of-stf[]. -. To view the dashboard, click *Dashboards* and *Manage*. +. To view the dashboard, click *Dashboards* and *Browse*. The managed dashboards are available in the _service-telemetry_ folder.