Merge pull request openshift#74104 from eromanova97/OBSDOCS-692

OBSDOCS-692: Update Monitoring doc links and topic map position
adellape · Apr 10, 2024 · 43af5ee · 43af5ee
2 parents fa52356 + 185b400
commit 43af5ee
Show file tree

Hide file tree

Showing 191 changed files with 371 additions and 365 deletions.
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2595,6 +2595,41 @@ Distros: openshift-enterprise,openshift-origin
 Topics:
 - Name: Observability overview
   File: index
+- Name: Monitoring
+  Dir: monitoring
+  Distros: openshift-enterprise,openshift-origin
+  Topics:
+  - Name: Monitoring overview
+    File: monitoring-overview
+  - Name: Configuring the monitoring stack
+    File: configuring-the-monitoring-stack
+  - Name: Enabling monitoring for user-defined projects
+    File: enabling-monitoring-for-user-defined-projects
+  - Name: Enabling alert routing for user-defined projects
+    File: enabling-alert-routing-for-user-defined-projects
+  - Name: Managing metrics
+    File: managing-metrics
+  - Name: Managing alerts
+    File: managing-alerts
+  - Name: Reviewing monitoring dashboards
+    File: reviewing-monitoring-dashboards
+  - Name: Accessing monitoring APIs by using the CLI
+    File: accessing-third-party-monitoring-apis
+  - Name: Troubleshooting monitoring issues
+    File: troubleshooting-monitoring-issues
+  - Name: Config map reference for the Cluster Monitoring Operator
+    File: config-map-reference-for-the-cluster-monitoring-operator
+  - Name: Cluster Observability Operator
+    Dir: cluster_observability_operator
+    Topics:
+    - Name: Cluster Observability Operator release notes
+      File: cluster-observability-operator-release-notes
+    - Name: Cluster Observability Operator overview
+      File: cluster-observability-operator-overview
+    - Name: Installing the Cluster Observability Operator
+      File: installing-the-cluster-observability-operator
+    - Name: Configuring the Cluster Observability Operator to monitor a service
+      File: configuring-the-cluster-observability-operator-to-monitor-a-service
 - Name: Distributed tracing
   Dir: distr_tracing
   Distros: openshift-enterprise
@@ -2831,42 +2866,6 @@ Topics:
 - Name: Glossary
   File: logging-common-terms
 ---
-Name: Monitoring
-Dir: monitoring
-Distros: openshift-enterprise,openshift-origin
-Topics:
-- Name: Monitoring overview
-  File: monitoring-overview
-- Name: Configuring the monitoring stack
-  File: configuring-the-monitoring-stack
-- Name: Enabling monitoring for user-defined projects
-  File: enabling-monitoring-for-user-defined-projects
-- Name: Enabling alert routing for user-defined projects
-  File: enabling-alert-routing-for-user-defined-projects
-- Name: Managing metrics
-  File: managing-metrics
-- Name: Managing alerts
-  File: managing-alerts
-- Name: Reviewing monitoring dashboards
-  File: reviewing-monitoring-dashboards
-- Name: Accessing monitoring APIs by using the CLI
-  File: accessing-third-party-monitoring-apis
-- Name: Troubleshooting monitoring issues
-  File: troubleshooting-monitoring-issues
-- Name: Config map reference for the Cluster Monitoring Operator
-  File: config-map-reference-for-the-cluster-monitoring-operator
-- Name: Cluster Observability Operator
-  Dir: cluster_observability_operator
-  Topics:
-  - Name: Cluster Observability Operator release notes
-    File: cluster-observability-operator-release-notes
-  - Name: Cluster Observability Operator overview
-    File: cluster-observability-operator-overview
-  - Name: Installing the Cluster Observability Operator
-    File: installing-the-cluster-observability-operator
-  - Name: Configuring the Cluster Observability Operator to monitor a service
-    File: configuring-the-cluster-observability-operator-to-monitor-a-service
----
 Name: Scalability and performance
 Dir: scalability_and_performance
 Distros: openshift-origin,openshift-enterprise,openshift-webscale,openshift-dpu

diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -1254,32 +1254,36 @@ Topics:
 - Name: Glossary
   File: logging-common-terms
 ---
-Name: Monitoring
-Dir: monitoring
+Name: Observability
+Dir: observability
 Distros: openshift-dedicated
 Topics:
