setting up standalone monitoring branch

Author: eromanova97

_topic_maps/_topic_map.yml

@@ -1,7 +1,95 @@
 ---
-Name: About OpenShift Standalone
-Dir: about
+Name: About OpenShift Container Platform monitoring
+Dir: about-ocp-monitoring
 Distros: openshift-monitoring
 Topics:
-- Name: OpenShift Standalone overview
-  File: about-standalone
+- 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: Release notes
+# Dir: release-notes
+# Distros: openshift-monitoring
+# Topics:
+# - Name: Monitoring release notes
+#   File: monitoring-release-notes
+# ---
+Name: Getting started
+Dir: getting-started
+Distros: openshift-monitoring
+Topics:
+- Name: Maintenance and support for monitoring
+  File: maintenance-and-support-for-monitoring
+- Name: Core platform monitoring first steps
+  File: core-platform-monitoring-first-steps
+- Name: User workload monitoring first steps
+  File: user-workload-monitoring-first-steps
+- Name: Developer and non-administrator steps
+  File: developer-and-non-administrator-steps
+---
+Name: Configuring core platform monitoring
+Dir: configuring-core-platform-monitoring
+Distros: openshift-monitoring
+Topics:
+- Name: Preparing to configure the monitoring stack
+  File: preparing-to-configure-the-monitoring-stack
+- Name: Configuring performance and scalability
+  File: configuring-performance-and-scalability
+- Name: Storing and recording data
+  File: storing-and-recording-data
+- Name: Configuring metrics
+  File: configuring-metrics
+- Name: Configuring alerts and notifications
+  File: configuring-alerts-and-notifications
+---
+Name: Configuring user workload monitoring
+Dir: configuring-user-workload-monitoring
+Distros: openshift-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
+Distros: openshift-monitoring
+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
+Dir: managing-alerts
+Distros: openshift-monitoring
+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
+Dir: troubleshooting
+Distros: openshift-monitoring
+Topics:
+- Name: Troubleshooting monitoring issues
+  File: troubleshooting-monitoring-issues
+---
+Name: Config map reference for the Cluster Monitoring Operator
+Dir: config-map-reference
+Distros: openshift-monitoring
+Topics:
+- Name: Config map reference for the Cluster Monitoring Operator
+  File: config-map-reference-for-the-cluster-monitoring-operator

about-ocp-monitoring/_attributes

@@ -0,0 +1 @@
+../_attributes/

about-ocp-monitoring/about-ocp-monitoring.adoc

@@ -0,0 +1,28 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="about-ocp-monitoring"]
+= About {product-title} monitoring
+:context: about-ocp-monitoring
+
+toc::[]
+
+ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+{product-title} includes a preconfigured, preinstalled, and self-updating monitoring stack that provides monitoring for core platform components. You also have the option to xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[enable monitoring for user-defined projects].
+
+A cluster administrator can xref:../configuring-core-platform-monitoring/preparing-to-configure-the-monitoring-stack.adoc#preparing-to-configure-the-monitoring-stack[configure the monitoring stack] with the supported configurations. {product-title} delivers monitoring best practices out of the box.
+
+A set of alerts are included by default that immediately notify administrators about issues with a cluster. Default dashboards in the {product-title} web console include visual representations of cluster metrics to help you to quickly understand the state of your cluster. With the {product-title} web console, you can xref:../accessing-metrics/accessing-metrics-as-an-administrator.adoc#accessing-metrics-as-an-administrator[access metrics] and xref:../managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[manage alerts].
+
+After installing {product-title}, cluster administrators can optionally enable monitoring for user-defined projects. By using this feature, cluster administrators, developers, and other users can specify how services and pods are monitored in their own projects.
+As a cluster administrator, you can find answers to common problems such as user metrics unavailability and high consumption of disk space by Prometheus in xref:../troubleshooting/troubleshooting-monitoring-issues.adoc#troubleshooting-monitoring-issues[Troubleshooting monitoring issues].
+endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+
+ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+In {product-title}, you can monitor your own projects in isolation from Red{nbsp}Hat Site Reliability Engineering (SRE) platform metrics. You can monitor your own projects without the need for an additional monitoring solution.
+
+The {product-title}
+ifdef::openshift-rosa,openshift-rosa-hcp[]
+(ROSA)
+endif::openshift-rosa,openshift-rosa-hcp[]
+monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem.
+endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

snippets/images renamed to about-ocp-monitoring/images

