Skip to content

Commit 43af5ee

Browse files
authored
Merge pull request #74104 from eromanova97/OBSDOCS-692
OBSDOCS-692: Update Monitoring doc links and topic map position
2 parents fa52356 + 185b400 commit 43af5ee

File tree

191 files changed

+371
-365
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+371
-365
lines changed

_topic_maps/_topic_map.yml

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2595,6 +2595,41 @@ Distros: openshift-enterprise,openshift-origin
25952595
Topics:
25962596
- Name: Observability overview
25972597
File: index
2598+
- Name: Monitoring
2599+
Dir: monitoring
2600+
Distros: openshift-enterprise,openshift-origin
2601+
Topics:
2602+
- Name: Monitoring overview
2603+
File: monitoring-overview
2604+
- Name: Configuring the monitoring stack
2605+
File: configuring-the-monitoring-stack
2606+
- Name: Enabling monitoring for user-defined projects
2607+
File: enabling-monitoring-for-user-defined-projects
2608+
- Name: Enabling alert routing for user-defined projects
2609+
File: enabling-alert-routing-for-user-defined-projects
2610+
- Name: Managing metrics
2611+
File: managing-metrics
2612+
- Name: Managing alerts
2613+
File: managing-alerts
2614+
- Name: Reviewing monitoring dashboards
2615+
File: reviewing-monitoring-dashboards
2616+
- Name: Accessing monitoring APIs by using the CLI
2617+
File: accessing-third-party-monitoring-apis
2618+
- Name: Troubleshooting monitoring issues
2619+
File: troubleshooting-monitoring-issues
2620+
- Name: Config map reference for the Cluster Monitoring Operator
2621+
File: config-map-reference-for-the-cluster-monitoring-operator
2622+
- Name: Cluster Observability Operator
2623+
Dir: cluster_observability_operator
2624+
Topics:
2625+
- Name: Cluster Observability Operator release notes
2626+
File: cluster-observability-operator-release-notes
2627+
- Name: Cluster Observability Operator overview
2628+
File: cluster-observability-operator-overview
2629+
- Name: Installing the Cluster Observability Operator
2630+
File: installing-the-cluster-observability-operator
2631+
- Name: Configuring the Cluster Observability Operator to monitor a service
2632+
File: configuring-the-cluster-observability-operator-to-monitor-a-service
25982633
- Name: Distributed tracing
25992634
Dir: distr_tracing
26002635
Distros: openshift-enterprise
@@ -2831,42 +2866,6 @@ Topics:
28312866
- Name: Glossary
28322867
File: logging-common-terms
28332868
---
2834-
Name: Monitoring
2835-
Dir: monitoring
2836-
Distros: openshift-enterprise,openshift-origin
2837-
Topics:
2838-
- Name: Monitoring overview
2839-
File: monitoring-overview
2840-
- Name: Configuring the monitoring stack
2841-
File: configuring-the-monitoring-stack
2842-
- Name: Enabling monitoring for user-defined projects
2843-
File: enabling-monitoring-for-user-defined-projects
2844-
- Name: Enabling alert routing for user-defined projects
2845-
File: enabling-alert-routing-for-user-defined-projects
2846-
- Name: Managing metrics
2847-
File: managing-metrics
2848-
- Name: Managing alerts
2849-
File: managing-alerts
2850-
- Name: Reviewing monitoring dashboards
2851-
File: reviewing-monitoring-dashboards
2852-
- Name: Accessing monitoring APIs by using the CLI
2853-
File: accessing-third-party-monitoring-apis
2854-
- Name: Troubleshooting monitoring issues
2855-
File: troubleshooting-monitoring-issues
2856-
- Name: Config map reference for the Cluster Monitoring Operator
2857-
File: config-map-reference-for-the-cluster-monitoring-operator
2858-
- Name: Cluster Observability Operator
2859-
Dir: cluster_observability_operator
2860-
Topics:
2861-
- Name: Cluster Observability Operator release notes
2862-
File: cluster-observability-operator-release-notes
2863-
- Name: Cluster Observability Operator overview
2864-
File: cluster-observability-operator-overview
2865-
- Name: Installing the Cluster Observability Operator
2866-
File: installing-the-cluster-observability-operator
2867-
- Name: Configuring the Cluster Observability Operator to monitor a service
2868-
File: configuring-the-cluster-observability-operator-to-monitor-a-service
2869-
---
28702869
Name: Scalability and performance
28712870
Dir: scalability_and_performance
28722871
Distros: openshift-origin,openshift-enterprise,openshift-webscale,openshift-dpu

