Merge pull request #47007 from bburt-rh/RHDEVDOCS-3389-document-grafana-removal-from-monitoring

JStickler · web-flow · commit f918024dfc40 · 2022-06-30T14:50:17.000-04:00
RHDEVDOCS-3389 - removal of references to the monitoring Grafana component and UI
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2177,8 +2177,8 @@ Topics:
   File: managing-alerts
 - Name: Reviewing monitoring dashboards
   File: reviewing-monitoring-dashboards
-- Name: Accessing third-party monitoring UIs and APIs
-  File: accessing-third-party-monitoring-uis-and-apis
+- Name: Accessing third-party monitoring APIs
+  File: accessing-third-party-monitoring-apis
 - Name: Troubleshooting monitoring issues
   File: troubleshooting-monitoring-issues
 ---
diff --git a/images/monitoring-architecture.svg b/images/monitoring-architecture.svg
diff --git a/logging/cluster-logging-dashboards.adoc b/logging/cluster-logging-dashboards.adoc
@@ -12,11 +12,6 @@ The *OpenShift Logging* dashboard contains charts that show details about your E
 
 The *Logging/Elasticsearch Nodes* dashboard contains charts that show details about your Elasticsearch instance, many at node level, including details on indexing, shards, resources, and so forth.
 
-[NOTE]
-====
-For more detailed data, click the *Grafana UI* link in a dashboard to launch the Grafana dashboard. Grafana is shipped with xref:../monitoring/monitoring-overview.adoc#monitoring-overview[OpenShift cluster monitoring].
-====
-
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference
 // modules required to cover the user story. You can also include other
diff --git a/modules/cluster-logging-dashboards-access.adoc b/modules/cluster-logging-dashboards-access.adoc
@@ -21,8 +21,3 @@ For the *Logging/Elasticsearch Nodes* dashboard, you can select the Elasticsearc
 The appropriate dashboard is displayed, showing multiple charts of data.
 
 . Optional: Select a different time range to display or refresh rate for the data from the *Time Range* and *Refresh Interval* menus.
-
-[NOTE]
-====
-For more detailed data, click the *Grafana UI* link to launch the Grafana dashboard.
-====
diff --git a/modules/infrastructure-moving-monitoring.adoc b/modules/infrastructure-moving-monitoring.adoc
@@ -6,9 +6,10 @@
 [id="infrastructure-moving-monitoring_{context}"]
 = Moving the monitoring solution
 
-
-By default, the Prometheus Cluster Monitoring stack, which contains Prometheus, Grafana, and AlertManager, is deployed to provide cluster monitoring. It is managed by the Cluster Monitoring Operator. To move its components to different machines, you create and apply a custom config map.
-
+The monitoring stack includes multiple components, including Prometheus, Thanos Querier, and Alertmanager.
+The Cluster Monitoring Operator manages this stack.
+To redeploy the monitoring stack to infrastructure nodes, you can create and apply a custom config map.
+ 
 .Procedure
 
 . Save the following `ConfigMap` definition as the `cluster-monitoring-configmap.yaml` file:
@@ -31,9 +32,6 @@ data:
     prometheusOperator:
       nodeSelector:
         node-role.kubernetes.io/infra: ""
-    grafana:
-      nodeSelector:
-        node-role.kubernetes.io/infra: ""
     k8sPrometheusAdapter:
       nodeSelector:
         node-role.kubernetes.io/infra: ""
diff --git a/modules/installation-azure-create-ingress-dns-records.adoc b/modules/installation-azure-create-ingress-dns-records.adoc
@@ -115,7 +115,6 @@ oauth-openshift.apps.cluster.basedomain.com
 console-openshift-console.apps.cluster.basedomain.com
 downloads-openshift-console.apps.cluster.basedomain.com
 alertmanager-main-openshift-monitoring.apps.cluster.basedomain.com
-grafana-openshift-monitoring.apps.cluster.basedomain.com
 prometheus-k8s-openshift-monitoring.apps.cluster.basedomain.com
 ----
 
