diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc index 2b62ad28..8d4d8207 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc @@ -49,12 +49,17 @@ include::../modules/proc_configuring-snmp-traps.adoc[leveloffset=+1] include::../modules/con_high-availability.adoc[leveloffset=+1] include::../modules/proc_configuring-high-availability.adoc[leveloffset=+2] -ifdef::include_when_16[] -//TODO: Add dashboards back when we have working code for OSP13 //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: Add dashboards back when we have working code for OSP13 +include::../modules/proc_importing-dashboards.adoc[leveloffset=+2] +endif::include_when_16[] +include::../modules/proc_retrieving-and-setting-grafana-login-credentials.adoc[leveloffset=+2] +ifdef::include_when_16[] +//Monitoring and health checks are OSP16+ only //Monitoring the resource usage of Openstack services include::../modules/proc_monitoring-resource-usage-of-openstack-services.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/con_dashboards.adoc b/doc-Service-Telemetry-Framework/modules/con_dashboards.adoc index a6fc6925..0c0380e6 100644 --- a/doc-Service-Telemetry-Framework/modules/con_dashboards.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_dashboards.adoc @@ -30,12 +30,15 @@ Use third-party application Grafana to visualize system-level metrics gathered b For more information about configuring collectd, see xref:configuring-red-hat-openstack-platform-overcloud-for-stf_assembly-completing-the-stf-configuration[]. +ifdef::include_when_16[] +//TODO: can re-work this once we have OSP13 dashboard(s) to show. Can't use container health checks or monitoring in OSP13. You can use two dashboards to monitor a cloud: -* Infrastructure dashboard +Infrastructure dashboard:: Use the infrastructure dashboard to view metrics for a single node at a time. Select a node from the upper left corner of the dashboard. -* Cloud view dashboard +Cloud view dashboard:: Use the cloud view dashboard to view panels for monitoring service resource usage, API stats, and cloud events. You must enable API health monitoring and service monitoring to provide the data for this dashboard. -** To enable API health monitoring, see xref:monitoring-container-health-and-api-status_assembly-advanced-features[]. -** To enable service monitoring, see xref:monitoring-resource-usage-of-openstack-services_assembly-advanced-features[]. +** For more information about API health monitoring, see xref:monitoring-container-health-and-api-status_assembly-advanced-features[]. +** For more information about service monitoring, see xref:monitoring-resource-usage-of-openstack-services_assembly-advanced-features[]. +endif::include_when_16[] diff --git a/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc new file mode 100644 index 00000000..5a92bcbd --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc @@ -0,0 +1,82 @@ +// Module included in the following assemblies: +// +// + +// This module can be included from assemblies using the following include statement: +// include::/proc_importing-dashboards.adoc[leveloffset=+2] + +// The file name and the ID are based on the module title. For example: +// * file name: proc_doing-procedure-a.adoc +// * ID: [id='proc_doing-procedure-a_{context}'] +// * Title: = Doing procedure A +// +// The ID is used as an anchor for linking to the module. Avoid changing +// it after the module has been published to ensure existing links are not +// broken. +// +// The `context` attribute enables module reuse. Every module's ID includes +// {context}, which ensures that the module has a unique ID even if it is +// reused multiple times in a guide. +// +// Start the title with a verb, such as Creating or Create. See also +// _Wording of headings_ in _The IBM Style Guide_. + +[id="importing-dashboards_{context}"] += Importing 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. + +.Procedure + +. Import the infrastructure dashboard: ++ +[source,bash,options="nowrap"] +---- +$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/rhos-dashboard.yaml + +grafanadashboard.integreatly.org/rhos-dashboard created +---- +. Import the cloud dashboard: ++ +[source,bash,options="nowrap"] +---- +$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/rhos-cloud-dashboard.yaml + +grafanadashboard.integreatly.org/rhos-cloud-dashboard created +---- ++ +[WARNING] +==== +Some panels in the cloud dashboard require that you set the collectd `virt` plugin parameter `hostname_format` to `name uuid hostname` in the stf-connectors.yaml file. If you do not configure this parameter, affected dashboards remain empty. +[source,yaml] +---- +parameter_defaults: + ExtraConfig: + collectd::plugin::virt::hostname_format: name uuid hostname +---- +==== + +. Verify that the dashboards are available: ++ +[source,bash] +---- +$ oc get grafanadashboards + +NAME AGE +rhos-dashboard 7d21h +rhos-cloud-dashboard 7d21h +---- + +. Retrieve the Grafana route address: ++ +[source,bash,options="nowrap"] +---- +$ oc get route grafana-route -ojsonpath='{.spec.host}' + +grafana-route-service-telemetry.apps.infra.watch +---- + +. Navigate to https://__ in a web browser. Replace __ with the value that you retrieved in the previous step. + +. To view the dashboard, click *Dashboards* and *Manage*. diff --git a/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc b/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc new file mode 100644 index 00000000..9d1ab733 --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc @@ -0,0 +1,46 @@ +// Module included in the following assemblies: +// +// + +// This module can be included from assemblies using the following include statement: +// include::/proc_retrieving-and-setting-grafana-login-credentials.adoc[leveloffset=+2] + +// The file name and the ID are based on the module title. For example: +// * file name: proc_doing-procedure-a.adoc +// * ID: [id='proc_doing-procedure-a_{context}'] +// * Title: = Doing procedure A +// +// The ID is used as an anchor for linking to the module. Avoid changing +// it after the module has been published to ensure existing links are not +// broken. +// +// The `context` attribute enables module reuse. Every module's ID includes +// {context}, which ensures that the module has a unique ID even if it is +// reused multiple times in a guide. +// +// Start the title with a verb, such as Creating or Create. See also +// _Wording of headings_ in _The IBM Style Guide_. + +[id="proc-retrieving-and-setting-grafana-credentials_{context}"] += Retrieving and setting Grafana login credentials + +[role="_abstract"] +{ProjectShort} sets default login credentials when Grafana is enabled. The credentials can be overridden in the `ServiceTelemetry` object. + +.Procedure + +. Log in to {OpenShift}. +. Change to the `service-telemetry` namespace: ++ +[source,bash] +---- +$ oc project service-telemetry +---- +. To retrieve the default username and password, describe the Grafana object: ++ +[source,bash] +---- +$ oc describe grafana default +---- + +. To modify the default values of the Grafana administrator username and password through the ServiceTelemetry object, use the `graphing.grafana.adminUser` and `graphing.grafana.adminPassword` parameters. diff --git a/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc b/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc index 73e55c1a..10cdb521 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc @@ -117,82 +117,5 @@ NAME HOST/PORT PATH SERVIC grafana-route grafana-route-service-telemetry.apps.infra.watch grafana-service 3000 edge None ---- -[id="importing-dashboards_{context}"] -= Importing dashboards -The Grafana Operator can import and manage dashboards by creating `GrafanaDashboard` objects. You can view example dashboards at https://github.com/infrawatch/dashboards. -.Procedure - -. Import the infrastructure dashboard: -+ -[source,bash,options="nowrap"] ----- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/rhos-dashboard.yaml - -grafanadashboard.integreatly.org/rhos-dashboard created ----- -. Import the cloud dashboard: -+ -[source,bash,options="nowrap"] ----- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/rhos-cloud-dashboard.yaml - -grafanadashboard.integreatly.org/rhos-cloud-dashboard created ----- -[WARNING] -==== -Some panels in the cloud dashboard require that you set the collectd `virt` plugin parameter `hostname_format` to `name uuid hostname` in the stf-connectors.yaml. If you do not configure this parameter, affected dashboards remain empty. -[source,yaml] ----- -parameter_defaults: - ExtraConfig: - collectd::plugin::virt::hostname_format: name uuid hostname ----- -==== - -. Verify that the dashboards are available: -+ -[source,bash] ----- -$ oc get grafanadashboards - -NAME AGE -rhos-dashboard 7d21h -rhos-cloud-dashboard 7d21h ----- - -. Retrieve the Grafana route address: -+ -[source,bash,options="nowrap"] ----- -$ oc get route grafana-route -ojsonpath='{.spec.host}' - -grafana-route-service-telemetry.apps.infra.watch ----- - -. Navigate to https:// in a web browser. Replace with the value that you retrieved in the previous step. - -. To view the dashboard, click *Dashboards* and *Manage*. - - -[id="proc-retrieving-and-setting-grafana-credentials"] -= Retrieving and setting Grafana login credentials - -.Procedure - -. Log in to {OpenShift}. -. Change to the `service-telemetry` namespace: -+ -[source,bash] ----- -$ oc project service-telemetry ----- -. To retrieve the default username and password, describe the Grafana object: -+ -[source,bash] ----- -$ oc describe grafana default ----- - -. To modify the default values of the Grafana administrator username and password through the ServiceTelemetry object, use the `graphing.grafana.adminUser` and `graphing.grafana.adminPassword` parameters.