Skip to content

OBSDOCS-2298: change the structure based on approved template #97460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@ Topics:
File: about-ocp-monitoring
- Name: Monitoring stack architecture
File: monitoring-stack-architecture
---
Name: Support for monitoring
Dir: support-for-monitoring
Distros: openshift-monitoring
Topics:
- Name: Maintenance and support for monitoring
File: maintenance-and-support-for-monitoring
---
Name: Monitoring key concepts
Dir: key-concepts
Distros: openshift-monitoring
Topics:
- Name: Key concepts
File: key-concepts
---
Expand All @@ -21,8 +33,6 @@ Name: Getting started
Dir: getting-started
Distros: openshift-monitoring
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
Expand Down
4 changes: 2 additions & 2 deletions accessing-metrics/accessing-metrics-as-a-developer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can access metrics to monitor the performance of your cluster workloads.
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]

ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
//Viewing a list of available metrics
Expand All @@ -32,5 +32,5 @@ include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[level
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
* xref:../key-concepts/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
* 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]
4 changes: 2 additions & 2 deletions accessing-metrics/accessing-metrics-as-an-administrator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can access metrics to monitor the performance of cluster components and your
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]

ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
//Viewing a list of available metrics
Expand All @@ -35,4 +35,4 @@ include::modules/monitoring-reviewing-monitoring-dashboards-admin.adoc[leveloffs
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
* xref:../key-concepts/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The configuration file is always defined under the `config.yaml` key in the conf
====
* Not all configuration parameters for the monitoring stack are exposed.
Only the parameters and fields listed in this reference are supported for configuration.
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].
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].

* Configuring cluster monitoring is optional.
* If a configuration does not exist or is empty, default values are used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ Alertmanager does not send notifications by default. It is strongly recommended
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
* xref:../key-concepts/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
* link:https://www.pagerduty.com/[PagerDuty website]
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide (PagerDuty documentation)]
* 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]
* 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]
* 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]

include::modules/monitoring-configuring-alert-routing-default-platform-alerts.adoc[leveloffset=+2]
Expand Down
4 changes: 2 additions & 2 deletions configuring-core-platform-monitoring/configuring-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can send ingested metrics to remote systems for long-term storage and add cl
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]

// Configuring remote write storage
include::modules/monitoring-configuring-remote-write-storage.adoc[leveloffset=+1,tags=**;CPM;!UWM]
Expand Down Expand Up @@ -46,5 +46,5 @@ include::modules/monitoring-creating-cluster-id-labels-for-metrics.adoc[leveloff
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#adding-cluster-id-labels-to-metrics_key-concepts[Adding cluster ID labels to metrics]
* xref:../key-concepts/key-concepts.adoc#adding-cluster-id-labels-to-metrics_key-concepts[Adding cluster ID labels to metrics]
* 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]
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can configure the monitoring stack to optimize the performance and scale of
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#about-performance-and-scalability_key-concepts[About performance and scalability]
* xref:../key-concepts/key-concepts.adoc#about-performance-and-scalability_key-concepts[About performance and scalability]

[id="controlling-placement-and-distribution-of-monitoing-components_{context}"]
== Controlling the placement and distribution of monitoring components
Expand All @@ -28,7 +28,7 @@ By controlling placement and distribution of monitoring components, you can opti
[role="_additional-resources"]
.Additional resources

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

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

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

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

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

* xref:../about-ocp-monitoring/key-concepts.adoc#configuring-metrics-collection-profiles_key-concepts[About metrics collection profiles]
* xref:../key-concepts/key-concepts.adoc#configuring-metrics-collection-profiles_key-concepts[About metrics collection profiles]
* 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]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/nodes/index#nodes-cluster-enabling[Enabling features using feature gates]

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

* xref:../about-ocp-monitoring/key-concepts.adoc#using-pod-topology-spread-constraints-for-monitoring_key-concepts[About pod topology spread constraints for monitoring]
* xref:../key-concepts/key-concepts.adoc#using-pod-topology-spread-constraints-for-monitoring_key-concepts[About pod topology spread constraints for monitoring]
* 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]
* link:https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/[Pod topology spread constraints (Kubernetes documentation)]
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ include::modules/monitoring-modifying-retention-time-and-size-for-prometheus-met
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#retention-time-and-size-for-prometheus-metrics-data_key-concepts[Retention time and size for Prometheus metrics]
* xref:../key-concepts/key-concepts.adoc#retention-time-and-size-for-prometheus-metrics-data_key-concepts[Retention time and size for Prometheus metrics]
* 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]
* 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]
* 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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ Review the following limitations of alert routing for user-defined projects:
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-alert-routing-for-user-defined-projects_key-concepts[Understanding alert routing for user-defined projects]
* xref:../about-ocp-monitoring/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
* xref:../key-concepts/key-concepts.adoc#understanding-alert-routing-for-user-defined-projects_key-concepts[Understanding alert routing for user-defined projects]
* xref:../key-concepts/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
* link:https://www.pagerduty.com/[PagerDuty website]
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide (PagerDuty documentation)]
* 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]
* 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]
* 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]

