OSDOCS-3949: Describe data sent off-cluster in ROSA/OSD docs

adellape · Mar 15, 2023 · 9815275 · 9815275
1 parent c4960ad
commit 9815275
Show file tree

Hide file tree

Showing 44 changed files with 149 additions and 402 deletions.
diff --git a/.s2i/httpd-cfg/01-commercial.conf b/.s2i/httpd-cfg/01-commercial.conf
@@ -238,9 +238,7 @@ AddType text/vtt                            vtt
 
     # RewriteRule rosa/logging/?(.*)$ rosa/rosa_cluster_admin/rosa_logging/$1 [NE,R=301]
 
-    RewriteRule rosa/monitoring/osd?(.*)$ rosa/rosa_cluster_admin/rosa_monitoring/rosa$1 [NE,R=301]
-
-    RewriteRule rosa/cloud_infrastructure_access/?(.*)$ rosa/rosa_cluster_admin/cloud_infrastructure_access/$1 [NE,R=301]
+     RewriteRule rosa/cloud_infrastructure_access/?(.*)$ rosa/rosa_cluster_admin/cloud_infrastructure_access/$1 [NE,R=301]
 
     RewriteRule rosa/nodes/nodes-machinepools-about.html rosa/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.html [NE,R=301]
     RewriteRule rosa/nodes/rosa-managing-worker-nodes.html rosa/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.html [NE,R=301]
@@ -589,8 +587,6 @@ AddType text/vtt                            vtt
 
     RewriteRule ^dedicated/osd_notifications/notifications.html /dedicated/osd_cluster_admin/osd_logging/osd-accessing-the-service-logs.html [NE,R=301]
 
-    RewriteRule ^dedicated/monitoring/?(.*)$ /dedicated/osd_cluster_admin/osd_monitoring/$1 [NE,R=301]
-
     RewriteRule ^dedicated/osd_policy/?(.*)$ /dedicated/osd_architecture/osd_policy/$1 [NE,R=301]
 
     RewriteRule ^dedicated/support/getting-support.html /dedicated/osd_architecture/osd-support.html [NE,R=301]

diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -130,28 +130,15 @@ Topics:
   Topics:
   - Name: Accessing the service logs
     File: osd-accessing-the-service-logs
-- Name: Monitoring user-defined projects
-  Dir: osd_monitoring
-  Distros: openshift-dedicated
-  Topics:
-    - Name: Understanding the monitoring stack
-      File: osd-understanding-the-monitoring-stack
-    - Name: Accessing monitoring for user-defined projects
-      File: osd-accessing-monitoring-for-user-defined-projects
-    - Name: Configuring the monitoring stack
-      File: osd-configuring-the-monitoring-stack
-    - Name: Enabling alert routing for user-defined projects
-      File: osd-enabling-alert-routing-for-user-defined-projects
-    - Name: Managing metrics
-      File: osd-managing-metrics
-    - Name: Managing alerts
-      File: osd-managing-alerts
-    - Name: Reviewing monitoring dashboards
-      File: osd-reviewing-monitoring-dashboards
-    - Name: Troubleshooting monitoring issues
-      File: osd-troubleshooting-monitoring-issues
 ---
-Name: Cluster security
+Name: Security and compliance
+Dir: security
+Distros: openshift-dedicated
+Topics:
+- Name: Viewing audit logs
+  File: audit-log-view
+---
+Name: Authentication and authorization
 Dir: authentication
 Distros: openshift-dedicated
 Topics:
@@ -346,6 +333,27 @@ Topics:
 - Name: Exported fields
   File: cluster-logging-exported-fields
 ---
+Name: Monitoring user-defined projects
+Dir: monitoring
+Distros: openshift-dedicated
+Topics:
+- Name: Understanding the monitoring stack
+  File: osd-understanding-the-monitoring-stack
+- Name: Accessing monitoring for user-defined projects
+  File: osd-accessing-monitoring-for-user-defined-projects
+- Name: Configuring the monitoring stack
+  File: osd-configuring-the-monitoring-stack
+- Name: Enabling alert routing for user-defined projects
+  File: osd-enabling-alert-routing-for-user-defined-projects
+- Name: Managing metrics
+  File: osd-managing-metrics
+- Name: Managing alerts
+  File: managing-alerts
+- Name: Reviewing monitoring dashboards
+  File: osd-reviewing-monitoring-dashboards
+- Name: Troubleshooting monitoring issues
+  File: osd-troubleshooting-monitoring-issues
+---
 Name: Serverless
 Dir: serverless
 Distros: openshift-dedicated

diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -212,26 +212,17 @@ Topics:
     Distros: openshift-rosa
   - Name: About autoscaling nodes on a cluster
     File: rosa-nodes-about-autoscaling-nodes
