Merge pull request #88454 from eromanova97/monitoring-docs-restructure-integration

Monitoring docs restructure integration

Author: gabriel-rh

_topic_maps/_topic_map.yml

@@ -2905,26 +2905,68 @@ Topics:
   Dir: monitoring
   Distros: openshift-enterprise,openshift-origin
   Topics:
-  - Name: Monitoring overview
-    File: monitoring-overview
-  - Name: Common monitoring configuration scenarios
-    File: common-monitoring-configuration-scenarios
-  - 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: About OpenShift Container Platform monitoring
+    Dir: about-ocp-monitoring
+    Topics:
+    - Name: About OpenShift Container Platform monitoring
+      File: about-ocp-monitoring
+    - Name: Monitoring stack architecture
+      File: monitoring-stack-architecture
+    - Name: Key concepts
+      File: key-concepts
+  - Name: Getting started
+    Dir: getting-started
+    Topics:
+    - Name: Maintenance and support for monitoring
+      File: maintenance-and-support-for-monitoring
+    - Name: Core platform monitoring first steps
+      File: core-platform-monitoring-first-steps
+    - Name: User workload monitoring first steps
+      File: user-workload-monitoring-first-steps
+    - Name: Developer and non-administrator steps
+      File: developer-and-non-administrator-steps
+  - Name: Configuring core platform monitoring
+    Dir: configuring-core-platform-monitoring
+    Topics:
+    - Name: Preparing to configure the monitoring stack
+      File: preparing-to-configure-the-monitoring-stack
+    - Name: Configuring performance and scalability
+      File: configuring-performance-and-scalability
+    - Name: Storing and recording data
+      File: storing-and-recording-data
+    - Name: Configuring metrics
+      File: configuring-metrics
+    - Name: Configuring alerts and notifications
+      File: configuring-alerts-and-notifications
+  - Name: Configuring user workload monitoring
+    Dir: configuring-user-workload-monitoring
+    Topics:
+    - Name: Preparing to configure the monitoring stack
+      File: preparing-to-configure-the-monitoring-stack-uwm
+    - Name: Configuring performance and scalability
+      File: configuring-performance-and-scalability-uwm
+    - Name: Storing and recording data
+      File: storing-and-recording-data-uwm
+    - Name: Configuring metrics
+      File: configuring-metrics-uwm
+    - Name: Configuring alerts and notifications
+      File: configuring-alerts-and-notifications-uwm
+  - Name: Accessing metrics
+    Dir: accessing-metrics
+    Topics:
+    - Name: Accessing metrics as an administrator
+      File: accessing-metrics-as-an-administrator
+    - Name: Accessing metrics as a developer
+      File: accessing-metrics-as-a-developer
+    - Name: Accessing monitoring APIs by using the CLI
+      File: accessing-monitoring-apis-by-using-the-cli
   - Name: Managing alerts
-    File: managing-alerts
-  - Name: Reviewing monitoring dashboards
-    File: reviewing-monitoring-dashboards
-  - Name: Monitoring clusters that run on RHOSO
-    File: shiftstack-prometheus-configuration
-  - Name: Accessing monitoring APIs by using the CLI
-    File: accessing-third-party-monitoring-apis
+    Dir: managing-alerts
+    Topics:
+    - Name: Managing alerts as an administrator
+      File: managing-alerts-as-an-administrator
+    - Name: Managing alerts as a developer
+      File: managing-alerts-as-a-developer
   - Name: Troubleshooting monitoring issues
     File: troubleshooting-monitoring-issues
   - Name: Config map reference for the Cluster Monitoring Operator

applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc

@@ -31,4 +31,9 @@ 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
+ifdef::openshift-rosa,openshift-dedicated[]
 * xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
+endif::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-dedicated[]
+* xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]
+endif::openshift-rosa,openshift-dedicated[]

backup_and_restore/application_backup_and_restore/troubleshooting.adoc

@@ -145,14 +145,14 @@ include::modules/migration-combining-must-gather.adoc[leveloffset=+2]
 include::modules/oadp-monitoring.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
-* xref:../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[Monitoring stack]
+* xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]
 
 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:../../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]