-- Name: Monitoring overview
-  File: monitoring-overview
-- Name: Accessing monitoring for user-defined projects
-  File: sd-accessing-monitoring-for-user-defined-projects
-- Name: Configuring the monitoring stack
-  File: configuring-the-monitoring-stack
-- Name: Disabling monitoring for user-defined projects
-  File: sd-disabling-monitoring-for-user-defined-projects
-- Name: Enabling alert routing for user-defined projects
-  File: enabling-alert-routing-for-user-defined-projects
-- Name: Managing metrics
-  File: managing-metrics
-- Name: Managing alerts
-  File: managing-alerts
-- Name: Reviewing monitoring dashboards
-  File: reviewing-monitoring-dashboards
-- Name: Accessing third-party monitoring APIs
-  File: accessing-third-party-monitoring-apis
-- Name: Troubleshooting monitoring issues
-  File: troubleshooting-monitoring-issues
-- Name: Config map reference for the Cluster Monitoring Operator
-  File: config-map-reference-for-the-cluster-monitoring-operator
+- Name: Monitoring
+  Dir: monitoring
+  Distros: openshift-dedicated
+  Topics:
+  - Name: Monitoring overview
+    File: monitoring-overview
+  - Name: Accessing monitoring for user-defined projects
+    File: sd-accessing-monitoring-for-user-defined-projects
+  - Name: Configuring the monitoring stack
+    File: configuring-the-monitoring-stack
+  - Name: Disabling monitoring for user-defined projects
+    File: sd-disabling-monitoring-for-user-defined-projects
+  - Name: Enabling alert routing for user-defined projects
+    File: enabling-alert-routing-for-user-defined-projects
+  - Name: Managing metrics
+    File: managing-metrics
+  - Name: Managing alerts
+    File: managing-alerts
+  - Name: Reviewing monitoring dashboards
+    File: reviewing-monitoring-dashboards
+  - Name: Accessing third-party monitoring APIs
+    File: accessing-third-party-monitoring-apis
+  - Name: Troubleshooting monitoring issues
+    File: troubleshooting-monitoring-issues
+  - Name: Config map reference for the Cluster Monitoring Operator
+    File: config-map-reference-for-the-cluster-monitoring-operator
 ---
 Name: Service Mesh
 Dir: service_mesh

diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -1497,32 +1497,36 @@ Topics:
 - Name: Glossary
   File: logging-common-terms
 ---
-Name: Monitoring
-Dir: monitoring
+Name: Observability
+Dir: observability
 Distros: openshift-rosa
 Topics:
-- Name: Monitoring overview
-  File: monitoring-overview
-- Name: Accessing monitoring for user-defined projects
-  File: sd-accessing-monitoring-for-user-defined-projects
-- Name: Configuring the monitoring stack
-  File: configuring-the-monitoring-stack
-- Name: Disabling monitoring for user-defined projects
-  File: sd-disabling-monitoring-for-user-defined-projects
-- Name: Enabling alert routing for user-defined projects
-  File: enabling-alert-routing-for-user-defined-projects
-- Name: Managing metrics
-  File: managing-metrics
-- Name: Managing alerts
-  File: managing-alerts
-- Name: Reviewing monitoring dashboards
-  File: reviewing-monitoring-dashboards
-- Name: Accessing third-party monitoring APIs
-  File: accessing-third-party-monitoring-apis
-- Name: Troubleshooting monitoring issues
-  File: troubleshooting-monitoring-issues
-- Name: Config map reference for the Cluster Monitoring Operator
-  File: config-map-reference-for-the-cluster-monitoring-operator
+- Name: Monitoring
+  Dir: monitoring
+  Distros: openshift-rosa
+  Topics:
+  - Name: Monitoring overview
+    File: monitoring-overview
+  - Name: Accessing monitoring for user-defined projects
+    File: sd-accessing-monitoring-for-user-defined-projects
+  - Name: Configuring the monitoring stack
+    File: configuring-the-monitoring-stack
+  - Name: Disabling monitoring for user-defined projects
+    File: sd-disabling-monitoring-for-user-defined-projects
+  - Name: Enabling alert routing for user-defined projects
+    File: enabling-alert-routing-for-user-defined-projects
+  - Name: Managing metrics
+    File: managing-metrics
+  - Name: Managing alerts
+    File: managing-alerts
+  - Name: Reviewing monitoring dashboards
+    File: reviewing-monitoring-dashboards
+  - Name: Accessing third-party monitoring APIs
+    File: accessing-third-party-monitoring-apis
+  - Name: Troubleshooting monitoring issues
+    File: troubleshooting-monitoring-issues
+  - Name: Config map reference for the Cluster Monitoring Operator
+    File: config-map-reference-for-the-cluster-monitoring-operator
 ---
 Name: Service Mesh
 Dir: service_mesh