-- Name: Monitoring user-defined projects
-  Dir: rosa_monitoring
-  Distros: openshift-rosa
-  Topics:
-  - Name: Understanding the monitoring stack
-    File: rosa-understanding-the-monitoring-stack
-  - Name: Accessing monitoring for user-defined projects
-    File: rosa-accessing-monitoring-for-user-defined-projects
-  - Name: Configuring the monitoring stack
-    File: rosa-configuring-the-monitoring-stack
-  - Name: Enabling alert routing for user-defined projects
-    File: rosa-enabling-alert-routing-for-user-defined-projects
-  - Name: Managing metrics
-    File: rosa-managing-metrics
-  - Name: Managing alerts
-    File: rosa-managing-alerts
-  - Name: Reviewing monitoring dashboards
-    File: rosa-reviewing-monitoring-dashboards
-  - Name: Troubleshooting monitoring issues
-    File: rosa-troubleshooting-monitoring-issues
+---
+Name: Security and compliance
+Dir: security
+Distros: openshift-rosa
+Topics:
+- Name: Viewing audit logs
+  File: audit-log-view
+# - Name: Security
+#   File: rosa-security
+# - Name: Application and cluster compliance
+#   File: rosa-app-security-compliance
 ---
 Name: Authentication and authorization
 Dir: authentication
@@ -241,10 +232,6 @@ Topics:
   File: assuming-an-aws-iam-role-for-a-service-account
 - Name: Managing security context constraints
   File: managing-security-context-constraints
-# - Name: Security
-#   File: rosa-security
-# - Name: Application and cluster compliance
-#   File: rosa-app-security-compliance
 ---
 Name: Upgrading
 Dir: upgrading
@@ -447,6 +434,27 @@ Topics:
 - Name: Exported fields
   File: cluster-logging-exported-fields
 ---
+Name: Monitoring user-defined projects
+Dir: monitoring
+Distros: openshift-rosa
+Topics:
+- Name: Understanding the monitoring stack
+  File: rosa-understanding-the-monitoring-stack
+- Name: Accessing monitoring for user-defined projects
+  File: rosa-accessing-monitoring-for-user-defined-projects
+- Name: Configuring the monitoring stack
+  File: rosa-configuring-the-monitoring-stack
+- Name: Enabling alert routing for user-defined projects
+  File: rosa-enabling-alert-routing-for-user-defined-projects
+- Name: Managing metrics
+  File: rosa-managing-metrics
+- Name: Managing alerts
+  File: managing-alerts
+- Name: Reviewing monitoring dashboards
+  File: rosa-reviewing-monitoring-dashboards
+- Name: Troubleshooting monitoring issues
+  File: rosa-troubleshooting-monitoring-issues
+---
 Name: Service Mesh
 Dir: service_mesh
 Distros: openshift-rosa
@@ -932,6 +940,11 @@ Name: Troubleshooting
 Dir: rosa_support
 Distros: openshift-rosa
 Topics:
+- Name: Remote health monitoring with connected clusters
+  Dir: remote_health_monitoring
+  Topics:
+  - Name: Showing data collected by remote health monitoring
+    File: showing-data-collected-by-remote-health-monitoring
 - Name: Troubleshooting expired offline access tokens
   File: rosa-troubleshooting-expired-tokens
 - Name: Troubleshooting installations

diff --git a/...ying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing.adoc b/...ying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing.adoc
@@ -1,9 +1,6 @@
 // Module included in the following assemblies:
 //
 // * monitoring/managing-alerts.adoc
-// * monitoring/osd-managing-alerts.adoc
-// * osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc
-// * rosa_cluster_admin/rosa_monitoring/rosa-managing-alerts.adoc
 
 :_content-type: PROCEDURE
 [id="applying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing_{context}"]

diff --git a/...g-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc b/...g-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc
@@ -2,8 +2,8 @@
 //
 // * monitoring/enabling-alert-routing-for-user-defined-projects.adoc
 // * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
-// * osd_cluster_admin/osd_monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
-// * rosa_cluster_admin/rosa_monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
+// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
+// * monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
 
 :_content-type: PROCEDURE
 [id="enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing_{context}"]

diff --git a/...ting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc b/...ting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc
@@ -2,8 +2,8 @@
 //
 // * monitoring/enabling-alert-routing-for-user-defined-projects.adoc
 // * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
-// * osd_cluster_admin/osd_monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
-// * rosa_cluster_admin/rosa_monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
+// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
+// * monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
 
 :_content-type: PROCEDURE
 [id="granting-users-permission-to-configure-alert-routing-for-user-defined-projects_{context}"]

diff --git a/modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc b/modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc
@@ -1,9 +1,6 @@
 // Module included in the following assemblies:
 //
 // * monitoring/managing-alerts.adoc