include::modules/monitoring-configuring-alert-routing-for-user-defined-projects.adoc[leveloffset=+2]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can send ingested metrics to remote systems for long-term storage and add cl
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]

// Configuring remote write storage
include::modules/monitoring-configuring-remote-write-storage.adoc[leveloffset=+1,tags=**;!CPM;UWM]
Expand Down Expand Up @@ -48,7 +48,7 @@ include::modules/monitoring-creating-cluster-id-labels-for-metrics.adoc[leveloff
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#adding-cluster-id-labels-to-metrics_key-concepts[Adding cluster ID labels to metrics]
* xref:../key-concepts/key-concepts.adoc#adding-cluster-id-labels-to-metrics_key-concepts[Adding cluster ID labels to metrics]
* 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]

// Setting up metrics collection for user-defined projects
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ By controlling placement and distribution of monitoring components, you can opti
[role="_additional-resources"]
.Additional resources

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

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

Expand Down Expand Up @@ -59,7 +59,7 @@ include::modules/monitoring-specifying-limits-and-requests-for-monitoring-compon

[role="_additional-resources"]
.Additional resources
* xref:../about-ocp-monitoring/key-concepts.adoc#about-specifying-limits-and-requests-for-monitoring-components_key-concepts[About specifying limits and requests for monitoring components]
* xref:../key-concepts/key-concepts.adoc#about-specifying-limits-and-requests-for-monitoring-components_key-concepts[About specifying limits and requests for monitoring components]
* link:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits[Requests and limits (Kubernetes documentation)]

[id="controlling-the-impact-of-unbound-attributes-in-user-defined-projects_{context}"]
Expand Down Expand Up @@ -88,7 +88,7 @@ Limiting scrape samples can help prevent the issues caused by adding many unboun
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#controlling-the-impact-of-unbound-attributes-in-user-defined-projects_key-concepts[Controlling the impact of unbound metrics attributes in user-defined projects]
* xref:../key-concepts/key-concepts.adoc#controlling-the-impact-of-unbound-attributes-in-user-defined-projects_key-concepts[Controlling the impact of unbound metrics attributes in user-defined projects]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* xref:../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]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
Expand All @@ -106,7 +106,7 @@ include::modules/monitoring-configuring-pod-topology-spread-constraints.adoc[lev
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#using-pod-topology-spread-constraints-for-monitoring_key-concepts[About pod topology spread constraints for monitoring]
* xref:../key-concepts/key-concepts.adoc#using-pod-topology-spread-constraints-for-monitoring_key-concepts[About pod topology spread constraints for monitoring]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* 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]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ include::modules/monitoring-enabling-alert-routing-for-user-defined-projects.ado
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-alert-routing-for-user-defined-projects_key-concepts[Understanding alert routing for user-defined projects]
* xref:../key-concepts/key-concepts.adoc#understanding-alert-routing-for-user-defined-projects_key-concepts[Understanding alert routing for user-defined projects]

// Enabling the platform Alertmanager instance for user-defined alert routing
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ include::modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metric
[role="_additional-resources"]
.Additional resources

* xref:../about-ocp-monitoring/key-concepts.adoc#retention-time-and-size-for-prometheus-metrics-data_key-concepts[Retention time and size for Prometheus metrics]
* xref:../key-concepts/key-concepts.adoc#retention-time-and-size-for-prometheus-metrics-data_key-concepts[Retention time and size for Prometheus metrics]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/storage/index#understanding-persistent-storage[Understanding persistent storage]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* xref:../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]
Expand Down
1 change: 1 addition & 0 deletions key-concepts/_attributes
1 change: 1 addition & 0 deletions key-concepts/images
File renamed without changes.
1 change: 1 addition & 0 deletions key-concepts/modules
1 change: 1 addition & 0 deletions key-concepts/snippets
Loading