diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc index 5a99812a..10413134 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc @@ -27,6 +27,7 @@ ifdef::include_when_16[] //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 include::../modules/con_metrics-retention-time-period.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc b/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc index f75060ea..e9a0b46a 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc @@ -4,7 +4,18 @@ [role="_abstract"] In {OpenShift}, applications are exposed to the external network through a route. For more information about routes, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/networking/configuring_ingress_cluster_traffic/overview-traffic.html[Configuring ingress cluster traffic]. -In {Project} ({ProjectShort}), HTTPS routes are exposed for each service that has a web-based interface. These routes are protected by {OpenShift} RBAC and any user that has a `ClusterRoleBinding` that enables them to view {OpenShift} Namespaces can log in. For more information about RBAC, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/authentication/using-rbac.html[Using RBAC to define and apply permissions]. +In {Project} ({ProjectShort}), HTTPS routes are exposed for each service that has a web-based interface and protected by {OpenShift} role-based access control (RBAC). + +You need the following permissions to access the corresponding component UI's: + +[source,json,options="nowrap"] +---- +{"namespace":"service-telemetry", "resource":"grafana", "group":"integreatly.org", "verb":"get"} +{"namespace":"service-telemetry", "resource":"prometheus", "group":"monitoring.rhobs", "verb":"get"} +{"namespace":"service-telemetry", "resource":"alertmanager", "group":"monitoring.rhobs", "verb":"get"} +---- + +For more information about RBAC, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/authentication/using-rbac.html[Using RBAC to define and apply permissions]. .Procedure diff --git a/doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc b/doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc new file mode 100644 index 00000000..4cc39b7a --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc @@ -0,0 +1,77 @@ + +[id="connecting-an-external-dashboard-system_{context}"] += Connecting an external dashboard system + +It is possible to configure third-party visualization tools to connect to the {ProjectShort} Prometheus for metrics retrieval. Access is controlled via an OAuth token, and a ServiceAccount is already created that has (only) the required permissions. A new OAuth token can be generated against this account for the external system to use. + +To use the authentication token, the third-party tool must be configured to supply an HTTP Bearer Token Authorization header as described in RFC6750. Consult the documentation of the third-party tool for how to configure this header. For example link:https://grafana.com/docs/grafana/latest/datasources/prometheus/configure-prometheus-data-source/#custom-http-headers[Configure Prometheus - Custom HTTP Headers] in the _Grafana Documentation_. + +.Procedure + +. Log in to {OpenShift}. + +. Change to the `service-telemetry` namespace: ++ +[source,bash] +---- +$ oc project service-telemetry +---- + +. Create a new token secret for the stf-prometheus-reader service account ++ +[source,bash] +---- +$ oc create -f - <_. 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*.