-// * monitoring/osd-managing-alerts.adoc
-// * osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc
-// * rosa_cluster_admin/rosa_monitoring/rosa-managing-alerts.adoc
 
 :_content-type: PROCEDURE
 [id="listing-alerting-rules-for-all-projects-in-a-single-view_{context}"]

diff --git a/modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc b/modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc
@@ -14,7 +14,7 @@ In {product-title} {product-version}, you can create, view, edit, and remove ale
 ifdef::openshift-rosa,openshift-dedicated[]
 [IMPORTANT]
 ====
-Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and up. 
+Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and later. 
 ====
 endif::[]
 

diff --git a/modules/osd-monitoring-understanding-alert-routing-for-user-defined-projects.adoc b/modules/osd-monitoring-understanding-alert-routing-for-user-defined-projects.adoc
@@ -1,8 +1,8 @@
 // Module included in the following assemblies:
 //
 // * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
-// * osd_cluster_admin/osd_monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
-// * rosa_cluster_admin/rosa_monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
+// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
+// * monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
 
 :_content-type: CONCEPT
 [id="osd-understanding-alert-routing-for-user-defined-projects_{context}"]

diff --git a/modules/telemetry-showing-data-collected-from-the-cluster.adoc b/modules/telemetry-showing-data-collected-from-the-cluster.adoc
@@ -10,7 +10,14 @@ You can view the cluster and components time series data captured by Telemetry.
 
 .Prerequisites
 
-* You have installed the {product-title} CLI (`oc`).
+* You have installed the 
+ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
+{product-title} 
+endif::openshift-enterprise,openshift-webscale,openshift-origin[]
+ifndef::openshift-enterprise,openshift-webscale,openshift-origin[]
+OpenShift Container Platform
+endif::openshift-enterprise,openshift-webscale,openshift-origin[]
+CLI (`oc`).
 * You have access to the cluster as a user with the `cluster-admin` role or the `cluster-monitoring-view` role.
 
 .Procedure

diff --git a/monitoring/managing-alerts.adoc b/monitoring/managing-alerts.adoc
@@ -49,12 +49,16 @@ include::modules/monitoring-optimizing-alerting-for-user-defined-projects.adoc[l
 [role="_additional-resources"]
 .Additional resources
 * See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts
+ifndef::openshift-rosa,openshift-dedicated[]
 * See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture
+endif::[]
 
 include::modules/monitoring-creating-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2]
 include::modules/monitoring-reducing-latency-for-alerting-rules-that-do-not-query-platform-metrics.adoc[leveloffset=+2]
 
+ifndef::openshift-rosa,openshift-dedicated[]
 * See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
+endif::[]
 
 include::modules/monitoring-accessing-alerting-rules-for-your-project.adoc[leveloffset=+2]
 include::modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc[leveloffset=+2]
@@ -72,7 +76,9 @@ include::modules/monitoring-creating-new-alerting-rules.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
+ifndef::openshift-rosa,openshift-dedicated[]
 * See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
+endif::[]
 * See the link:https://prometheus.io/docs/alerting/alertmanager/[Alertmanager documentation] for information about alerting rules.
 * See the link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[Prometheus relabeling documentation] for information about how relabeling works.
 * See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts.
@@ -98,9 +104,11 @@ include::modules/monitoring-applying-a-custom-configuration-to-alertmanager-for-
 * See link:https://www.pagerduty.com/[the PagerDuty official site] for more information on PagerDuty.
 * See link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[the PagerDuty Prometheus Integration Guide] to learn how to retrieve the `service_key`.
 * See link:https://prometheus.io/docs/alerting/configuration/[Alertmanager configuration] for configuring alerting through different alert receivers.
+ifndef::openshift-rosa,openshift-dedicated[]
 * See xref:../monitoring/enabling-alert-routing-for-user-defined-projects.adoc#enabling-alert-routing-for-user-defined-projects[Enabling alert routing for user-defined projects] to learn how to enable a dedicated instance of Alertmanager for user-defined alert routing.
 
 
 == Next steps
 
 * xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
+endif::[]
diff --git a/monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc b/monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc
@@ -6,9 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
 
 toc::[]
 
-By default, centralized monitoring for user-defined projects and platform monitoring are enabled. You can monitor your own projects in {product-title} without the need for an additional monitoring solution.
-
-The monitoring of user-defined projects cannot be disabled.
+When you install an {product-title} cluster, monitoring for user-defined projects is enabled by default. With monitoring for user-defined projects enabled, you can monitor your own {product-title} projects without the need for an additional monitoring solution.
 
 The `dedicated-admin` user has default permissions to configure and access monitoring for user-defined projects.
 
