Merge pull request #88258 from sr1kar99/2177-toc-updates-edge-computing

TELCODOCS#2177: Refactor Edge Computing to improve ToC navigation

Author: kcarmichael08

_topic_maps/_topic_map.yml

@@ -3353,57 +3353,67 @@ Topics:
   File: node-observability-operator
   Distros: openshift-origin,openshift-enterprise
 ---
-Name: Edge computing
-Dir: edge_computing
+Name: Day 2 operations for telco core CNF clusters
+Dir: day_2_core_cnf_clusters
 Distros: openshift-origin,openshift-enterprise
 Topics:
-- Name: Challenges of the network far edge
-  File: ztp-deploying-far-edge-clusters-at-scale
-- Name: Preparing the hub cluster for ZTP
-  File: ztp-preparing-the-hub-cluster
-- Name: Updating GitOps ZTP
-  File: ztp-updating-gitops
-- Name: Installing managed clusters with RHACM and SiteConfig resources
-  File: ztp-deploying-far-edge-sites
-- Name: Manually installing a single-node OpenShift cluster with GitOps ZTP
-  File: ztp-manual-install
-- Name: Recommended single-node OpenShift cluster configuration for vDU application workloads
-  File: ztp-reference-cluster-configuration-for-vdu
-- Name: Validating cluster tuning for vDU application workloads
-  File: ztp-vdu-validating-cluster-tuning
-- Name: Advanced managed cluster configuration with SiteConfig resources
-  File: ztp-advanced-install-ztp
-- Name: Managing cluster policies with PolicyGenerator resources
-  Dir: policygenerator_for_ztp
-  Distros: openshift-origin,openshift-enterprise
+- Name: Upgrading telco core CNF clusters
+  Dir: updating
   Topics:
-  - Name: Configuring managed cluster policies by using PolicyGenerator resources
-    File: ztp-configuring-managed-clusters-policygenerator
-  - Name: Advanced managed cluster configuration with PolicyGenerator resources
-    File: ztp-advanced-policygenerator-config
-  - Name: Updating managed clusters in a disconnected environment with PolicyGenerator resources and TALM
-    File: ztp-talm-updating-managed-policies-pg
-- Name: Managing cluster policies with PolicyGenTemplate resources
-  Dir: policygentemplate_for_ztp
-  Distros: openshift-origin,openshift-enterprise
+  - Name: Upgrading telco core CNF clusters
+    File: telco-update-welcome
+  - Name: OpenShift Container Platform API compatibility
+    File: telco-update-api
+  - Name: Preparing for the cluster update
+    File: telco-update-ocp-update-prep
+  - Name: Managing live CNF pods during the cluster update
+    File: telco-update-cnf-update-prep
+  - Name: Before you update the cluster
+    File: telco-update-before-the-update
+  - Name: Completing the Control Plane Only update
+    File: telco-update-completing-the-control-plane-only-update
+  - Name: Completing the y-stream update
+    File: telco-update-completing-the-y-stream-update
+  - Name: Completing the z-stream update
+    File: telco-update-completing-the-z-stream-update
+- Name: Troubleshooting and maintaining telco core CNF clusters
+  Dir: troubleshooting
   Topics:
-  - Name: Configuring managed cluster policies by using PolicyGenTemplate resources
-    File: ztp-configuring-managed-clusters-policies
-  - Name: Advanced managed cluster configuration with PolicyGenTemplate resources
-    File: ztp-advanced-policy-config
-  - Name: Updating managed clusters in a disconnected environment with PolicyGenTemplate resources and TALM
-    File: ztp-talm-updating-managed-policies
-- Name: Using hub templates in PolicyGenerator or PolicyGenTemplate CRs
-  File: ztp-using-hub-cluster-templates
-- Name: Updating managed clusters with the Topology Aware Lifecycle Manager
-  File: cnf-talm-for-cluster-upgrades
-- Name: Expanding single-node OpenShift clusters with GitOps ZTP
-  File: ztp-sno-additional-worker-node
-- Name: Pre-caching images for single-node OpenShift deployments
-  File: ztp-precaching-tool
+  - Name: Troubleshooting and maintaining telco core CNF clusters
+    File: telco-troubleshooting-intro
+  - Name: General troubleshooting
+    File: telco-troubleshooting-general-troubleshooting
+  - Name: Cluster maintenance
+    File: telco-troubleshooting-cluster-maintenance
+  - Name: Security
+    File: telco-troubleshooting-security
+  - Name: Certificate maintenance
+    File: telco-troubleshooting-cert-maintenance
+  - Name: Machine Config Operator
+    File: telco-troubleshooting-mco
+  - Name: Bare-metal node maintenance
+    File: telco-troubleshooting-bmn-maintenance
+- Name: Observability
+  Dir: observability
+  Topics:
+  - Name: Observability in OpenShift Container Platform
+    File: telco-observability
+- Name: Security
+  Dir: security
+  Topics:
+  - Name: Security basics
+    File: telco-security-basics
+  - Name: Host security
+    File: telco-security-host-sec
+  - Name: Security context constraints
+    File: telco-security-sec-context-constraints
+---
+Name: Image-based installation and upgrade for single-node OpenShift clusters
+Dir: image_based_install_and_upgrade
+Distros: openshift-origin,openshift-enterprise
+Topics:
 - Name: Image-based upgrade for single-node OpenShift clusters
   Dir: image_based_upgrade