diff --git a/modules/installation-create-ingress-dns-records.adoc b/modules/installation-create-ingress-dns-records.adoc
@@ -36,7 +36,6 @@ oauth-openshift.apps.<cluster_name>.<domain_name>
 console-openshift-console.apps.<cluster_name>.<domain_name>
 downloads-openshift-console.apps.<cluster_name>.<domain_name>
 alertmanager-main-openshift-monitoring.apps.<cluster_name>.<domain_name>
-grafana-openshift-monitoring.apps.<cluster_name>.<domain_name>
 prometheus-k8s-openshift-monitoring.apps.<cluster_name>.<domain_name>
 ----
 
diff --git a/modules/installation-gcp-user-infra-adding-ingress.adoc b/modules/installation-gcp-user-infra-adding-ingress.adoc
@@ -117,7 +117,6 @@ oauth-openshift.apps.your.cluster.domain.example.com
 console-openshift-console.apps.your.cluster.domain.example.com
 downloads-openshift-console.apps.your.cluster.domain.example.com
 alertmanager-main-openshift-monitoring.apps.your.cluster.domain.example.com
-grafana-openshift-monitoring.apps.your.cluster.domain.example.com
 prometheus-k8s-openshift-monitoring.apps.your.cluster.domain.example.com
 ----
 
diff --git a/modules/installation-osp-configuring-api-floating-ip.adoc b/modules/installation-osp-configuring-api-floating-ip.adoc
@@ -53,7 +53,6 @@ If you do not control the DNS server but want to enable application access for n
 <apps_FIP> integrated-oauth-server-openshift-authentication.apps.<cluster name>.<base domain>
 <apps_FIP> oauth-openshift.apps.<cluster name>.<base domain>
 <apps_FIP> prometheus-k8s-openshift-monitoring.apps.<cluster name>.<base domain>
-<apps_FIP> grafana-openshift-monitoring.apps.<cluster name>.<base domain>
 <apps_FIP> <app name>.apps.<cluster name>.<base domain>
 ----
 ====
diff --git a/modules/monitoring-accessing-third-party-monitoring-uis.adoc b/modules/monitoring-accessing-third-party-monitoring-uis.adoc
diff --git a/modules/monitoring-accessing-third-party-monitoring-web-service-apis.adoc b/modules/monitoring-accessing-third-party-monitoring-web-service-apis.adoc
@@ -3,11 +3,11 @@
 // * monitoring/accessing-third-party-monitoring-uis-and-apis.adoc
 
 :_content-type: PROCEDURE
-[id="accessing-third-party-monitoring-web-service-apis"]
+[id="accessing-third-party-monitoring-web-service-apis_{context}"]
 = Accessing third-party monitoring web service APIs
 
 [role="_abstract"]
-You can directly access third-party web service APIs from the command line for monitoring stack components such as Prometheus, Alertmanager, Thanos Ruler, and Thanos Querier. 
+You can directly access third-party web service APIs from the command line for the following monitoring stack components: Prometheus, Alertmanager, Thanos Ruler, and Thanos Querier. 
 
 The following example commands show how to query the service API receivers for Alertmanager.
 This example requires that the associated user account be bound against the `monitoring-alertmanager-edit` role in the `openshift-monitoring` namespace and that the account has the privilege to view the route.
diff --git a/modules/monitoring-configurable-monitoring-components.adoc b/modules/monitoring-configurable-monitoring-components.adoc
@@ -16,7 +16,6 @@ This table shows the monitoring components you can configure and the keys used t
 |Alertmanager |`alertmanagerMain` |
 |kube-state-metrics |`kubeStateMetrics` |
 |openshift-state-metrics |`openshiftStateMetrics` |
-|Grafana |`grafana` |
 |Telemeter Client |`telemeterClient` |
 |Prometheus Adapter |`k8sPrometheusAdapter` |
 |Thanos Querier |`thanosQuerier` |
diff --git a/modules/monitoring-default-monitoring-components.adoc b/modules/monitoring-default-monitoring-components.adoc
@@ -41,9 +41,6 @@ By default, the {product-title} {product-version} monitoring stack includes thes
 |Thanos Querier
 |The Thanos Querier aggregates and optionally deduplicates core {product-title} metrics and metrics for user-defined projects under a single, multi-tenant interface.
 