@@ -17,7 +15,9 @@ The `dedicated-admin` user has default permissions to configure and access monit
 Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) can cause issues with user-defined project monitoring if it is enabled. Custom Prometheus instances are not supported.
 ====
 
+Optionally, you can disable monitoring for user-defined projects during or after a cluster installation.
+
 [id="accessing-user-defined-monitoring-next-steps"]
 == Next steps
 
-* xref:../monitoring/osd-managing-metrics.adoc#osd-managing-metrics[Managing metrics]
+* xref:../monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
diff --git a/monitoring/osd-configuring-the-monitoring-stack.adoc b/monitoring/osd-configuring-the-monitoring-stack.adoc
@@ -79,4 +79,4 @@ include::modules/osd-monitoring-setting-log-levels-for-monitoring-components.ado
 [id="configuring-the-monitoring-stack-next-steps"]
 == Next steps
 
-* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
+* xref:../monitoring/osd-managing-metrics.adoc#osd-managing-metrics[Managing metrics]
diff --git a/monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc b/monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
@@ -7,7 +7,14 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
 toc::[]
 
 [role="_abstract"]
-In {product-title}, a cluster administrator can enable alert routing for user-defined projects. This process consists of two general steps:
+In {product-title}, a cluster administrator can enable alert routing for user-defined projects. 
+
+[IMPORTANT]
+====
+Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and later. 
+====
+
+This process consists of two general steps:
 
 * Enable alert routing for user-defined projects to use a separate Alertmanager instance.
 * Grant additional users permission to configure alert routing for user-defined projects.
@@ -26,5 +33,5 @@ include::modules/monitoring-granting-users-permission-to-configure-alert-routing
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc[Accessing monitoring for user-defined projects]
-* xref:../monitoring/osd-managing-alerts.adoc#creating-alert-routing-for-user-defined-projects_managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_osd-managing-alerts[Creating alert routing for user-defined projects]
+* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
+* xref:../monitoring/managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_managing-alerts[Creating alert routing for user-defined projects]
diff --git a/.../osd_monitoring/osd-managing-metrics.adoc → monitoring/osd-managing-metrics.adoc b/.../osd_monitoring/osd-managing-metrics.adoc → monitoring/osd-managing-metrics.adoc
@@ -20,7 +20,7 @@ include::modules/osd-monitoring-specifying-how-a-service-is-monitored.adoc[level
 .Additional resources
 
 * See the link:https://github.com/openshift/prometheus-operator/blob/release-4.7/Documentation/api.md[Prometheus Operator API documentation] for more information on `ServiceMonitor` and `PodMonitor` resources.
-* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects].
+* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects].
 
 // Querying metrics
 include::modules/osd-monitoring-querying-metrics.adoc[leveloffset=+1]
@@ -31,19 +31,18 @@ include::modules/osd-monitoring-querying-metrics-for-user-defined-projects-as-a-
 .Additional resources
 
 * See the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus query documentation] for more information about creating PromQL queries.
-* See the xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#querying-metrics-for-user-defined-projects-as-a-developer_osd-managing-metrics[Querying metrics for user-defined projects as a developer] for details on accessing non-cluster metrics as a developer or a privileged user
+* See the xref:../monitoring/osd-managing-metrics.adoc#querying-metrics-for-user-defined-projects-as-a-developer_osd-managing-metrics[Querying metrics for user-defined projects as a developer] for details on accessing non-cluster metrics as a developer or a privileged user
 // TODO: The above additional resource points to the same module that it's an additional resource of
 
 include::modules/osd-monitoring-exploring-the-visualized-metrics.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
 
-* See the xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#querying-metrics_osd-managing-metrics[Querying metrics] section on using the PromQL interface
-* xref:../../osd_cluster_admin/osd_monitoring/osd-troubleshooting-monitoring-issues.adoc#osd-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
+* See the xref:../monitoring/osd-managing-metrics.adoc#querying-metrics_osd-managing-metrics[Querying metrics] section on using the PromQL interface
+* xref:../monitoring/osd-troubleshooting-monitoring-issues.adoc#osd-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
 
 [id="managing-metrics-next-steps"]
 == Next steps
-* xref:../../osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc#osd-managing-alerts[Alerts]
+* xref:../monitoring/managing-alerts.adoc#managing-alerts[Alerts]
 
-// TODO: Why is alerts a next step if alerts aren't supported? Can this be removed?
diff --git a/monitoring/osd-understanding-the-monitoring-stack.adoc b/monitoring/osd-understanding-the-monitoring-stack.adoc
@@ -30,4 +30,4 @@ include::modules/osd-monitoring-targets-for-user-defined-projects.adoc[leveloffs
 [id="understanding-the-monitoring-stack-next-steps"]
 == Next steps
 
-* xref:../monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
+* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]