-  Distros: openshift-origin,openshift-enterprise
   Topics:
   - Name: Understanding the image-based upgrade for single-node OpenShift clusters
     File: cnf-understanding-image-based-upgrade
@@ -3429,7 +3439,6 @@ Topics:
     File: ztp-image-based-upgrade
 - Name: Image-based installation for single-node OpenShift
   Dir: image_base_install
-  Distros: openshift-origin,openshift-enterprise
   Topics:
   - Name: Understanding image-based installation and deployment for single-node OpenShift
     File: ibi-understanding-image-based-install
@@ -3445,60 +3454,55 @@ Topics:
       File: ibi-edge-image-based-install
     - Name: Deploying single-node OpenShift using the installation program
       File: ibi-edge-image-based-install-standalone
-- Name: Day 2 operations for telco core CNF clusters
-  Dir: day_2_core_cnf_clusters
+---
+Name: GitOps ZTP
+Dir: gitops_ztp
+Distros: openshift-origin,openshift-enterprise
+Topics:
+- Name: Challenges of the network far edge
+  File: ztp-deploying-far-edge-clusters-at-scale
+- Name: Preparing the hub cluster for ZTP
+  File: ztp-preparing-the-hub-cluster
+- Name: Updating GitOps ZTP
+  File: ztp-updating-gitops
+- Name: Installing managed clusters with RHACM and SiteConfig resources
+  File: ztp-deploying-far-edge-sites
+- Name: Manually installing a single-node OpenShift cluster with GitOps ZTP
+  File: ztp-manual-install
+- Name: Recommended single-node OpenShift cluster configuration for vDU application workloads
+  File: ztp-reference-cluster-configuration-for-vdu
+- Name: Validating cluster tuning for vDU application workloads
+  File: ztp-vdu-validating-cluster-tuning
+- Name: Advanced managed cluster configuration with SiteConfig resources
+  File: ztp-advanced-install-ztp
+- Name: Managing cluster policies with PolicyGenerator resources
+  Dir: policygenerator_for_ztp
   Distros: openshift-origin,openshift-enterprise
   Topics:
-  - Name: Upgrading telco core CNF clusters
-    Dir: updating
-    Topics:
-    - Name: Upgrading telco core CNF clusters
-      File: telco-update-welcome
-    - Name: OpenShift Container Platform API compatibility
-      File: telco-update-api
-    - Name: Preparing for the cluster update
-      File: telco-update-ocp-update-prep
-    - Name: Managing live CNF pods during the cluster update
-      File: telco-update-cnf-update-prep
-    - Name: Before you update the cluster
-      File: telco-update-before-the-update
-    - Name: Completing the Control Plane Only update
-      File: telco-update-completing-the-control-plane-only-update
-    - Name: Completing the y-stream update
-      File: telco-update-completing-the-y-stream-update
-    - Name: Completing the z-stream update
-      File: telco-update-completing-the-z-stream-update
-  - Name: Troubleshooting and maintaining telco core CNF clusters
-    Dir: troubleshooting
-    Topics:
-    - Name: Troubleshooting and maintaining telco core CNF clusters
-      File: telco-troubleshooting-intro
-    - Name: General troubleshooting
-      File: telco-troubleshooting-general-troubleshooting
-    - Name: Cluster maintenance
-      File: telco-troubleshooting-cluster-maintenance
-    - Name: Security
-      File: telco-troubleshooting-security
-    - Name: Certificate maintenance
-      File: telco-troubleshooting-cert-maintenance
-    - Name: Machine Config Operator
-      File: telco-troubleshooting-mco
-    - Name: Bare-metal node maintenance
-      File: telco-troubleshooting-bmn-maintenance
-  - Name: Observability
-    Dir: observability
-    Topics:
-    - Name: Observability in OpenShift Container Platform
-      File: telco-observability
-  - Name: Security
-    Dir: security
-    Topics:
-    - Name: Security basics
-      File: telco-security-basics
-    - Name: Host security
-      File: telco-security-host-sec
-    - Name: Security context constraints
-      File: telco-security-sec-context-constraints
+  - Name: Configuring managed cluster policies by using PolicyGenerator resources
+    File: ztp-configuring-managed-clusters-policygenerator
+  - Name: Advanced managed cluster configuration with PolicyGenerator resources
+    File: ztp-advanced-policygenerator-config
+  - Name: Updating managed clusters in a disconnected environment with PolicyGenerator resources and TALM
+    File: ztp-talm-updating-managed-policies-pg
+- Name: Managing cluster policies with PolicyGenTemplate resources
+  Dir: policygentemplate_for_ztp
+  Distros: openshift-origin,openshift-enterprise
+  Topics:
+  - Name: Configuring managed cluster policies by using PolicyGenTemplate resources
+    File: ztp-configuring-managed-clusters-policies
+  - Name: Advanced managed cluster configuration with PolicyGenTemplate resources
+    File: ztp-advanced-policy-config
+  - Name: Updating managed clusters in a disconnected environment with PolicyGenTemplate resources and TALM
+    File: ztp-talm-updating-managed-policies
+- Name: Using hub templates in PolicyGenerator or PolicyGenTemplate CRs
+  File: ztp-using-hub-cluster-templates
+- Name: Updating managed clusters with the Topology Aware Lifecycle Manager
+  File: cnf-talm-for-cluster-upgrades
+- Name: Expanding single-node OpenShift clusters with GitOps ZTP
+  File: ztp-sno-additional-worker-node
+- Name: Pre-caching images for single-node OpenShift deployments
+  File: ztp-precaching-tool
 ---
 Name: Specialized hardware and driver enablement
 Dir: hardware_enablement