diff --git a/...odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc b/...odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc
@@ -31,4 +31,4 @@ include::modules/odc-monitoring-your-app-vulnerabilities.adoc[leveloffset=+1]
 [role="_additional-resources"]
 [id="additional-resources-odc-monitoring-project-and-application-metrics-using-developer-perspective"]
 == Additional resources
-* xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
+* xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting.adoc
@@ -99,14 +99,14 @@ include::modules/migration-combining-must-gather.adoc[leveloffset=+2]
 include::modules/oadp-monitoring.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
-* xref:../../monitoring/monitoring-overview.adoc#about-openshift-monitoring[Monitoring stack]
+* xref:../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[Monitoring stack]
 
 include::modules/oadp-monitoring-setup.adoc[leveloffset=+2]
 include::modules/oadp-creating-service-monitor.adoc[leveloffset=+2]
 include::modules/oadp-creating-alerting-rule.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
-* xref:../../monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]
+* xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]
 
 include::modules/oadp-list-of-metrics.adoc[leveloffset=+2]
 include::modules/oadp-viewing-metrics-ui.adoc[leveloffset=+2]

diff --git a/cicd/gitops/monitoring-argo-cd-custom-resource-workloads.adoc b/cicd/gitops/monitoring-argo-cd-custom-resource-workloads.adoc
@@ -19,7 +19,7 @@ You can enable and disable the setting for monitoring Argo CD custom resource wo
 * {gitops-title} is installed in your cluster.
 * The monitoring stack is configured in your cluster in the `openshift-monitoring` project. In addition, the Argo CD instance is in a namespace that you can monitor through Prometheus.
 * The `kube-state-metrics` service is running in your cluster.
-* Optional: If you are enabling monitoring for an Argo CD instance already present in a user-defined project, ensure that the monitoring is xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects_enabling-monitoring-for-user-defined-projects[enabled for user-defined projects] in your cluster.
+* Optional: If you are enabling monitoring for an Argo CD instance already present in a user-defined project, ensure that the monitoring is xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects_enabling-monitoring-for-user-defined-projects[enabled for user-defined projects] in your cluster.
 +
 [NOTE]
 ====
@@ -35,4 +35,4 @@ include::modules/gitops-disabling-monitoring-for-argo-cd-custom-resource-workloa
 [role="_additional-resources"]
 [id="additional-resources_monitoring-argo-cd-custom-resource-workloads"]
 == Additional resources
-* xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
+* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
diff --git a/cicd/pipelines/creating-applications-with-cicd-pipelines.adoc b/cicd/pipelines/creating-applications-with-cicd-pipelines.adoc
@@ -68,7 +68,7 @@ include::modules/op-enabling-monitoring-of-event-listeners-for-triggers-for-user
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
+* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
 
 include::modules/op-configuring-pull-request-capabilities-in-GitHub-interceptor.adoc[leveloffset=+1]
 

diff --git a/getting_started/openshift-overview.adoc b/getting_started/openshift-overview.adoc
@@ -108,8 +108,8 @@ be reviewed by cluster administrators and xref:../operators/admin/olm-adding-ope
 
 * **xref:../updating/updating_a_cluster/updating_disconnected_cluster/disconnected-update-osus.adoc#update-service-overview_updating-restricted-network-cluster-osus[Using the OpenShift Update Service in a disconnected environement]**: Learn about installing and managing a local OpenShift Update Service for recommending {product-title} updates in disconnected environments.
 
-* **xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitor clusters]**:
-Learn to  xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack].
-After configuring monitoring, use the web console to access xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[monitoring dashboards]. In addition to infrastructure metrics, you can also scrape and view metrics for your own services.
+* **xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitor clusters]**:
+Learn to  xref:../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack].
+After configuring monitoring, use the web console to access xref:../observability/monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[monitoring dashboards]. In addition to infrastructure metrics, you can also scrape and view metrics for your own services.
 
 * **xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring_about-remote-health-monitoring[Remote health monitoring]**: {product-title} collects anonymized aggregated information about your cluster. Using Telemetry and the Insights Operator, this data is received by Red Hat and used to improve {product-title}. You can view the xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring_showing-data-collected-by-remote-health-monitoring[data collected by remote health monitoring].
diff --git a/installing/installing-preparing.adoc b/installing/installing-preparing.adoc
@@ -109,12 +109,12 @@ For a production cluster, you must configure the following integrations:
 
 * xref:../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Persistent storage]
 * xref:../authentication/understanding-identity-provider.adoc#understanding-identity-provider[An identity provider]
-* xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Monitoring core OpenShift Container Platform components]
+* xref:../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Monitoring core OpenShift Container Platform components]
 
 [id="installing-preparing-cluster-for-workloads"]
 == Preparing your cluster for workloads
 
