Skip to content

Commit db8b8c1

Browse files
committed
OBSDOCS-2298: change the structure based on approved template
1 parent 693a4db commit db8b8c1

27 files changed

+58
-40
lines changed

_topic_maps/_topic_map.yml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ Topics:
77
File: about-ocp-monitoring
88
- Name: Monitoring stack architecture
99
File: monitoring-stack-architecture
10+
---
11+
Name: Support for monitoring
12+
Dir: support-for-monitoring
13+
Distros: openshift-monitoring
14+
Topics:
15+
- Name: Maintenance and support for monitoring
16+
File: maintenance-and-support-for-monitoring
17+
---
18+
Name: Monitoring key concepts
19+
Dir: key-concepts
20+
Distros: openshift-monitoring
21+
Topics:
1022
- Name: Key concepts
1123
File: key-concepts
1224
---
@@ -21,8 +33,6 @@ Name: Getting started
2133
Dir: getting-started
2234
Distros: openshift-monitoring
2335
Topics:
24-
- Name: Maintenance and support for monitoring
25-
File: maintenance-and-support-for-monitoring
2636
- Name: Core platform monitoring first steps
2737
File: core-platform-monitoring-first-steps
2838
- Name: User workload monitoring first steps

accessing-metrics/accessing-metrics-as-a-developer.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can access metrics to monitor the performance of your cluster workloads.
1111
[role="_additional-resources"]
1212
.Additional resources
1313

14-
* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
14+
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
1515
1616
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1717
//Viewing a list of available metrics
@@ -32,5 +32,5 @@ include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[level
3232
[role="_additional-resources"]
3333
.Additional resources
3434

35-
* xref:../about-ocp-monitoring/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
35+
* xref:../key-concepts/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
3636
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/building_applications/index#monitoring-project-and-application-metrics-using-developer-perspective[Monitoring project and application metrics using the Developer perspective]

accessing-metrics/accessing-metrics-as-an-administrator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can access metrics to monitor the performance of cluster components and your
1111
[role="_additional-resources"]
1212
.Additional resources
1313

14-
* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
14+
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
1515
1616
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1717
//Viewing a list of available metrics
@@ -35,4 +35,4 @@ include::modules/monitoring-reviewing-monitoring-dashboards-admin.adoc[leveloffs
3535
[role="_additional-resources"]
3636
.Additional resources
3737

38-
* xref:../about-ocp-monitoring/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
38+
* xref:../key-concepts/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]

config-map-reference/config-map-reference-for-the-cluster-monitoring-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The configuration file is always defined under the `config.yaml` key in the conf
3232
====
3333
* Not all configuration parameters for the monitoring stack are exposed.
3434
Only the parameters and fields listed in this reference are supported for configuration.
35-
For more information about supported configurations, see xref:../getting-started/maintenance-and-support-for-monitoring.adoc#maintenance-and-support-for-monitoring[Maintenance and support for monitoring].
35+
For more information about supported configurations, see xref:../support-for-monitoring/maintenance-and-support-for-monitoring.adoc#maintenance-and-support-for-monitoring[Maintenance and support for monitoring].
3636
3737
* Configuring cluster monitoring is optional.
3838
* If a configuration does not exist or is empty, default values are used.

configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ Alertmanager does not send notifications by default. It is strongly recommended
4646
[role="_additional-resources"]
4747
.Additional resources
4848

49-
* xref:../about-ocp-monitoring/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
49+
* xref:../key-concepts/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
5050
* link:https://www.pagerduty.com/[PagerDuty website]
5151
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide (PagerDuty documentation)]
52-
* xref:../getting-started/maintenance-and-support-for-monitoring.adoc#support-version-matrix-for-monitoring-components_maintenance-and-support-for-monitoring[Support version matrix for monitoring components]
52+
* xref:../support-for-monitoring/maintenance-and-support-for-monitoring.adoc#support-version-matrix-for-monitoring-components_maintenance-and-support-for-monitoring[Support version matrix for monitoring components]
5353
* xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-alert-routing-for-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[Enabling alert routing for user-defined projects]
5454