architecture/mce-overview-ocp.adoc

@@ -19,7 +19,7 @@ When you enable multicluster engine on {product-title}, you gain the following c
 * xref:../hosted_control_planes/index.adoc#hcp-overview[{hcp-capital}], which is a feature that is based on the HyperShift project. With a centralized hosted control plane, you can operate {product-title} clusters in a hyperscale manner.
 * Hive, which provisions self-managed {product-title} clusters to the hub and completes the initial configurations for those clusters.
 * klusterlet agent, which registers managed clusters to the hub.
-* Infrastructure Operator, which manages the deployment of the Assisted Service to orchestrate on-premise bare metal and vSphere installations of {product-title}, such as {sno} on bare metal. The Infrastructure Operator includes xref:../edge_computing/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-challenges-of-far-edge-deployments_ztp-deploying-far-edge-clusters-at-scale[{ztp-first}], which fully automates cluster creation on bare metal and vSphere provisioning with GitOps workflows to manage deployments and configuration changes.
+* Infrastructure Operator, which manages the deployment of the Assisted Service to orchestrate on-premise bare metal and vSphere installations of {product-title}, such as {sno} on bare metal. The Infrastructure Operator includes xref:../gitops_ztp/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-challenges-of-far-edge-deployments_ztp-deploying-far-edge-clusters-at-scale[{ztp-first}], which fully automates cluster creation on bare metal and vSphere provisioning with GitOps workflows to manage deployments and configuration changes.
 * Open cluster management, which provides resources to manage Kubernetes clusters.
 
 The multicluster engine is included with your {product-title} support subscription and is delivered separately from the core payload. To start to use multicluster engine, you deploy the {product-title} cluster and then install the operator. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#mce-install-intro[Installing and upgrading multicluster engine operator].

day_2_core_cnf_clusters/_attributes

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

day_2_core_cnf_clusters/images

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

day_2_core_cnf_clusters/modules

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

day_2_core_cnf_clusters/observability/_attributes

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

day_2_core_cnf_clusters/observability/images

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

day_2_core_cnf_clusters/observability/modules

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

day_2_core_cnf_clusters/observability/snippets

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

day_2_core_cnf_clusters/observability/telco-observability.adoc

@@ -0,0 +1,54 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="telco-observability"]
+= Observability in {product-title}
+include::_attributes/common-attributes.adoc[]
+:context: telco-observability
+:imagesdir: images
+
+toc::[]
+
+{product-title} generates a large amount of data, such as performance metrics and logs from both the platform and the workloads running on it. 
+As an administrator, you can use various tools to collect and analyze all the data available.
+What follows is an outline of best practices for system engineers, architects, and administrators configuring the observability stack.
+
+Unless explicitly stated, the material in this document refers to both Edge and Core deployments.
+
+include::modules/telco-observability-monitoring-stack.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../observability/monitoring/about-ocp-monitoring/monitoring-stack-architecture.adoc#understanding-the-monitoring-stack_monitoring-stack-architecture[Understanding the monitoring stack]
+
+// * xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Configuring the monitoring stack]
+// The above assembly is only available in OSD docs. See "_topic_map_osd.yml"
+
+include::modules/telco-observability-key-performance-metrics.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+// * xref:../../observability/monitoring/managing-metrics.adoc#managing-metrics[Managing metrics]
+// // The above assembly is only available in OSD docs. See "_topic_map_osd.yml"
+* xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-local.adoc#local-storage-install_persistent-storage-local[Persistent storage using local volumes]
+* xref:../../scalability_and_performance/telco-ran-du-rds.adoc#cluster-tuning-crs_telco-ran-du[Cluster tuning reference CRs]
+
+include::modules/telco-observability-monitoring-the-edge.adoc[leveloffset=+1]
+
+include::modules/telco-observability-alerting.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc[Managing alerts as an Administrator]
+
+include::modules/telco-observability-workload-monitoring.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[ServiceMonitor[monitoring.coreos.com/v1]]
+
+* 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/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerting-rules-for-user-defined-projects_managing-alerts-as-an-administrator[Managing alerting rules for user-defined projects]