@@ -0,0 +1,145 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="key-concepts"]
+= Understanding the monitoring stack - key concepts
+:context: key-concepts
+
+toc::[]
+
+Get familiar with the {product-title} monitoring concepts and terms. Learn about how you can improve performance and scale of your cluster, store and record data, manage metrics and alerts, and more.
+
+[id="about-performance-and-scalability_{context}"]
+== About performance and scalability
+
+You can optimize the performance and scale of your clusters.
+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.
+* 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:../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:../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]
+
+include::modules/monitoring-using-pod-topology-spread-constraints-for-monitoring.adoc[leveloffset=+2]
+
+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 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:../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:../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]
+
+// Understanding metrics
+include::modules/monitoring-understanding-metrics.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+* xref:../configuring-core-platform-monitoring/configuring-metrics.adoc#configuring-metrics[Configuring metrics for core platform monitoring]
+endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+* xref:../configuring-user-workload-monitoring/configuring-metrics-uwm.adoc#configuring-metrics-uwm[Configuring metrics for user workload monitoring]
+* xref:../accessing-metrics/accessing-metrics-as-an-administrator.adoc#accessing-metrics-as-an-administrator[Accessing metrics as an administrator]
+* xref:../accessing-metrics/accessing-metrics-as-a-developer.adoc#accessing-metrics-as-a-developer[Accessing metrics as a developer]
+
+include::modules/monitoring-controlling-the-impact-of-unbound-attributes-in-user-defined-projects.adoc[leveloffset=+2]
+
+include::modules/monitoring-adding-cluster-id-labels-to-metrics.adoc[leveloffset=+2]
+
+//About monitoring dashboards
+
+include::modules/monitoring-about-monitoring-dashboards.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../accessing-metrics/accessing-metrics-as-an-administrator.adoc#reviewing-monitoring-dashboards-admin_accessing-metrics-as-an-administrator[Reviewing monitoring dashboards as a cluster administrator]
+* xref:../accessing-metrics/accessing-metrics-as-a-developer.adoc#reviewing-monitoring-dashboards-developer_accessing-metrics-as-a-developer[Reviewing monitoring dashboards as a developer]
+
+//Managing alerts
+include::modules/monitoring-about-managing-alerts.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+* xref:../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:../configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc#configuring-alerts-and-notifications-uwm[Configuring alerts and notifications for user workload monitoring]
+* xref:../managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[Managing alerts as an Administrator]
+* xref:../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]
+
+include::modules/monitoring-optimizing-alerting-for-user-defined-projects.adoc[leveloffset=+2]
+
+include::modules/monitoring-searching-alerts-silences-and-alerting-rules.adoc[leveloffset=+2]
+
+// Overview of setting up alert routing for user-defined projects
+include::modules/monitoring-understanding-alert-routing-for-user-defined-projects.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-alert-routing-for-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[Enabling alert routing for user-defined projects]
+
+// Sending notifications to external systems
+include::modules/monitoring-sending-notifications-to-external-systems.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+* xref:../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:../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]

about-ocp-monitoring/key-concepts.adoc

@@ -0,0 +1 @@
+../modules/

about-ocp-monitoring/modules

@@ -0,0 +1,59 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="monitoring-stack-architecture"]
+= Monitoring stack architecture
+:context: monitoring-stack-architecture
+
+toc::[]
+
+ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+The {product-title} monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem. 
+endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+The monitoring stack includes default monitoring components and components for monitoring user-defined projects.
+
+// Understanding the monitoring stack
+include::modules/monitoring-understanding-the-monitoring-stack.adoc[leveloffset=+1]
+
+ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+//Default monitoring components
+include::modules/monitoring-default-monitoring-components.adoc[leveloffset=+1]
+endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+
+include::modules/monitoring-default-monitoring-targets.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../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]
+
+//Components for monitoring user-defined projects
+include::modules/monitoring-components-for-monitoring-user-defined-projects.adoc[leveloffset=+1]
+
+include::modules/monitoring-targets-for-user-defined-projects.adoc[leveloffset=+2]
+
+//The monitoring stack in high-availability clusters
+include::modules/monitoring-monitoring-stack-in-ha-clusters.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+* xref:../configuring-core-platform-monitoring/storing-and-recording-data.adoc#configuring-persistent-storage_storing-and-recording-data[Configuring persistent storage]
+* xref:../configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc#configuring-performance-and-scalability[Configuring performance and scalability]
+endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+
+ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+* xref:../configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc#configuring-persistent-storage_storing-and-recording-data-uwm[Configuring persistent storage]
+* xref:../configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc#configuring-performance-and-scalability-uwm[Configuring performance and scalability]
+endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+
+//Glossary of common terms for OCP monitoring
+include::modules/monitoring-common-terms.adoc[leveloffset=+1]
+
+ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
+[role="_additional-resources"]
+[id="additional-resources_{context}"]
+== Additional resources
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/support/index#about-remote-health-monitoring[About remote health monitoring]
+* xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#granting-users-permission-to-monitor-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[Granting users permissions for monitoring for user-defined projects]
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/security_and_compliance/index#tls-security-profiles[Configuring TLS security profiles]
+endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

about-ocp-monitoring/monitoring-stack-architecture.adoc

@@ -0,0 +1 @@
+../snippets

about-ocp-monitoring/snippets

@@ -0,0 +1 @@
+../_attributes/

accessing-metrics/_attributes

@@ -0,0 +1,36 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="accessing-metrics-as-a-developer"]
+= Accessing metrics as a developer
+:context: accessing-metrics-as-a-developer
+
+toc::[]
+
+You can access metrics to monitor the performance of your cluster workloads.
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../about-ocp-monitoring/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
+
+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]
+
+[role="_additional-resources"]
+.Additional resources
+
+* link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus (Prometheus documentation)]
+
+//Reviewing monitoring dashboards as a developer
+include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../about-ocp-monitoring/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/building_applications/index#monitoring-project-and-application-metrics-using-developer-perspective[Monitoring project and application metrics using the Developer perspective]