-|Grafana
-|The Grafana analytics platform provides dashboards for analyzing and visualizing the metrics. The Grafana instance that is provided with the monitoring stack, along with its dashboards, is read-only.
-
 |Telemeter Client
 |The Telemeter Client sends a subsection of the data from platform Prometheus instances to Red Hat to facilitate Remote Health Monitoring for clusters.
 
diff --git a/modules/monitoring-disabling-grafana.adoc b/modules/monitoring-disabling-grafana.adoc
diff --git a/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc b/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc
@@ -86,9 +86,6 @@ data:
     kubeStateMetrics:
       nodeSelector:
         nodename: worker1
-    grafana:
-      nodeSelector:
-        nodename: worker1
     telemeterClient:
       nodeSelector:
         nodename: worker1
diff --git a/modules/monitoring-support-considerations.adoc b/modules/monitoring-support-considerations.adoc
@@ -18,7 +18,6 @@ The Alertmanager configuration is deployed as a secret resource in the `openshif
 +
 * *Modifying resources of the stack.* The {product-title} monitoring stack ensures its resources are always in the state it expects them to be. If they are modified, the stack will reset them.
 * *Deploying user-defined workloads to `openshift-&#42;`, and `kube-&#42;` projects.* These projects are reserved for Red Hat provided components and they should not be used for user-defined workloads.
-* *Modifying the monitoring stack Grafana instance.*
 * *Installing custom Prometheus instances on {product-title}.*
 * *Enabling symptom based monitoring by using the `Probe` custom resource definition (CRD) in Prometheus Operator.*
 * *Modifying Alertmanager configurations by using the `AlertmanagerConfig` CRD in Prometheus Operator.*
diff --git a/modules/nodes-nodes-viewing-listing.adoc b/modules/nodes-nodes-viewing-listing.adoc
@@ -160,7 +160,7 @@ System Info:    <9>
  Kube-Proxy Version:                      v1.24.0
 PodCIDR:                                  10.128.4.0/24
 ProviderID:                               aws:///us-east-2a/i-04e87b31dc6b3e171
-Non-terminated Pods:                      (13 in total)  <10>
+Non-terminated Pods:                      (12 in total)  <10>
   Namespace                               Name                                   CPU Requests  CPU Limits  Memory Requests  Memory Limits
   ---------                               ----                                   ------------  ----------  ---------------  -------------
   openshift-cluster-node-tuning-operator  tuned-hdl5q                            0 (0%)        0 (0%)      0 (0%)           0 (0%)
@@ -170,7 +170,6 @@ Non-terminated Pods:                      (13 in total)  <10>
   openshift-machine-config-operator       machine-config-daemon-cvqw9            20m (1%)      0 (0%)      50Mi (0%)        0 (0%)
   openshift-marketplace                   community-operators-f67fh              0 (0%)        0 (0%)      0 (0%)           0 (0%)
   openshift-monitoring                    alertmanager-main-0                    50m (3%)      50m (3%)    210Mi (2%)       10Mi (0%)
-  openshift-monitoring                    grafana-78765ddcc7-hnjmm               100m (6%)     200m (13%)  100Mi (1%)       200Mi (2%)
   openshift-monitoring                    node-exporter-l7q8d                    10m (0%)      20m (1%)    20Mi (0%)        40Mi (0%)
   openshift-monitoring                    prometheus-adapter-75d769c874-hvb85    0 (0%)        0 (0%)      0 (0%)           0 (0%)
   openshift-multus                        multus-kw8w5                           0 (0%)        0 (0%)      0 (0%)           0 (0%)
diff --git a/modules/ref_cluster-logging-elasticsearch-cluster-status.adoc b/modules/ref_cluster-logging-elasticsearch-cluster-status.adoc
@@ -4,9 +4,9 @@
 = Elasticsearch cluster status
 
 [role="_abstract"]
-The Grafana dashboard in the *Observe* section of the {product-title} web console displays the status of the Elasticsearch cluster.
+A dashboard in the *Observe* section of the {product-title} web console displays the status of the Elasticsearch cluster.
 
-To get the status of the OpenShift Elasticsearch cluster, visit the Grafana dashboard in the *Observe* section of the {product-title} web console at
+To get the status of the OpenShift Elasticsearch cluster, visit the dashboard in the *Observe* section of the {product-title} web console at
 `<cluster_url>/monitoring/dashboards/grafana-dashboard-cluster-logging`.
 
 .Elasticsearch status fields
diff --git a/monitoring/accessing-third-party-monitoring-apis.adoc b/monitoring/accessing-third-party-monitoring-apis.adoc
@@ -1,18 +1,13 @@
 :_content-type: ASSEMBLY
-[id="accessing-third-party-monitoring-uis-and-apis"]
-= Accessing third-party monitoring UIs and APIs
+[id="accessing-third-party-monitoring-apis"]
+= Accessing third-party monitoring APIs
 include::_attributes/common-attributes.adoc[]
 :context: accessing-third-party-monitoring-uis-and-apis
 
 toc::[]
 
 [role="_abstract"]
-In {product-title} {product-version}, you cannot access third-party web browser user interfaces (UIs) for the following monitoring components: Alertmanager, Prometheus, Thanos Ruler, and Thanos Querier. 
-However, you can access the web UI for Grafana, although this access is deprecated and is planned to be removed in a future {product-title} release.
-In addition, you can access web service APIs for third-party monitoring components from the command line interface (CLI).
-
-// Accessing web UIs for third-party monitoring components
-include::modules/monitoring-accessing-third-party-monitoring-uis.adoc[leveloffset=+1]
+In {product-title} {product-version}, you can access web service APIs for some third-party monitoring components from the command line interface (CLI).
 
 // Accessing service APIs for third-party monitoring components
 include::modules/monitoring-accessing-third-party-monitoring-web-service-apis.adoc[leveloffset=+1]
diff --git a/monitoring/configuring-the-monitoring-stack.adoc b/monitoring/configuring-the-monitoring-stack.adoc
@@ -149,14 +149,6 @@ include::modules/monitoring-setting-audit-log-levels-for-the-prometheus-adapter.
 
 * See xref:../monitoring/configuring-the-monitoring-stack.adoc#preparing-to-configure-the-monitoring-stack[Preparing to configure the monitoring stack] for steps to create monitoring config maps.
 
-// Disabling the default Grafana deployment
-include::modules/monitoring-disabling-grafana.adoc[leveloffset=+1]
-
-[role="_additional-resources"]
-.Additional resources
-
-* See xref:../monitoring/configuring-the-monitoring-stack.adoc#preparing-to-configure-the-monitoring-stack[Preparing to configure the monitoring stack] for steps to create monitoring config maps.
-
 // Disabling the local Alertmanager
 include::modules/monitoring-disabling-the-local-alertmanager.adoc[leveloffset=+1]
 
diff --git a/monitoring/reviewing-monitoring-dashboards.adoc b/monitoring/reviewing-monitoring-dashboards.adoc
@@ -49,4 +49,4 @@ include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[level
 [id="next-steps_reviewing-monitoring-dashboards"]
 == Next steps
 
-* xref:../monitoring/accessing-third-party-monitoring-uis-and-apis.adoc#accessing-third-party-monitoring-uis-and-apis[Accessing third-party monitoring UIs and APIs]
+* xref:../monitoring/accessing-third-party-monitoring-apis.adoc#accessing-third-party-monitoring-apis[Accessing third-party monitoring APIs]
diff --git a/scalability_and_performance/scaling-cluster-monitoring-operator.adoc b/scalability_and_performance/scaling-cluster-monitoring-operator.adoc
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-{product-title} exposes metrics that the Cluster Monitoring Operator collects and stores in the Prometheus-based monitoring stack. As an administrator, you can view system resources, containers, and components metrics in one dashboard interface, Grafana.
+{product-title} exposes metrics that the Cluster Monitoring Operator collects and stores in the Prometheus-based monitoring stack. As an administrator, you can view dashboards for system resources, containers, and components metrics in the {product-title} web console by navigating to *Observe* -> *Dashboards*.
 
 include::modules/prometheus-database-storage-requirements.adoc[leveloffset=+1]
 