-Depending on your workload needs, you might need to take extra steps before you begin deploying applications. For example, after you prepare infrastructure to support your application xref:../cicd/builds/build-strategies.adoc#build-strategies[build strategy], you might need to make provisions for xref:../scalability_and_performance/cnf-low-latency-tuning.adoc#cnf-low-latency-tuning[low-latency] workloads or to xref:../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[monitoring] for application workloads.
+Depending on your workload needs, you might need to take extra steps before you begin deploying applications. For example, after you prepare infrastructure to support your application xref:../cicd/builds/build-strategies.adoc#build-strategies[build strategy], you might need to make provisions for xref:../scalability_and_performance/cnf-low-latency-tuning.adoc#cnf-low-latency-tuning[low-latency] workloads or to xref:../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[monitoring] for application workloads.
 If you plan to run xref:../windows_containers/enabling-windows-container-workloads.adoc#enabling-windows-container-workloads[Windows workloads], you must enable xref:../networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc#configuring-hybrid-networking[hybrid networking with OVN-Kubernetes] during the installation process; hybrid networking cannot be enabled after your cluster is installed.
 
 [id="supported-installation-methods-for-different-platforms"]

diff --git a/installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc b/installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc
@@ -30,4 +30,4 @@ include::modules/vsphere-problem-detector-metrics.adoc[leveloffset=+1]
 [role="_additional-resources"]
 == Additional resources
 
-* xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
+* xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
diff --git a/installing/validating-an-installation.adoc b/installing/validating-an-installation.adoc
@@ -56,15 +56,15 @@ include::modules/checking-cluster-resource-availability-and-utilization.adoc[lev
 [role="_additional-resources"]
 .Additional resources
 
-* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack.
+* See xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack.
 
 //Listing alerts that are firing
 include::modules/listing-alerts-that-are-firing.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 
-* See xref:../monitoring/managing-alerts.adoc#managing-alerts[Managing alerts] for further details about alerting in {product-title}.
+* See xref:../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts] for further details about alerting in {product-title}.
 
 [id="validating-an-installation-next-steps"]
 == Next steps

diff --git a/logging/logging_alerts/custom-logging-alerts.adoc b/logging/logging_alerts/custom-logging-alerts.adoc
@@ -30,8 +30,8 @@ include::modules/logging-enabling-loki-alerts.adoc[leveloffset=+1]
 [role="_additional-resources"]
 [id="additional-resources_custom-logging-alerts"]
 == Additional resources
-* xref:../../monitoring/monitoring-overview.adoc#about-openshift-monitoring_monitoring-overview[About {product-title} monitoring]
+* xref:../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring_monitoring-overview[About {product-title} monitoring]
 ifdef::openshift-enterprise[]
 * xref:../../post_installation_configuration/configuring-alert-notifications.adoc#configuring-alert-notifications[Configuring alert notifications]
 endif::[]
-// maybe need an update to https://docs.openshift.com/container-platform/4.13/monitoring/monitoring-overview.html#default-monitoring-targets_monitoring-overview to talk about Loki and Vector now? Are these part of default monitoring?
+// maybe need an update to https://docs.openshift.com/container-platform/4.13/observability/monitoring/monitoring-overview.html#default-monitoring-targets_monitoring-overview to talk about Loki and Vector now? Are these part of default monitoring?
diff --git a/logging/logging_alerts/default-logging-alerts.adoc b/logging/logging_alerts/default-logging-alerts.adoc
@@ -18,4 +18,4 @@ include::modules/cluster-logging-elasticsearch-rules.adoc[leveloffset=+1]
 [role="_additional-resources"]
 [id="additional-resources_default-logging-alerts"]
 == Additional resources
-* xref:../../monitoring/managing-alerts.adoc#modifying-core-platform-alerting-rules_managing-alerts[Modifying core platform alerting rules]
+* xref:../../observability/monitoring/managing-alerts.adoc#modifying-core-platform-alerting-rules_managing-alerts[Modifying core platform alerting rules]
diff --git a/logging/troubleshooting/troubleshooting-logging-alerts.adoc b/logging/troubleshooting/troubleshooting-logging-alerts.adoc
@@ -12,7 +12,7 @@ include::modules/es-cluster-health-is-red.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
+* xref:../../observability/monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
 * link:https://www.elastic.co/guide/en/elasticsearch/reference/7.13/fix-common-cluster-issues.html#fix-red-yellow-cluster-status[Fix a red or yellow cluster status]
 
 [id="elasticsearch-cluster-health-is-yellow"]