+* xref:../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[Managing alerts as an Administrator]
 
 include::modules/oadp-list-of-metrics.adoc[leveloffset=+2]
 include::modules/oadp-viewing-metrics-ui.adoc[leveloffset=+2]

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:../../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.
+* 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/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[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:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
+* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]

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:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
+* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
 
 include::modules/op-configuring-pull-request-capabilities-in-GitHub-interceptor.adoc[leveloffset=+1]
 

edge_computing/day_2_core_cnf_clusters/observability/telco-observability.adoc

@@ -18,16 +18,16 @@ include::modules/telco-observability-monitoring-stack.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../observability/monitoring/monitoring-overview.adoc#understanding-the-monitoring-stack_monitoring-overview[Understanding the monitoring stack]
+* xref:../../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]
 
-* xref:../../../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Configuring the monitoring stack]
+* xref:../../../observability/monitoring/getting-started/core-platform-monitoring-first-steps.adoc#core-platform-monitoring-first-steps[Core platform monitoring first steps]
 
 include::modules/telco-observability-key-performance-metrics.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../observability/monitoring/managing-metrics.adoc#managing-metrics[Managing metrics]
+* xref:../../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#accessing-metrics-as-an-administrator[Accessing metrics as an administrator]
 * xref:../../../storage/persistent_storage/persistent_storage_local/persistent-storage-local.adoc#local-storage-install_persistent-storage-local[Persistent storage using local volumes]
 * xref:../../../scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#cluster-tuning-crs_ran-ref-design-crs[Cluster tuning reference CRs]
 
@@ -38,7 +38,7 @@ include::modules/telco-observability-alerting.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]
+* xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#about-managing-alerts_key-concepts[Managing alerts]
 
 include::modules/telco-observability-workload-monitoring.adoc[leveloffset=+1]
 
@@ -47,6 +47,7 @@ include::modules/telco-observability-workload-monitoring.adoc[leveloffset=+1]
 
 * xref:../../../rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[ServiceMonitor[monitoring.coreos.com/v1]]
 
-* xref:../../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
+* xref:../../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
+
+* xref:../../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerting-rules-for-user-defined-projects_managing-alerts-as-an-administrator[Managing alerting rules for user-defined projects]
 
-* xref:../../../observability/monitoring/managing-alerts.adoc#managing-alerting-rules-for-user-defined-projects_managing-alerts[Managing alerting rules for user-defined projects]

getting_started/openshift-overview.adoc

@@ -106,10 +106,10 @@ be reviewed by cluster administrators and xref:../operators/admin/olm-adding-ope
 
 * **xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-infrastructure-practices.adoc#scaling-cluster-monitoring-operator[Scale] and xref:../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[tune] clusters**: Set cluster limits, tune nodes, scale cluster monitoring, and optimize networking, storage, and routes for your environment.
 
-* **xref:../disconnected/updating/disconnected-update-osus.adoc#update-service-overview_updating-disconnected-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:../disconnected/updating/disconnected-update-osus.adoc#update-service-overview_updating-disconnected-cluster-osus[Using the OpenShift Update Service in a disconnected environment]**: Learn about installing and managing a local OpenShift Update Service for recommending {product-title} updates in disconnected environments.
 
-* **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:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[Monitor clusters]**:
+Learn to  xref:../observability/monitoring/getting-started/core-platform-monitoring-first-steps.adoc#core-platform-monitoring-first-steps[configure the monitoring stack].
+After configuring monitoring, use the web console to access xref:../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#reviewing-monitoring-dashboards-admin_accessing-metrics-as-an-administrator[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].

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:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
+* xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]

installing/overview/installing-preparing.adoc

@@ -110,12 +110,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:../../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Monitoring core OpenShift Container Platform components]
+* xref:../../observability/monitoring/getting-started/core-platform-monitoring-first-steps.adoc#core-platform-monitoring-first-steps[Monitoring core {product-title} 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-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-low-latency-perf-profile[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.
+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-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-low-latency-perf-profile[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/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[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"]

installing/validation_and_troubleshooting/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:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack.
+* See xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] 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:../../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts] for further details about alerting in {product-title}.
+* See xref:../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[Managing alerts as an Administrator] for further details about alerting in {product-title}.
 
 [id="validating-an-installation-next-steps"]
 == Next steps