Skip to content

Move OpenShift ROSA to the new monitoring structure #93486

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
56 changes: 39 additions & 17 deletions _topic_maps/_topic_map_rosa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
endif::openshift-rosa-hcp,openshift-dedicated[]
8 changes: 4 additions & 4 deletions machine_configuration/machine-config-daemon-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Original file line number Diff line number Diff line change
Expand Up @@ -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::[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down
25 changes: 21 additions & 4 deletions observability/monitoring/about-ocp-monitoring/key-concepts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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]
Expand All @@ -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]
Expand Down Expand Up @@ -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]
Expand All @@ -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]


Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading