From 4a5170c107e607e05b347930910d06b22a793019 Mon Sep 17 00:00:00 2001 From: Eliska Romanova Date: Fri, 16 May 2025 12:24:02 +0200 Subject: [PATCH] Move ROSA distribution to the new monitoirng structure --- _topic_maps/_topic_map_rosa.yml | 56 +++++++++++++------ ...n-metrics-using-developer-perspective.adoc | 9 +-- .../machine-config-daemon-metrics.adoc | 8 +-- .../logging_alerts/custom-logging-alerts.adoc | 8 +-- .../default-logging-alerts.adoc | 5 +- .../troubleshooting-logging-alerts.adoc | 8 +-- .../about-ocp-monitoring/key-concepts.adoc | 25 +++++++-- .../monitoring-stack-architecture.adoc | 7 +++ .../accessing-metrics-as-a-developer.adoc | 2 + ...accessing-metrics-as-an-administrator.adoc | 2 + ...sing-monitoring-apis-by-using-the-cli.adoc | 2 + ...e-for-the-cluster-monitoring-operator.adoc | 7 ++- ...figuring-alerts-and-notifications-uwm.adoc | 16 ++++++ .../configuring-metrics-uwm.adoc | 11 +++- ...uring-performance-and-scalability-uwm.adoc | 13 +++++ ...to-configure-the-monitoring-stack-uwm.adoc | 16 +++++- .../storing-and-recording-data-uwm.adoc | 12 ++-- ...aintenance-and-support-for-monitoring.adoc | 32 +++++++++-- ...aintenance-and-support-for-monitoring.adoc | 1 + .../managing-alerts-as-a-developer.adoc | 7 +++ .../managing-alerts-as-an-administrator.adoc | 12 +++- .../troubleshooting-monitoring-issues.adoc | 8 +-- observability/overview/index.adoc | 8 +-- .../osdk-monitoring-prometheus.adoc | 7 ++- .../rosa-getting-started.adoc | 7 ++- .../rosa-quickstart-guide-ui.adoc | 7 ++- rosa_release_notes/rosa-release-notes.adoc | 8 ++- .../about-remote-health-monitoring.adoc | 11 ++-- .../investigating-monitoring-issues.adoc | 16 +++--- virt/monitoring/virt-monitoring-overview.adoc | 8 +-- virt/monitoring/virt-prometheus-queries.adoc | 8 +-- virt/monitoring/virt-runbooks.adoc | 8 +-- virt/support/virt-collecting-virt-data.adoc | 26 ++++++--- welcome/about-hcp.adoc | 8 ++- 34 files changed, 282 insertions(+), 107 deletions(-) create mode 120000 observability/monitoring/maintenance-and-support-for-monitoring.adoc diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index eb0bed5397f2..4552f0d7a871 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -1575,24 +1575,46 @@ Topics: 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: 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: Maintenance and support for monitoring + File: maintenance-and-support-for-monitoring + - 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: Accessing third-party monitoring APIs - 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 diff --git a/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc index 7f6090467339..301ac265b0f4 100644 --- a/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc +++ b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc @@ -28,12 +28,13 @@ include::modules/odc-image-vulnerabilities-breakdown.adoc[leveloffset=+1] include::modules/odc-monitoring-your-app-vulnerabilities.adoc[leveloffset=+1] -ifdef::openshift-rosa,openshift-dedicated[] + [role="_additional-resources"] [id="additional-resources-odc-monitoring-project-and-application-metrics-using-developer-perspective"] == Additional resources +ifdef::openshift-dedicated[] * xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] -endif::openshift-rosa,openshift-dedicated[] -ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +endif::openshift-dedicated[] +ifndef::openshift-rosa-hcp,openshift-dedicated[] * xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] -endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] \ No newline at end of file +endif::openshift-rosa-hcp,openshift-dedicated[] \ No newline at end of file diff --git a/machine_configuration/machine-config-daemon-metrics.adoc b/machine_configuration/machine-config-daemon-metrics.adoc index adf0316e86fc..b40e1871e803 100644 --- a/machine_configuration/machine-config-daemon-metrics.adoc +++ b/machine_configuration/machine-config-daemon-metrics.adoc @@ -12,10 +12,10 @@ include::modules/machine-config-daemon-metrics-understanding.adoc[leveloffset=+1 [role="_additional-resources"] .Additional resources -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated[] * xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] * xref:../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering data about your cluster] -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated[] +ifdef::openshift-dedicated[] * xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Understanding the monitoring stack] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated[] diff --git a/observability/logging/logging_alerts/custom-logging-alerts.adoc b/observability/logging/logging_alerts/custom-logging-alerts.adoc index f405a4702b94..c4585930b3b3 100644 --- a/observability/logging/logging_alerts/custom-logging-alerts.adoc +++ b/observability/logging/logging_alerts/custom-logging-alerts.adoc @@ -30,12 +30,12 @@ include::modules/logging-enabling-loki-alerts.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_custom-logging-alerts"] == Additional resources -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated[] * xref:../../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[About {product-title} monitoring] -endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa-hcp[] * xref:../../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] ifdef::openshift-enterprise[] * xref:../../../post_installation_configuration/configuring-alert-notifications.adoc#configuring-alert-notifications[Configuring alert notifications] endif::[] diff --git a/observability/logging/logging_alerts/default-logging-alerts.adoc b/observability/logging/logging_alerts/default-logging-alerts.adoc index 5f149ce10b36..14c9b07c6293 100644 --- a/observability/logging/logging_alerts/default-logging-alerts.adoc +++ b/observability/logging/logging_alerts/default-logging-alerts.adoc @@ -16,12 +16,9 @@ include::modules/logging-vector-collector-alerts.adoc[leveloffset=+1] include::modules/logging-fluentd-collector-alerts.adoc[leveloffset=+1] include::modules/cluster-logging-elasticsearch-rules.adoc[leveloffset=+1] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] [id="additional-resources_default-logging-alerts"] == Additional resources -ifdef::openshift-dedicated,openshift-rosa[] -* xref:../../../observability/monitoring/managing-alerts.adoc#modifying-core-platform-alerting-rules_managing-alerts[Modifying core platform alerting rules] -endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#modifying-core-platform-alerting-rules_managing-alerts-as-an-administrator[Modifying core platform alerting rules] endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc b/observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc index f17e01622a42..b3f9b23c684d 100644 --- a/observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc +++ b/observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc @@ -12,12 +12,12 @@ include::modules/es-cluster-health-is-red.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated[] * xref:../../../observability/monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards] -endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa-hcp[] * xref:../../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#reviewing-monitoring-dashboards-admin_accessing-metrics-as-an-administrator[Reviewing monitoring dashboards as a cluster administrator] -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] * 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"] diff --git a/observability/monitoring/about-ocp-monitoring/key-concepts.adoc b/observability/monitoring/about-ocp-monitoring/key-concepts.adoc index 51388771d2d7..79cafde4237c 100644 --- a/observability/monitoring/about-ocp-monitoring/key-concepts.adoc +++ b/observability/monitoring/about-ocp-monitoring/key-concepts.adoc @@ -12,20 +12,24 @@ Get familiar with the {product-title} monitoring concepts and terms. Learn about == About performance and scalability You can optimize the performance and scale of your clusters. -You can configure the default monitoring stack by performing any of the following actions: +You can configure the monitoring stack by performing any of the following actions: * Control the placement and distribution of monitoring components: ** Use node selectors to move components to specific nodes. ** Assign tolerations to enable moving components to tainted nodes. * Use pod topology spread constraints. -* Set the body size limit for metrics scraping. * Manage CPU and memory resources. +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +* Set the body size limit for metrics scraping. * Use metrics collection profiles. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc#configuring-performance-and-scalability[Configuring performance and scalability for core platform monitoring] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc#configuring-performance-and-scalability-uwm[Configuring performance and scalability for user workload monitoring] include::modules/monitoring-using-node-selectors-to-move-monitoring-components.adoc[leveloffset=+2] @@ -34,27 +38,33 @@ include::modules/monitoring-using-pod-topology-spread-constraints-for-monitoring include::modules/monitoring-about-specifying-limits-and-requests-for-monitoring-components.adoc[leveloffset=+2] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-configuring-metrics-collection-profiles.adoc[leveloffset=+2] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="about-storing-and-recording-data_{context}"] == About storing and recording data You can store and record data to help you protect the data and use them for troubleshooting. -You can configure the default monitoring stack by performing any of the following actions: +You can configure the monitoring stack by performing any of the following actions: * Configure persistent storage: ** Protect your metrics and alerting data from data loss by storing them in a persistent volume (PV). As a result, they can survive pods being restarted or recreated. ** Avoid getting duplicate notifications and losing silences for alerts when the Alertmanager pods are restarted. * Modify the retention time and size for Prometheus and Thanos Ruler metrics data. * Configure logging to help you troubleshoot issues with your cluster: +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** Configure audit logs for Metrics Server. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ** Set log levels for monitoring. ** Enable the query logging for Prometheus and Thanos Querier. [role="_additional-resources"] .Additional resources +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-core-platform-monitoring/storing-and-recording-data.adoc#storing-and-recording-data[Storing and recording data for core platform monitoring] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc#storing-and-recording-data-uwm[Storing and recording data for user workload monitoring] include::modules/monitoring-retention-time-and-size-for-prometheus-metrics-data.adoc[leveloffset=+2] @@ -65,7 +75,9 @@ include::modules/monitoring-understanding-metrics.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-core-platform-monitoring/configuring-metrics.adoc#configuring-metrics[Configuring metrics for core platform monitoring] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc#configuring-metrics-uwm[Configuring metrics for user workload monitoring] * xref:../../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#accessing-metrics-as-an-administrator[Accessing metrics as an administrator] * xref:../../../observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc#accessing-metrics-as-a-developer[Accessing metrics as a developer] @@ -93,16 +105,19 @@ include::modules/monitoring-about-managing-alerts.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources - +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc#configuring-alerts-and-notifications[Configuring alerts and notifications for core platform monitoring] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc#configuring-alerts-and-notifications-uwm[Configuring alerts and notifications for user workload monitoring] * xref:../../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[Managing alerts as an Administrator] * xref:../../../observability/monitoring/managing-alerts/managing-alerts-as-a-developer.adoc#managing-alerts-as-a-developer[Managing alerts as a Developer] include::modules/monitoring-managing-silences.adoc[leveloffset=+2] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-managing-core-platform-alerting-rules.adoc[leveloffset=+2] include::modules/monitoring-tips-for-optimizing-alerting-rules-for-core-platform-monitoring.adoc[leveloffset=+2] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-about-creating-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2] include::modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2] @@ -125,7 +140,9 @@ include::modules/monitoring-sending-notifications-to-external-systems.adoc[level [role="_additional-resources"] .Additional resources +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc#configuring-alert-notifications_configuring-alerts-and-notifications[Configuring alert notifications for core platform monitoring] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc#configuring-alert-notifications_configuring-alerts-and-notifications-uwm[Configuring alert notifications for user workload monitoring] diff --git a/observability/monitoring/about-ocp-monitoring/monitoring-stack-architecture.adoc b/observability/monitoring/about-ocp-monitoring/monitoring-stack-architecture.adoc index 2f84137c3860..cdfad04ee50f 100644 --- a/observability/monitoring/about-ocp-monitoring/monitoring-stack-architecture.adoc +++ b/observability/monitoring/about-ocp-monitoring/monitoring-stack-architecture.adoc @@ -32,8 +32,15 @@ include::modules/monitoring-monitoring-stack-in-ha-clusters.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../../../operators/operator_sdk/osdk-ha-sno.adoc#osdk-ha-sno[High-availability or single-node cluster detection and support] +ifndef::openshift-dedicated,openshift-rosa[] * xref:../../../observability/monitoring/configuring-core-platform-monitoring/storing-and-recording-data.adoc#configuring-persistent-storage_storing-and-recording-data[Configuring persistent storage] * xref:../../../observability/monitoring/configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc#configuring-performance-and-scalability[Configuring performance and scalability] +endif::openshift-dedicated,openshift-rosa[] + +ifdef::openshift-rosa[] +* xref:../../../observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc#configuring-persistent-storage_storing-and-recording-data-uwm[Configuring persistent storage] +* xref:../../../observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc#configuring-performance-and-scalability-uwm[Configuring performance and scalability] +endif::openshift-rosa[] //Glossary of common terms for OCP monitoring include::modules/monitoring-common-terms.adoc[leveloffset=+1] diff --git a/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc b/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc index 348aaf79e11d..ca82ee4b79ad 100644 --- a/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc +++ b/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc @@ -13,8 +13,10 @@ You can access metrics to monitor the performance of your cluster workloads. * xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] //Viewing a list of available metrics include::modules/monitoring-viewing-a-list-of-available-metrics.adoc[leveloffset=+1] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] //Querying metrics for user-defined projects with the OCP web console include::modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc[leveloffset=+1] diff --git a/observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc b/observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc index d552bf30d171..0ce2b3d0cb51 100644 --- a/observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc +++ b/observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc @@ -13,8 +13,10 @@ You can access metrics to monitor the performance of cluster components and your * xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] //Viewing a list of available metrics include::modules/monitoring-viewing-a-list-of-available-metrics.adoc[leveloffset=+1] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] //Querying metrics for all projects with the OCP web console include::modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc[leveloffset=+1] diff --git a/observability/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc b/observability/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc index ac3bd4e24ce6..9b68f6cb2f30 100644 --- a/observability/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc +++ b/observability/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc @@ -43,8 +43,10 @@ include::modules/monitoring-resources-reference-for-the-cluster-monitoring-opera [id="additional-resources_{context}"] == Additional resources +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * 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/configuring-core-platform-monitoring/configuring-metrics.adoc#configuring-remote-write-storage_configuring-metrics[Configuring remote write storage for core platform monitoring] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc#configuring-remote-write-storage_configuring-metrics-uwm[Configuring remote write storage for monitoring of user-defined projects] * xref:../../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#accessing-metrics-as-an-administrator[Accessing metrics as an administrator] * xref:../../../observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc#accessing-metrics-as-a-developer[Accessing metrics as a developer] diff --git a/observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc b/observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc index 6c5190ad0c88..666501835b20 100644 --- a/observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc +++ b/observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc @@ -36,9 +36,12 @@ For more information about supported configurations, see ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../observability/monitoring/getting-started/maintenance-and-support-for-monitoring.adoc#maintenance-and-support-for-monitoring[Maintenance and support for monitoring] endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-rosa[] +* xref:../../observability/monitoring/maintenance-and-support-for-monitoring.adoc#maintenance-and-support-for-monitoring[Maintenance and support for monitoring] +endif::openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa-hcp[] xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#maintenance-and-support_configuring-the-monitoring-stack[Maintenance and support for monitoring]. -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] * Configuring cluster monitoring is optional. * If a configuration does not exist or is empty, default values are used. diff --git a/observability/monitoring/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc b/observability/monitoring/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc index 4f02dfff7fd6..b798979da36f 100644 --- a/observability/monitoring/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc +++ b/observability/monitoring/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc @@ -19,18 +19,26 @@ include::modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.ad //Attaching additional labels to your time series and alerts include::modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc[leveloffset=+1,tags=**;!CPM;UWM] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * 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] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="configuring-alert-notifications_{context}"] == Configuring alert notifications +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] In {product-title}, an administrator can enable alert routing for user-defined projects with one of the following methods: * Use the default platform Alertmanager instance. * Use a separate Alertmanager instance only for user-defined projects. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +In {product-title}, the `dedicated-admin` user can enable alert routing for user-defined projects by using a separate Alertmanager instance for user-defined projects. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Developers and other users with the `alert-routing-edit` cluster role can configure custom alert notifications for their user-defined projects by configuring alert receivers. @@ -50,7 +58,15 @@ Review the following limitations of alert routing for user-defined projects: * xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems] * link:https://www.pagerduty.com/[PagerDuty] (PagerDuty official site) * link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide] (PagerDuty official site) + +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/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] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +* xref:../../../observability/monitoring/maintenance-and-support-for-monitoring.adoc#support-version-matrix-for-monitoring-components_maintenance-and-support-for-monitoring[Support version matrix for monitoring components] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + * xref:../../../observability/monitoring/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] diff --git a/observability/monitoring/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc b/observability/monitoring/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc index c5c3f3ac254b..6f9466f67916 100644 --- a/observability/monitoring/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc +++ b/observability/monitoring/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc @@ -20,8 +20,9 @@ include::modules/monitoring-configuring-remote-write-storage.adoc[leveloffset=+1 [role="_additional-resources"] .Additional resources - +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#spec-remotewrite-writerelabelconfigs[`writeRelabelConfigs`] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[`relabel_config`] (Prometheus documentation) include::modules/monitoring-supported-remote-write-authentication-settings.adoc[leveloffset=+2] @@ -32,8 +33,9 @@ include::modules/monitoring-example-remote-write-queue-configuration.adoc[levelo [role="_additional-resources"] .Additional resources - +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#spec-remotewrite-2[Prometheus REST API reference for remote write] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * link:https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage[Setting up remote write compatible endpoints] (Prometheus documentation) * link:https://prometheus.io/docs/practices/remote_write/#remote-write-tuning[Tuning remote write settings] (Prometheus documentation) * xref:../../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets-about_nodes-pods-secrets[Understanding secrets] @@ -60,7 +62,10 @@ include::modules/monitoring-example-service-endpoint-authentication-settings.ado [role="_additional-resources"] .Additional resources +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * 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] -* link:https://access.redhat.com/articles/6675491[Scrape Prometheus metrics using TLS in ServiceMonitor configuration] (Red{nbsp}Hat Customer Portal article) * xref:../../../rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[PodMonitor API] * xref:../../../rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[ServiceMonitor API] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +* link:https://access.redhat.com/articles/6675491[Scrape Prometheus metrics using TLS in ServiceMonitor configuration] (Red{nbsp}Hat Customer Portal article) + diff --git a/observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc b/observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc index 91c15c52110b..095fdba88947 100644 --- a/observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc +++ b/observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc @@ -29,7 +29,10 @@ include::modules/monitoring-moving-monitoring-components-to-different-nodes.adoc [role="_additional-resources"] .Additional resources + +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * 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] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-updating_nodes-nodes-working[Understanding how to update labels on nodes] * xref:../../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors[Placing pods on specific nodes using node selectors] * link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector[nodeSelector] (Kubernetes documentation) @@ -38,8 +41,11 @@ include::modules/monitoring-assigning-tolerations-to-monitoring-components.adoc[ [role="_additional-resources"] .Additional resources + +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * 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:../../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * link:https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/[Taints and Tolerations] (Kubernetes documentation) [id="managing-cpu-and-memory-resources-for-monitoring-components_{context}"] @@ -70,7 +76,9 @@ can use the following measures to control the impact of unbound metrics attribut * Limit the number of samples that can be accepted per target scrape in user-defined projects * Limit the number of scraped labels, the length of label names, and the length of label values * Configure the intervals between consecutive scrapes and between Prometheus rule evaluations +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Create alerts that fire when a scrape sample threshold is reached or when the target cannot be scraped +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== @@ -81,11 +89,16 @@ Limiting scrape samples can help prevent the issues caused by adding many unboun .Additional resources * xref:../../../observability/monitoring/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] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * 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] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/troubleshooting-monitoring-issues.adoc#determining-why-prometheus-is-consuming-disk-space_troubleshooting-monitoring-issues[Determining why Prometheus is consuming a lot of disk space] include::modules/monitoring-setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects.adoc[leveloffset=+2] + +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-creating-scrape-sample-alerts.adoc[leveloffset=+2] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] //Configuring pod topology spread constraints for monitoring of user-defined projects include::modules/monitoring-configuring-pod-topology-spread-constraints.adoc[leveloffset=+1,tags=**;!CPM;UWM] diff --git a/observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc b/observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc index 259aecf491cb..2fc82d9880c2 100644 --- a/observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc +++ b/observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc @@ -6,19 +6,26 @@ include::_attributes/common-attributes.adoc[] toc::[] -This section explains which user-defined monitoring components can be configured, how to enable user workload monitoring, and how to prepare for configuring the user workload monitoring stack. +This section explains which user-defined monitoring components can be configured +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +, how to enable user workload monitoring, +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +and how to prepare for configuring the user workload monitoring stack. [IMPORTANT] ==== * Not all configuration parameters for the monitoring stack are exposed. Only the parameters and fields listed in the xref:../../../observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}] are supported for configuration. +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * The monitoring stack imposes additional resource requirements. Consult the computing resources recommendations in xref:../../../scalability_and_performance/recommended-performance-scale-practices/recommended-infrastructure-practices.adoc#scaling-cluster-monitoring-operator_recommended-infrastructure-practices[Scaling the {cmo-full}] and verify that you have sufficient resources. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ==== // Configurable monitoring components include::modules/monitoring-configurable-monitoring-components.adoc[leveloffset=+1,tags=**;!CPM;UWM] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Enabling monitoring for user-defined projects [id="enabling-monitoring-for-user-defined-projects-uwm_{context}"] == Enabling monitoring for user-defined projects @@ -35,6 +42,7 @@ include::modules/monitoring-enabling-monitoring-for-user-defined-projects.adoc[l * xref:../../../observability/monitoring/getting-started/user-workload-monitoring-first-steps.adoc#user-workload-monitoring-first-steps[User workload monitoring first steps] include::modules/monitoring-granting-users-permission-to-configure-monitoring-for-user-defined-projects.adoc[leveloffset=+2] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Enabling alert routing for user-defined projects include::modules/monitoring-enabling-alert-routing-for-user-defined-projects.adoc[leveloffset=+1] @@ -45,9 +53,9 @@ include::modules/monitoring-enabling-alert-routing-for-user-defined-projects.ado * xref:../../../observability/monitoring/about-ocp-monitoring/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[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-enabling-the-platform-alertmanager-instance-for-user-defined-alert-routing.adoc[leveloffset=+2] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc[leveloffset=+2] include::modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc[leveloffset=+2] @@ -57,6 +65,7 @@ include::modules/monitoring-granting-users-permission-to-configure-alert-routing xref:../../../observability/monitoring/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc#configuring-alert-notifications_configuring-alerts-and-notifications-uwm[Configuring alert notifications] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Granting users permissions for monitoring for user-defined projects include::modules/monitoring-granting-users-permission-to-monitor-user-defined-projects.adoc[leveloffset=+1] @@ -68,6 +77,7 @@ include::modules/monitoring-granting-users-permission-to-monitor-user-defined-pr include::modules/monitoring-granting-user-permissions-using-the-web-console.adoc[leveloffset=+2] include::modules/monitoring-granting-user-permissions-using-the-cli.adoc[leveloffset=+2,tags=**;UWM;!CPM] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Excluding a user-defined project from monitoring include::modules/monitoring-excluding-a-user-defined-project-from-monitoring.adoc[leveloffset=+1] diff --git a/observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc b/observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc index ee27889c5663..cb8eebcb8a43 100644 --- a/observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc +++ b/observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc @@ -19,6 +19,7 @@ include::modules/monitoring-configuring-a-persistent-volume-claim.adoc[leveloffs * xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] * link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims[PersistentVolumeClaims] (Kubernetes documentation) +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-resizing-a-persistent-volume.adoc[leveloffset=+2,tags=**;!CPM;UWM] [role="_additional-resources"] @@ -27,6 +28,8 @@ include::modules/monitoring-resizing-a-persistent-volume.adoc[leveloffset=+2,tag * xref:../../../scalability_and_performance/recommended-performance-scale-practices/recommended-infrastructure-practices.adoc#prometheus-database-storage-requirements_recommended-infrastructure-practices[Prometheus database storage requirements] * xref:../../../storage/expanding-persistent-volumes.adoc#expanding-pvc-filesystem_expanding-persistent-volumes[Expanding persistent volume claims (PVCs) with a file system] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + // Modifying the retention time and size include::modules/monitoring-modifying-retention-time-and-size-for-prometheus-metrics-data.adoc[leveloffset=+1,tags=**;!CPM;UWM] @@ -37,11 +40,13 @@ include::modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metric .Additional resources * xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#retention-time-and-size-for-prometheus-metrics-data_key-concepts[Retention time and size for Prometheus metrics] +* xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * 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:../../../scalability_and_performance/recommended-performance-scale-practices/recommended-infrastructure-practices.adoc#prometheus-database-storage-requirements_cluster-monitoring-operator[Prometheus database storage requirements] * xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Recommended configurable storage technology] -* xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] * xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Setting log levels for monitoring components include::modules/monitoring-setting-log-levels-for-monitoring-components.adoc[leveloffset=+1,tags=**;!CPM;UWM] @@ -49,10 +54,9 @@ include::modules/monitoring-setting-log-levels-for-monitoring-components.adoc[le // Enabling the query log file for Prometheus include::modules/monitoring-setting-query-log-file-for-prometheus.adoc[leveloffset=+1,tags=**;!CPM;UWM] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * 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] - - - +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/observability/monitoring/getting-started/maintenance-and-support-for-monitoring.adoc b/observability/monitoring/getting-started/maintenance-and-support-for-monitoring.adoc index 157e969aa013..2429491e973c 100644 --- a/observability/monitoring/getting-started/maintenance-and-support-for-monitoring.adoc +++ b/observability/monitoring/getting-started/maintenance-and-support-for-monitoring.adoc @@ -6,21 +6,41 @@ include::_attributes/common-attributes.adoc[] toc::[] -Not all configuration options for the monitoring stack are exposed. The only supported way of configuring {product-title} monitoring is by configuring the {cmo-first} using the options described in the xref:../../../observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}]. *Do not use other configurations, as they are unsupported.* +Not all configuration options for the monitoring stack are exposed. The only supported way of configuring {product-title} monitoring is by configuring the {cmo-first} using the options described in the -Configuration paradigms might change across Prometheus releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use configurations other than those described in the xref:../../../observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}], your changes will disappear because the {cmo-short} automatically reconciles any differences and resets any unsupported changes back to the originally defined state by default and by design. +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +xref:../../../observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}]. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +xref:../../observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}]. +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + +*Do not use other configurations, as they are unsupported.* + +Configuration paradigms might change across Prometheus releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use configurations other than those described in the + +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +xref:../../../observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}], +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +xref:../../observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}], +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + +your changes will disappear because the {cmo-short} automatically reconciles any differences and resets any unsupported changes back to the originally defined state by default and by design. + +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [IMPORTANT] ==== Installing another Prometheus instance is not supported by the Red Hat Site Reliability Engineers (SRE). ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-support-considerations.adoc[leveloffset=+1] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-support-policy-for-monitoring-operators.adoc[leveloffset=+1] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-support-version-matrix-for-monitoring-components.adoc[leveloffset=+1] diff --git a/observability/monitoring/maintenance-and-support-for-monitoring.adoc b/observability/monitoring/maintenance-and-support-for-monitoring.adoc new file mode 120000 index 000000000000..52401d373dcb --- /dev/null +++ b/observability/monitoring/maintenance-and-support-for-monitoring.adoc @@ -0,0 +1 @@ +getting-started/maintenance-and-support-for-monitoring.adoc \ No newline at end of file diff --git a/observability/monitoring/managing-alerts/managing-alerts-as-a-developer.adoc b/observability/monitoring/managing-alerts/managing-alerts-as-a-developer.adoc index ebfe0a61b704..68d003b3b41b 100644 --- a/observability/monitoring/managing-alerts/managing-alerts-as-a-developer.adoc +++ b/observability/monitoring/managing-alerts/managing-alerts-as-a-developer.adoc @@ -43,7 +43,14 @@ When you create silences, they are replicated across Alertmanager pods. However, .Additional resources * xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#managing-silences_key-concepts[Managing silences] + +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-core-platform-monitoring/storing-and-recording-data.adoc#configuring-persistent-storage_storing-and-recording-data[Configuring persistent storage] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +* xref:../../../observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc#configuring-persistent-storage_storing-and-recording-data-uwm[Configuring persistent storage] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-silencing-alerts.adoc[leveloffset=+2,tags=**;DEV;!ADM] include::modules/monitoring-editing-silences.adoc[leveloffset=+2,tags=**;DEV;!ADM] diff --git a/observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc b/observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc index fc327fa32e32..b0b9aee419ca 100644 --- a/observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc +++ b/observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc @@ -10,7 +10,7 @@ In {product-title}, the Alerting UI enables you to manage alerts, silences, and [NOTE] ==== -The alerts, silences, and alerting rules that are available in the Alerting UI relate to the projects that you have access to. For example, if you are logged in as a user with the `cluster-admin` role, you can access all alerts, silences, and alerting rules. +The alerts, silences, and alerting rules that are available in the Alerting UI relate to the projects that you have access to. For example, if you are logged in as an administrator, you can access all alerts, silences, and alerting rules. ==== // Accessing the Alerting UI from the Administrator perspective @@ -43,13 +43,20 @@ When you create silences, they are replicated across Alertmanager pods. However, .Additional resources * xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#managing-silences_key-concepts[Managing silences] + +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/configuring-core-platform-monitoring/storing-and-recording-data.adoc#configuring-persistent-storage_storing-and-recording-data[Configuring persistent storage] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +* xref:../../../observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc#configuring-persistent-storage_storing-and-recording-data-uwm[Configuring persistent storage] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/monitoring-silencing-alerts.adoc[leveloffset=+2,tags=**;ADM;!DEV] include::modules/monitoring-editing-silences.adoc[leveloffset=+2,tags=**;ADM;!DEV] include::modules/monitoring-expiring-silences.adoc[leveloffset=+2,tags=**;ADM;!DEV] - +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="managing-alerting-rules-for-core-platform-monitoring_{context}"] == Managing alerting rules for core platform monitoring @@ -77,6 +84,7 @@ include::modules/monitoring-modifying-core-platform-alerting-rules.adoc[leveloff * link:https://prometheus.io/docs/alerting/alertmanager/[Alertmanager] (Prometheus documentation) * link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[relabel_config configuration] (Prometheus documentation) * link:https://prometheus.io/docs/practices/alerting/[Alerting] (Prometheus documentation) +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [id="managing-alerting-rules-for-user-defined-projects_{context}"] == Managing alerting rules for user-defined projects diff --git a/observability/monitoring/troubleshooting-monitoring-issues.adoc b/observability/monitoring/troubleshooting-monitoring-issues.adoc index 1daa769b81f4..8eee363e0513 100644 --- a/observability/monitoring/troubleshooting-monitoring-issues.adoc +++ b/observability/monitoring/troubleshooting-monitoring-issues.adoc @@ -35,15 +35,15 @@ include::modules/monitoring-determining-why-prometheus-is-consuming-disk-space.a [role="_additional-resources"] .Additional resources -ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifndef::openshift-dedicated,openshift-rosa-hcp[] * xref:../../observability/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc#accessing-monitoring-apis-by-using-the-cli[Accessing monitoring APIs by using the CLI] * xref:../../observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc#setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects_configuring-performance-and-scalability-uwm[Setting scrape intervals, evaluation intervals, and enforced limits for user-defined projects] -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa-hcp[] * xref:../../observability/monitoring/accessing-third-party-monitoring-apis.adoc#about-accessing-monitoring-web-service-apis_accessing-third-party-monitoring-apis[Accessing monitoring APIs by using the CLI] * xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects_configuring-the-monitoring-stack[Setting scrape intervals, evaluation intervals, and enforced limits for user-defined projects] -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] * xref:../../support/getting-support.adoc#support-submitting-a-case_getting-support[Submitting a support case] // Resolving the KubePersistentVolumeFillingUp alert firing for Prometheus diff --git a/observability/overview/index.adoc b/observability/overview/index.adoc index 8ccc9d605128..0c2da593577d 100644 --- a/observability/overview/index.adoc +++ b/observability/overview/index.adoc @@ -36,13 +36,13 @@ Monitor the in-cluster health and performance of your applications running on {p Monitoring stack components are deployed by default in every {product-title} installation and are managed by the {cmo-first}. These components include Prometheus, Alertmanager, Thanos Querier, and others. The {cmo-short} also deploys the Telemeter Client, which sends a subset of data from platform Prometheus instances to Red Hat to facilitate Remote Health Monitoring for clusters. -ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifndef::openshift-dedicated,openshift-rosa-hcp[] For more information, see xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] and xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]. -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa-hcp[] For more information, see xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] and xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]. -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] [id="cluster-logging-index_{context}"] == Logging diff --git a/operators/operator_sdk/osdk-monitoring-prometheus.adoc b/operators/operator_sdk/osdk-monitoring-prometheus.adoc index b1b292ca6193..b0b3a12614f7 100644 --- a/operators/operator_sdk/osdk-monitoring-prometheus.adoc +++ b/operators/operator_sdk/osdk-monitoring-prometheus.adoc @@ -36,8 +36,11 @@ Do not use the Prometheus Operator in the `openshift-monitoring` project. Red Ha * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-monitoring-custom-metrics_osdk-monitoring-prometheus[Exposing custom metrics for Go-based Operators] (OpenShift Container Platform documentation) * link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-ansible-metrics_osdk-monitoring-prometheus[Exposing custom metrics for Ansible-based Operators] (OpenShift Container Platform documentation) // TODO-HCP remove line 39 and 41 ifndef conditions for HCP after Observability book is migrated and add back HCP condition to line 41 and 21 -ifndef::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +* xref:../../observability/monitoring/about-ocp-monitoring/monitoring-stack-architecture.adoc#understanding-the-monitoring-stack_monitoring-stack-architecture[Understanding the monitoring stack] in {product-title} +endif::openshift-rosa[] +ifndef::openshift-rosa,openshift-rosa-hcp[] * xref:../../observability/monitoring/monitoring-overview.adoc#understanding-the-monitoring-stack_monitoring-overview[Understanding the monitoring stack] in {product-title} -endif::openshift-rosa-hcp[] +endif::openshift-rosa,openshift-rosa-hcp[] endif::openshift-dedicated,openshift-rosa[] diff --git a/rosa_getting_started/rosa-getting-started.adoc b/rosa_getting_started/rosa-getting-started.adoc index d080c704b3d9..296e87138c30 100644 --- a/rosa_getting_started/rosa-getting-started.adoc +++ b/rosa_getting_started/rosa-getting-started.adoc @@ -80,7 +80,12 @@ include::modules/rosa-getting-started-deleting-a-cluster.adoc[leveloffset=+1] * xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to a cluster using the {cluster-manager} console] * xref:../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing compute nodes] -* xref:../observability/monitoring/configuring-the-monitoring-stack.adoc[Configuring the monitoring stack] +ifndef::openshift-rosa-hcp[] +* xref:../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#preparing-to-configure-the-monitoring-stack-uwm[Preparing to configure the user workload monitoring stack] +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa-hcp[] +* xref:../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Configuring the monitoring stack] +endif::openshift-rosa-hcp[] [role="_additional-resources"] [id="additional-resources_{context}"] diff --git a/rosa_getting_started/rosa-quickstart-guide-ui.adoc b/rosa_getting_started/rosa-quickstart-guide-ui.adoc index 75609595c95a..8210e1014cca 100644 --- a/rosa_getting_started/rosa-quickstart-guide-ui.adoc +++ b/rosa_getting_started/rosa-quickstart-guide-ui.adoc @@ -155,7 +155,12 @@ include::modules/rosa-getting-started-deleting-a-cluster.adoc[leveloffset=+1] * xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to a cluster using the {cluster-manager} console] * xref:../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing compute nodes] -* xref:../observability/monitoring/configuring-the-monitoring-stack.adoc[Configuring the monitoring stack] +ifndef::openshift-rosa-hcp[] +* xref:../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#preparing-to-configure-the-monitoring-stack-uwm[Preparing to configure the user workload monitoring stack] +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa-hcp[] +* xref:../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Configuring the monitoring stack] +endif::openshift-rosa-hcp[] [role="_additional-resources"] [id="additional-resources_{context}"] diff --git a/rosa_release_notes/rosa-release-notes.adoc b/rosa_release_notes/rosa-release-notes.adoc index ac07693f8800..0fd0b731fcc2 100644 --- a/rosa_release_notes/rosa-release-notes.adoc +++ b/rosa_release_notes/rosa-release-notes.adoc @@ -242,7 +242,13 @@ For more information on region availabilities, see xref:../rosa_architecture/ros * **Documentation update.** The CLI Tools section was added to the ROSA documentation and includes more detailed information to help you fully use all of the supported CLI tools. The ROSA CLI section can now be found nested inside the CLI Tools heading. For more information, see xref:../cli_reference/index.adoc[CLI tools overview]. -* **Documentation update.** The Monitoring section in the documentation was expanded and now includes more detailed information to help you conveniently manage your ROSA clusters. For more information, see xref:../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[About Red{nbsp}Hat OpenShift Service on AWS monitoring]. +* **Documentation update.** The Monitoring section in the documentation was expanded and now includes more detailed information to help you conveniently manage your ROSA clusters. For more information, see +ifndef::openshift-rosa-hcp[] +xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]. +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa-hcp[] +xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]. +endif::openshift-rosa-hcp[] [id="rosa-q2-2023_{context}"] === Q2 2023 diff --git a/support/remote_health_monitoring/about-remote-health-monitoring.adoc b/support/remote_health_monitoring/about-remote-health-monitoring.adoc index 291569bbe3cb..e69cc30f11fe 100644 --- a/support/remote_health_monitoring/about-remote-health-monitoring.adoc +++ b/support/remote_health_monitoring/about-remote-health-monitoring.adoc @@ -109,14 +109,17 @@ include::modules/understanding-telemetry-and-insights-operator-data-flow.adoc[le ifndef::openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-dedicated[] * See xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated[] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated[] * 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. +endif::openshift-dedicated[] + +ifndef::openshift-dedicated,openshift-rosa[] * See xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] for details about configuring a firewall and enabling endpoints for Telemetry and Insights -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa[] endif::openshift-rosa-hcp[] [id="additional-details-about-how-remote-health-monitoring-data-is-used"] diff --git a/support/troubleshooting/investigating-monitoring-issues.adoc b/support/troubleshooting/investigating-monitoring-issues.adoc index a86277744cd6..398485042ee8 100644 --- a/support/troubleshooting/investigating-monitoring-issues.adoc +++ b/support/troubleshooting/investigating-monitoring-issues.adoc @@ -22,17 +22,19 @@ include::modules/monitoring-investigating-why-user-defined-metrics-are-unavailab ifndef::openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-dedicated[] * xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#creating-user-defined-workload-monitoring-configmap_configuring-the-monitoring-stack[Creating a user-defined workload monitoring config map] * See xref:../../observability/monitoring/managing-metrics.adoc#specifying-how-a-service-is-monitored_managing-metrics[Specifying how a service is monitored] for details on how to create a service monitor or pod monitor * See xref:../../observability/monitoring/managing-metrics.adoc#getting-detailed-information-about-a-target_managing-metrics[Getting detailed information about a metrics target] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated[] ifndef::openshift-rosa,openshift-dedicated[] * 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] +endif::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated[] * See xref:../../observability/monitoring/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc#specifying-how-a-service-is-monitored_configuring-metrics-uwm[Specifying how a service is monitored] for details on how to create a service monitor or pod monitor * See xref:../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#getting-detailed-information-about-a-target_accessing-metrics-as-an-administrator[Getting detailed information about a metrics target] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated[] endif::openshift-rosa-hcp[] // Determining why Prometheus is consuming a lot of disk space @@ -42,12 +44,12 @@ include::modules/monitoring-determining-why-prometheus-is-consuming-disk-space.a ifndef::openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-dedicated[] * xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects_configuring-the-monitoring-stack[Setting scrape and evaluation intervals and enforced limits for user-defined projects] -endif::openshift-rosa,openshift-dedicated[] -ifndef::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated[] +ifndef::openshift-dedicated[] * xref:../../observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc#setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects_configuring-performance-and-scalability-uwm[Setting scrape intervals, evaluation intervals, and enforced limits for user-defined projects] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated[] endif::openshift-rosa-hcp[] // Resolving the KubePersistentVolumeFillingUp alert firing for Prometheus diff --git a/virt/monitoring/virt-monitoring-overview.adoc b/virt/monitoring/virt-monitoring-overview.adoc index 10052bf661da..3538176db6b6 100644 --- a/virt/monitoring/virt-monitoring-overview.adoc +++ b/virt/monitoring/virt-monitoring-overview.adoc @@ -33,12 +33,12 @@ xref:../../virt/monitoring/virt-monitoring-vm-health.adoc#virt-monitoring-vm-hea Configure readiness, liveness, and guest agent ping probes and a watchdog for VMs. xref:../../virt/monitoring/virt-runbooks.adoc#virt-runbooks[Runbooks]:: -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated[] Diagnose and resolve issues that trigger {VirtProductName} xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[alerts] in the {product-title} web console. -endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa-hcp[] Diagnose and resolve issues that trigger {VirtProductName} xref:../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#about-managing-alerts_key-concepts[alerts] in the {product-title} web console. -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] //:FeatureName: The guest agent ping probe //include::snippets/technology-preview.adoc[] diff --git a/virt/monitoring/virt-prometheus-queries.adoc b/virt/monitoring/virt-prometheus-queries.adoc index 694eaefc738b..8d04cbb2f4a7 100644 --- a/virt/monitoring/virt-prometheus-queries.adoc +++ b/virt/monitoring/virt-prometheus-queries.adoc @@ -37,12 +37,12 @@ include::modules/virt-live-migration-metrics.adoc[leveloffset=+2] [role="_additional-resources"] == Additional resources // HCP link removed for now -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated[] * xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] -endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa-hcp[] * xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] * link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus] diff --git a/virt/monitoring/virt-runbooks.adoc b/virt/monitoring/virt-runbooks.adoc index ae9e26ed16ad..4d28f3fa9fc4 100644 --- a/virt/monitoring/virt-runbooks.adoc +++ b/virt/monitoring/virt-runbooks.adoc @@ -8,12 +8,12 @@ toc::[] :!virt-runbooks: To diagnose and resolve issues that trigger {VirtProductName} -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated[] xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[alerts], -endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa-hcp[] xref:../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#about-managing-alerts_key-concepts[alerts], -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] follow the procedures in the runbooks for the {VirtProductName} Operator. Triggered {VirtProductName} alerts can be viewed in the main *Observe* -> *Alerts* tab in the web console, and also in the *Virtualization* -> *Overview* tab. Runbooks for the {VirtProductName} Operator are maintained in the link:https://github.com/openshift/runbooks/tree/master/alerts/openshift-virtualization-operator[openshift/runbooks] Git repository, and you can view them on GitHub. diff --git a/virt/support/virt-collecting-virt-data.adoc b/virt/support/virt-collecting-virt-data.adoc index 9b1ff9703d69..c85a234b9d94 100644 --- a/virt/support/virt-collecting-virt-data.adoc +++ b/virt/support/virt-collecting-virt-data.adoc @@ -20,12 +20,12 @@ Prometheus is a time-series database and a rule evaluation engine for metrics. P Alertmanager:: The Alertmanager service handles alerts received from Prometheus. The Alertmanager is also responsible for sending the alerts to external notification systems. //link needs to be added for HCP when available -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated[] For information about the {product-title} monitoring stack, see xref:../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[About {product-title} monitoring]. -endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa-hcp[] For 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]. -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +endif::openshift-dedicated,openshift-rosa-hcp[] // This procedure is in the assembly so that we can add xrefs instead of a long list of additional resources. [id="virt-collecting-data-about-your-environment_{context}"] @@ -35,10 +35,16 @@ Collecting data about your environment minimizes the time required to analyze an .Prerequisites //link needs to be added for HCP when available -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated[] * xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#modifying-retention-time-for-prometheus-metrics-data_configuring-the-monitoring-stack[Set the retention time for Prometheus metrics data] to a minimum of seven days. * xref:../../observability/monitoring/managing-alerts.adoc#sending-notifications-to-external-systems_managing-alerts[Configure the Alertmanager to capture relevant alerts and to send alert notifications to a dedicated mailbox] so that they can be viewed and persisted outside the cluster. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated[] + +ifdef::openshift-rosa[] +* xref:../../observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc#modifying-retention-time-for-prometheus-metrics-data_storing-and-recording-data-uwm[Set the retention time for Prometheus metrics data] to a minimum of seven days. +* xref:../../observability/monitoring/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc#configuring-alert-notifications_configuring-alerts-and-notifications-uwm[Configure the Alertmanager to capture relevant alerts and to send alert notifications to a dedicated mailbox] so that they can be viewed and persisted outside the cluster. +endif::openshift-rosa[] + ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../observability/monitoring/configuring-core-platform-monitoring/storing-and-recording-data.adoc#modifying-retention-time-for-prometheus-metrics-data_storing-and-recording-data[Set the retention time for Prometheus metrics data] to a minimum of seven days. * xref:../../observability/monitoring/configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc#configuring-alert-notifications_configuring-alerts-and-notifications[Configure the Alertmanager to capture relevant alerts and to send alert notifications to a dedicated mailbox] so that they can be viewed and persisted outside the cluster. @@ -52,12 +58,14 @@ ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] . xref:../../support/gathering-cluster-data.adoc#support_gathering_data_gathering-cluster-data[Collect must-gather data for the cluster]. . link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.18/html-single/troubleshooting_openshift_data_foundation/index#downloading-log-files-and-diagnostic-information_rhodf[Collect must-gather data for {rh-storage-first}], if necessary. . xref:../../virt/support/virt-collecting-virt-data.adoc#virt-using-virt-must-gather_virt-collecting-virt-data[Collect must-gather data for {VirtProductName}]. -. xref:../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#querying-metrics-for-all-projects-with-mon-dashboard_accessing-metrics-as-an-administrator[Collect Prometheus metrics for the cluster]. endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] +ifndef::openshift-dedicated,openshift-rosa-hcp[] +. xref:../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#querying-metrics-for-all-projects-with-mon-dashboard_accessing-metrics-as-an-administrator[Collect Prometheus metrics for the cluster]. +endif::openshift-dedicated,openshift-rosa-hcp[] //link needs to be added for HCP when available -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-dedicated[] * xref:../../observability/monitoring/managing-metrics.adoc#querying-metrics-for-all-projects-with-mon-dashboard_managing-metrics[Collect Prometheus metrics for the cluster]. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated[] [id="virt-collecting-data-about-vms_{context}"] == Collecting data about virtual machines diff --git a/welcome/about-hcp.adoc b/welcome/about-hcp.adoc index 4ac306b8f219..a43ccaceb4b6 100644 --- a/welcome/about-hcp.adoc +++ b/welcome/about-hcp.adoc @@ -58,7 +58,13 @@ Use the following sections to find content to help you learn about and use {hcp- | link:https://learn.openshift.com/?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[OpenShift Interactive Learning Portal] | xref:../storage/index.adoc#storage-overview[Storage] -| xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview_virt-monitoring-overview[Monitoring overview] +| +ifdef::openshift-rosa-hcp[] +xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview_virt-monitoring-overview[Monitoring overview] +endif::openshift-rosa-hcp[] +ifndef::openshift-rosa-hcp[] +xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] +endif::openshift-rosa-hcp[] | xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{hcp-title} life cycle] |