5555
include::modules/monitoring-configuring-alert-routing-default-platform-alerts.adoc[leveloffset=+2]

configuring-core-platform-monitoring/configuring-metrics.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You can send ingested metrics to remote systems for long-term storage and add cl
1313
[role="_additional-resources"]
1414
.Additional resources
1515

16-
* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
16+
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
1717
1818
// Configuring remote write storage
1919
include::modules/monitoring-configuring-remote-write-storage.adoc[leveloffset=+1,tags=**;CPM;!UWM]
@@ -46,5 +46,5 @@ include::modules/monitoring-creating-cluster-id-labels-for-metrics.adoc[leveloff
4646
[role="_additional-resources"]
4747
.Additional resources
4848

49-
* xref:../about-ocp-monitoring/key-concepts.adoc#adding-cluster-id-labels-to-metrics_key-concepts[Adding cluster ID labels to metrics]
49+
* xref:../key-concepts/key-concepts.adoc#adding-cluster-id-labels-to-metrics_key-concepts[Adding cluster ID labels to metrics]
5050
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/support/index#support-get-cluster-id_gathering-cluster-data[Obtaining your cluster ID]

configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can configure the monitoring stack to optimize the performance and scale of
1111
[role="_additional-resources"]
1212
.Additional resources
1313

14-
* xref:../about-ocp-monitoring/key-concepts.adoc#about-performance-and-scalability_key-concepts[About performance and scalability]
14+
* xref:../key-concepts/key-concepts.adoc#about-performance-and-scalability_key-concepts[About performance and scalability]
1515
1616
[id="controlling-placement-and-distribution-of-monitoing-components_{context}"]
1717
== Controlling the placement and distribution of monitoring components
@@ -28,7 +28,7 @@ By controlling placement and distribution of monitoring components, you can opti
2828
[role="_additional-resources"]
2929
.Additional resources
3030

31-
* xref:../about-ocp-monitoring/key-concepts.adoc#using-node-selectors-to-move-monitoring-components_key-concepts[Using node selectors to move monitoring components]
31+
* xref:../key-concepts/key-concepts.adoc#using-node-selectors-to-move-monitoring-components_key-concepts[Using node selectors to move monitoring components]
3232

3333
include::modules/monitoring-moving-monitoring-components-to-different-nodes.adoc[leveloffset=+2,tags=**;CPM;!UWM]
3434

@@ -69,7 +69,7 @@ include::modules/monitoring-specifying-limits-and-requests-for-monitoring-compon
6969
[role="_additional-resources"]
7070
.Additional resources
7171

72-
* xref:../about-ocp-monitoring/key-concepts.adoc#about-specifying-limits-and-requests-for-monitoring-components_key-concepts[About specifying limits and requests]
72+
* xref:../key-concepts/key-concepts.adoc#about-specifying-limits-and-requests-for-monitoring-components_key-concepts[About specifying limits and requests]
7373
* link:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits[Requests and limits (Kubernetes documentation)]
7474

7575
// Choosing a metrics collection profile
@@ -78,7 +78,7 @@ include::modules/monitoring-choosing-a-metrics-collection-profile.adoc[leveloffs
7878
[role="_additional-resources"]
7979
.Additional resources
8080

81-
* xref:../about-ocp-monitoring/key-concepts.adoc#configuring-metrics-collection-profiles_key-concepts[About metrics collection profiles]
81+
* xref:../key-concepts/key-concepts.adoc#configuring-metrics-collection-profiles_key-concepts[About metrics collection profiles]
8282
* xref:../accessing-metrics/accessing-metrics-as-an-administrator.adoc#viewing-a-list-of-available-metrics_accessing-metrics-as-an-administrator[Viewing a list of available metrics]
8383
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/nodes/index#nodes-cluster-enabling[Enabling features using feature gates]
8484

@@ -88,6 +88,6 @@ include::modules/monitoring-configuring-pod-topology-spread-constraints.adoc[lev
8888
[role="_additional-resources"]
8989
.Additional resources
9090

91-
* xref:../about-ocp-monitoring/key-concepts.adoc#using-pod-topology-spread-constraints-for-monitoring_key-concepts[About pod topology spread constraints for monitoring]
91+
* xref:../key-concepts/key-concepts.adoc#using-pod-topology-spread-constraints-for-monitoring_key-concepts[About pod topology spread constraints for monitoring]
9292
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/nodes/index#nodes-scheduler-pod-topology-spread-constraints[Controlling pod placement by using pod topology spread constraints]
9393
* link:https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/[Pod topology spread constraints (Kubernetes documentation)]

configuring-core-platform-monitoring/storing-and-recording-data.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ include::modules/monitoring-modifying-retention-time-and-size-for-prometheus-met
3434
[role="_additional-resources"]
3535
.Additional resources
3636

37-
* xref:../about-ocp-monitoring/key-concepts.adoc#retention-time-and-size-for-prometheus-metrics-data_key-concepts[Retention time and size for Prometheus metrics]
37+
* xref:../key-concepts/key-concepts.adoc#retention-time-and-size-for-prometheus-metrics-data_key-concepts[Retention time and size for Prometheus metrics]
3838
* xref:../configuring-core-platform-monitoring/preparing-to-configure-the-monitoring-stack.adoc#preparing-to-configure-the-monitoring-stack[Preparing to configure core platform monitoring stack]
3939
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/scalability_and_performance/index#prometheus-database-storage-requirements_recommended-infrastructure-practices[Prometheus database storage requirements]
4040
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/scalability_and_performance/index#recommended-configurable-storage-technology_persistent-storage[Recommended configurable storage technology]

configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ Review the following limitations of alert routing for user-defined projects:
5454
[role="_additional-resources"]
5555
.Additional resources
5656

57-
* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-alert-routing-for-user-defined-projects_key-concepts[Understanding alert routing for user-defined projects]
58-
* xref:../about-ocp-monitoring/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
57+
* xref:../key-concepts/key-concepts.adoc#understanding-alert-routing-for-user-defined-projects_key-concepts[Understanding alert routing for user-defined projects]
58+
* xref:../key-concepts/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
5959
* link:https://www.pagerduty.com/[PagerDuty website]
6060
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide (PagerDuty documentation)]
61-
* xref:../getting-started/maintenance-and-support-for-monitoring.adoc#support-version-matrix-for-monitoring-components_maintenance-and-support-for-monitoring[Support version matrix for monitoring components]
61+
* xref:../support-for-monitoring/maintenance-and-support-for-monitoring.adoc#support-version-matrix-for-monitoring-components_maintenance-and-support-for-monitoring[Support version matrix for monitoring components]
6262
* xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-alert-routing-for-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[Enabling alert routing for user-defined projects]
6363
6464
include::modules/monitoring-configuring-alert-routing-for-user-defined-projects.adoc[leveloffset=+2]

configuring-user-workload-monitoring/configuring-metrics-uwm.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You can send ingested metrics to remote systems for long-term storage and add cl
1313
[role="_additional-resources"]
1414
.Additional resources
1515

16-
* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
16+
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
1717
1818
// Configuring remote write storage
1919
include::modules/monitoring-configuring-remote-write-storage.adoc[leveloffset=+1,tags=**;!CPM;UWM]
@@ -48,7 +48,7 @@ include::modules/monitoring-creating-cluster-id-labels-for-metrics.adoc[leveloff
4848
[role="_additional-resources"]
4949
.Additional resources
5050

51-
* xref:../about-ocp-monitoring/key-concepts.adoc#adding-cluster-id-labels-to-metrics_key-concepts[Adding cluster ID labels to metrics]
51+
* xref:../key-concepts/key-concepts.adoc#adding-cluster-id-labels-to-metrics_key-concepts[Adding cluster ID labels to metrics]
5252
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/support/index#support-get-cluster-id_gathering-cluster-data[Obtaining your cluster ID]
5353
5454
// Setting up metrics collection for user-defined projects

0 commit comments

Comments
 (0)