_topic_maps/_topic_map_osd.yml

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1254,32 +1254,36 @@ Topics:
12541254
- Name: Glossary
12551255
File: logging-common-terms
12561256
---
1257-
Name: Monitoring
1258-
Dir: monitoring
1257+
Name: Observability
1258+
Dir: observability
12591259
Distros: openshift-dedicated
12601260
Topics:
1261-
- Name: Monitoring overview
1262-
File: monitoring-overview
1263-
- Name: Accessing monitoring for user-defined projects
1264-
File: sd-accessing-monitoring-for-user-defined-projects
1265-
- Name: Configuring the monitoring stack
1266-
File: configuring-the-monitoring-stack
1267-
- Name: Disabling monitoring for user-defined projects
1268-
File: sd-disabling-monitoring-for-user-defined-projects
1269-
- Name: Enabling alert routing for user-defined projects
1270-
File: enabling-alert-routing-for-user-defined-projects
1271-
- Name: Managing metrics
1272-
File: managing-metrics
1273-
- Name: Managing alerts
1274-
File: managing-alerts
1275-
- Name: Reviewing monitoring dashboards
1276-
File: reviewing-monitoring-dashboards
1277-
- Name: Accessing third-party monitoring APIs
1278-
File: accessing-third-party-monitoring-apis
1279-
- Name: Troubleshooting monitoring issues
1280-
File: troubleshooting-monitoring-issues
1281-
- Name: Config map reference for the Cluster Monitoring Operator
1282-
File: config-map-reference-for-the-cluster-monitoring-operator
1261+
- Name: Monitoring
1262+
Dir: monitoring
1263+
Distros: openshift-dedicated
1264+
Topics:
1265+
- Name: Monitoring overview
1266+
File: monitoring-overview
1267+
- Name: Accessing monitoring for user-defined projects
1268+
File: sd-accessing-monitoring-for-user-defined-projects
1269+
- Name: Configuring the monitoring stack
1270+
File: configuring-the-monitoring-stack
1271+
- Name: Disabling monitoring for user-defined projects
1272+
File: sd-disabling-monitoring-for-user-defined-projects
1273+
- Name: Enabling alert routing for user-defined projects
1274+
File: enabling-alert-routing-for-user-defined-projects
1275+
- Name: Managing metrics
1276+
File: managing-metrics
1277+
- Name: Managing alerts
1278+
File: managing-alerts
1279+
- Name: Reviewing monitoring dashboards
1280+
File: reviewing-monitoring-dashboards
1281+
- Name: Accessing third-party monitoring APIs
1282+
File: accessing-third-party-monitoring-apis
1283+
- Name: Troubleshooting monitoring issues
1284+
File: troubleshooting-monitoring-issues
1285+
- Name: Config map reference for the Cluster Monitoring Operator
1286+
File: config-map-reference-for-the-cluster-monitoring-operator
12831287
---
12841288
Name: Service Mesh
12851289
Dir: service_mesh

_topic_maps/_topic_map_rosa.yml

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1497,32 +1497,36 @@ Topics:
14971497
- Name: Glossary
14981498
File: logging-common-terms
14991499
---
1500-
Name: Monitoring
1501-
Dir: monitoring
1500+
Name: Observability
1501+
Dir: observability
15021502
Distros: openshift-rosa
15031503
Topics:
1504-
- Name: Monitoring overview
1505-
File: monitoring-overview
1506-
- Name: Accessing monitoring for user-defined projects
1507-
File: sd-accessing-monitoring-for-user-defined-projects
1508-
- Name: Configuring the monitoring stack
1509-
File: configuring-the-monitoring-stack
1510-
- Name: Disabling monitoring for user-defined projects
1511-
File: sd-disabling-monitoring-for-user-defined-projects
1512-
- Name: Enabling alert routing for user-defined projects
1513-
File: enabling-alert-routing-for-user-defined-projects
1514-
- Name: Managing metrics
1515-
File: managing-metrics
1516-
- Name: Managing alerts
1517-
File: managing-alerts
1518-
- Name: Reviewing monitoring dashboards
1519-
File: reviewing-monitoring-dashboards
1520-
- Name: Accessing third-party monitoring APIs
1521-
File: accessing-third-party-monitoring-apis
1522-
- Name: Troubleshooting monitoring issues
1523-
File: troubleshooting-monitoring-issues
1524-
- Name: Config map reference for the Cluster Monitoring Operator
1525-
File: config-map-reference-for-the-cluster-monitoring-operator
1504+
- Name: Monitoring
1505+
Dir: monitoring
1506+
Distros: openshift-rosa
1507+
Topics:
1508+
- Name: Monitoring overview
1509+
File: monitoring-overview
1510+
- Name: Accessing monitoring for user-defined projects
1511+
File: sd-accessing-monitoring-for-user-defined-projects
1512+
- Name: Configuring the monitoring stack
1513+
File: configuring-the-monitoring-stack
1514+
- Name: Disabling monitoring for user-defined projects
1515+
File: sd-disabling-monitoring-for-user-defined-projects
1516+
- Name: Enabling alert routing for user-defined projects
1517+
File: enabling-alert-routing-for-user-defined-projects
1518+
- Name: Managing metrics
1519+
File: managing-metrics
1520+
- Name: Managing alerts
1521+
File: managing-alerts
1522+
- Name: Reviewing monitoring dashboards
1523+
File: reviewing-monitoring-dashboards
1524+
- Name: Accessing third-party monitoring APIs
1525+
File: accessing-third-party-monitoring-apis
1526+
- Name: Troubleshooting monitoring issues
1527+
File: troubleshooting-monitoring-issues
1528+
- Name: Config map reference for the Cluster Monitoring Operator
1529+
File: config-map-reference-for-the-cluster-monitoring-operator
15261530
---
15271531
Name: Service Mesh
15281532
Dir: service_mesh

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ include::modules/odc-monitoring-your-app-vulnerabilities.adoc[leveloffset=+1]
3131
[role="_additional-resources"]
3232
[id="additional-resources-odc-monitoring-project-and-application-metrics-using-developer-perspective"]
3333
== Additional resources
34-
* xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
34+
* xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]

backup_and_restore/application_backup_and_restore/troubleshooting.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,14 +99,14 @@ include::modules/migration-combining-must-gather.adoc[leveloffset=+2]
9999
include::modules/oadp-monitoring.adoc[leveloffset=+1]
100100
[role="_additional-resources"]
101101
.Additional resources
102-
* xref:../../monitoring/monitoring-overview.adoc#about-openshift-monitoring[Monitoring stack]
102+
* xref:../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[Monitoring stack]
103103

104104
include::modules/oadp-monitoring-setup.adoc[leveloffset=+2]
105105
include::modules/oadp-creating-service-monitor.adoc[leveloffset=+2]
106106
include::modules/oadp-creating-alerting-rule.adoc[leveloffset=+2]
107107
[role="_additional-resources"]
108108
.Additional resources
109-
* xref:../../monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]
109+
* xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]
110110

111111
include::modules/oadp-list-of-metrics.adoc[leveloffset=+2]
112112
include::modules/oadp-viewing-metrics-ui.adoc[leveloffset=+2]

cicd/gitops/monitoring-argo-cd-custom-resource-workloads.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can enable and disable the setting for monitoring Argo CD custom resource wo
1919
* {gitops-title} is installed in your cluster.
2020
* 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.
2121
* The `kube-state-metrics` service is running in your cluster.
22-
* 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.
22+
* 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.
2323
+
2424
[NOTE]
2525
====
@@ -35,4 +35,4 @@ include::modules/gitops-disabling-monitoring-for-argo-cd-custom-resource-workloa
3535
[role="_additional-resources"]
3636
[id="additional-resources_monitoring-argo-cd-custom-resource-workloads"]
3737
== Additional resources
38-
* xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
38+
* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]

cicd/pipelines/creating-applications-with-cicd-pipelines.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ include::modules/op-enabling-monitoring-of-event-listeners-for-triggers-for-user
6868
[role="_additional-resources"]
6969
.Additional resources
7070

71-
* xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
71+
* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
7272

7373
include::modules/op-configuring-pull-request-capabilities-in-GitHub-interceptor.adoc[leveloffset=+1]
7474

getting_started/openshift-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ be reviewed by cluster administrators and xref:../operators/admin/olm-adding-ope
108108

109109
* **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.
110110

111-
* **xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitor clusters]**:
112-
Learn to xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack].
113-
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.
111+
* **xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitor clusters]**:
112+
Learn to xref:../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack].
113+
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.
114114

115115
* **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-preparing.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ For a production cluster, you must configure the following integrations:
109109

110110
* xref:../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Persistent storage]
111111
* xref:../authentication/understanding-identity-provider.adoc#understanding-identity-provider[An identity provider]
112-
* xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Monitoring core OpenShift Container Platform components]
112+
* xref:../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Monitoring core OpenShift Container Platform components]
113113

114114
[id="installing-preparing-cluster-for-workloads"]
115115
== Preparing your cluster for workloads
116116

117-
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.
117+
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.
118118
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.
119119

120120
[id="supported-installation-methods-for-different-platforms"]

installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ include::modules/vsphere-problem-detector-metrics.adoc[leveloffset=+1]
3030
[role="_additional-resources"]
3131
== Additional resources
3232

33-
* xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
33+
* xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]

0 commit comments

Comments
 (0)