Merge pull request #88547 from aireilly/ran-rds-418

TELCODOCS-2045 - Telco RAN DU RDS 4.18 docs

Author: aireilly

_topic_maps/_topic_map.yml

@@ -3279,25 +3279,17 @@ Topics:
     File: recommended-infrastructure-practices
   - Name: Recommended etcd practices
     File: recommended-etcd-practices
+- Name: Telco RAN DU reference design
+  Dir: telco_ran_du_ref_design_specs
+  Topics:
+  - Name: Telco RAN DU RDS
+    File: telco-ran-du-rds
 - Name: Reference design specifications
   Dir: telco_ref_design_specs
   Distros: openshift-origin,openshift-enterprise
   Topics:
   - Name: Telco reference design specifications
     File: telco-ref-design-specs-overview
-  - Name: Telco RAN DU reference design specification
-    Dir: ran
-    Topics:
-    - Name: Telco RAN DU reference design overview
-      File: telco-ran-ref-design-spec
-    - Name: Telco RAN DU use model overview
-      File: telco-ran-du-overview
-    - Name: RAN DU reference design components
-      File: telco-ran-ref-du-components
-    - Name: RAN DU reference design configuration CRs
-      File: telco-ran-ref-du-crs
-    - Name: Telco RAN DU software specifications
-      File: telco-ran-ref-software-artifacts
   - Name: Telco core reference design specification
     Dir: core
     Topics:

edge_computing/day_2_core_cnf_clusters/observability/telco-observability.adoc

@@ -28,8 +28,8 @@ include::modules/telco-observability-key-performance-metrics.adoc[leveloffset=+1
 .Additional resources
 
 * xref:../../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#accessing-metrics-as-an-administrator[Accessing metrics as an administrator]
+
 * 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_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#cluster-tuning-crs_ran-ref-design-crs[Cluster tuning reference CRs]
 
 include::modules/telco-observability-monitoring-the-edge.adoc[leveloffset=+1]
 

images/telco-ran-du-reference-design-components.png

@@ -14,7 +14,7 @@ The {cmo-first} is included by default in {product-title} and provides monitorin
 +
 [NOTE]
 ====
-The default handling of pod CPU and memory metrics is based on upstream Kubernetes `cAdvisor` and makes a tradeoff that prefers handling of stale data over metric accuracy. This leads to spiky data that will create false triggers of alerts over user-specified thresholds. OpenShift supports an opt-in dedicated service monitor feature creating an additional set of pod CPU and memory metrics that do not suffer from the spiky behavior.
+The default handling of pod CPU and memory metrics is based on upstream Kubernetes `cAdvisor` and makes a tradeoff that prefers handling of stale data over metric accuracy. This leads to spiky data that will create false triggers of alerts over user-specified thresholds. {product-title} supports an opt-in dedicated service monitor feature creating an additional set of pod CPU and memory metrics that do not suffer from the spiky behavior.
 For additional information, see link:https://access.redhat.com/solutions/7012719[Dedicated Service Monitors - Questions and Answers].
 ====
 

modules/telco-core-monitoring.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
-// * telco_ref_design_specs/ran/telco-ran-ref-design-spec.adoc
+// * scalability_and_performance/telco_ran_du_ref_design_specs/telco-ran-du-rds.adoc
+// * scalability_and_performance/telco_ref_design_specs/telco-ref-design-specs-overview.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="telco-deviations-from-the-ref-design_{context}"]

modules/telco-deviations-from-the-ref-design.adoc

@@ -1,35 +1,25 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-design-components.adoc
-// * scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-components.adoc
+// * scalability_and_performance/telco_ran_du_ref_design_specs/telco-ran-du-rds.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="telco-ran-agent-based-installer-abi_{context}"]
-= Agent-based installer
+= Agent-based Installer
 
 New in this release::
 * No reference design updates in this release
 
 Description::
-Agent-based installer (ABI) provides installation capabilities without centralized infrastructure.
+The optional Agent-based Installer component provides installation capabilities without centralized infrastructure.
 The installation program creates an ISO image that you mount to the server.
 When the server boots it installs {product-title} and supplied extra manifests.
-+
-[NOTE]
-====
-You can also use ABI to install {product-title} clusters without a hub cluster.
-An image registry is still required when you use ABI in this manner.
-====
-
-Agent-based installer (ABI) is an optional component.
+The Agent-based Installer allows you to install {product-title} without a hub cluster.
+A container image registry is required for cluster installation.
 
 Limits and requirements::
 * You can supply a limited set of additional manifests at installation time.
-
 * You must include `MachineConfiguration` CRs that are required by the RAN DU use case.
 
 Engineering considerations::
-
-* ABI provides a baseline {product-title} installation.
-
+* The Agent-based Installer provides a baseline {product-title} installation.
 * You install Day 2 Operators and the remainder of the RAN DU use case configurations after installation.

modules/telco-ran-agent-based-installer-abi.adoc

@@ -1,29 +1,34 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-components.adoc
+// * scalability_and_performance/telco_ran_du_ref_design_specs/telco-ran-du-rds.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="telco-ran-bios-tuning_{context}"]
 = Host firmware tuning
 
 New in this release::
-//CNF-2026
-* You can now configure host firmware settings for managed clusters that you deploy with {ztp}.
+* No reference design updates in this release
 
 Description::
 Tune host firmware settings for optimal performance during initial cluster deployment.
-The managed cluster host firmware settings are available on the hub cluster as `BareMetalHost` custom resources (CRs) that are created when you deploy the managed cluster with the `SiteConfig` CR and {ztp}.
+For more information, see "Recommended {sno} cluster configuration for vDU application workloads".
+Apply tuning settings in the host firmware during initial deployment.
+See "Managing host firmware settings with {ztp}" for more information.
+The managed cluster host firmware settings are available on the hub cluster as individual `BareMetalHost` custom resources (CRs) that are created when you deploy the managed cluster with the `ClusterInstance` CR and {ztp}.
++
+[NOTE]
+====
+Create the `ClusterInstance` CR based on the provided reference `example-sno.yaml` CR.
+====
 
 Limits and requirements::
-* Hyperthreading must be enabled
+* You must enable Hyper-Threading in the host firmware settings
 
 Engineering considerations::
-* Tune all settings for maximum performance.
-
+* Tune all firmware settings for maximum performance.
 * All settings are expected to be for maximum performance unless tuned for power savings.
-
 * You can tune host firmware for power savings at the expense of performance as required.
-
+// https://issues.redhat.com/browse/CNF-11806
 * Enable secure boot.
-With secure boot enabled, only signed kernel modules are loaded by the kernel.
+When secure boot is enabled, only signed kernel modules are loaded by the kernel.
 Out-of-tree drivers are not supported.

modules/telco-ran-bios-tuning.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-components.adoc
+// * scalability_and_performance/telco_ran_du_ref_design_specs/telco-ran-du-rds.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="telco-ran-cluster-tuning_{context}"]
@@ -10,14 +10,25 @@ New in this release::
 * No reference design updates in this release
 
 Description::
-See "Cluster capabilities" for a full list of optional components that you can enable or disable before installation.
+See "Cluster capabilities" for a full list of components that can be disabled by using the cluster capabilities feature.
 
 Limits and requirements::
 * Cluster capabilities are not available for installer-provisioned installation methods.
 
-* You must apply all platform tuning configurations.
-The following table lists the required platform tuning configurations:
+Engineering considerations::
+* In clusters running {product-title} 4.16 and later, the cluster does not automatically revert to cgroup v1 when a `PerformanceProfile` is applied.
+If workloads running on the cluster require cgroup v1, the cluster must be configured for cgroup v1.
+For more information, see "Enabling Linux control group version 1 (cgroup v1)".
+You should make this configuration as part of the initial cluster deployment.
 +
+[NOTE]
+====
+Support for cgroup v1 is planned for removal in {product-title} 4.19.
+Clusters running cgroup v1 must transition to cgroup v2.
+====
+
+The following table lists the required platform tuning configurations:
+
 .Cluster capabilities configurations
 [cols=2*, width="90%", options="header"]
 |====
@@ -27,7 +38,7 @@ The following table lists the required platform tuning configurations:
 |Remove optional cluster capabilities
 a|Reduce the {product-title} footprint by disabling optional cluster Operators on {sno} clusters only.
 
-* Remove all optional Operators except the Marketplace and Node Tuning Operators.
+* Remove all optional Operators except the Node Tuning Operator, Operator Lifecycle Manager, and the Ingress Operator.
 
 |Configure cluster monitoring
 a|Configure the monitoring stack for reduced footprint by doing the following:
@@ -55,12 +66,3 @@ Using a single `CatalogSource` fits within the platform CPU budget.
 |If the cluster was deployed with the console disabled, the `Console` CR (`ConsoleOperatorDisable.yaml`) is not needed.
 If the cluster was deployed with the console enabled, you must apply the `Console` CR.
 |====
-
-Engineering considerations::
-* In {product-title} 4.16 and later, clusters do not automatically revert to cgroups v1 when a `PerformanceProfile` CR is applied.
-If workloads running on the cluster require cgroups v1, you need to configure the cluster to use cgroups v1.
-+
-[NOTE]
-====
-If you need to configure cgroups v1, make the configuration as part of the initial cluster deployment.
-====

modules/telco-ran-cluster-tuning.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
-// * telco_ref_design_specs/ran/telco-ran-ref-design-spec.adoc
+// * scalability_and_performance/telco_ran_du_ref_design_specs/telco-ran-du-rds.adoc
+// * scalability_and_performance/telco_ref_design_specs/telco-ref-design-specs-overview.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="telco-ran-core-ref-design-spec_{context}"]

modules/telco-ran-core-ref-design-spec.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc
+// * scalability_and_performance/telco_ran_du_ref_design_specs/telco-ran-du-rds.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="cluster-tuning-crs_{context}"]
@@ -9,14 +9,14 @@
 .Cluster tuning CRs
 [cols="4*", options="header", format=csv]
 |====
-Component,Reference CR,Optional,New in this release
-Composable OpenShift,xref:../../telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#ztp-example-sno-yaml[example-sno.yaml],No,No
-Console disable,xref:../../telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#ztp-consoleoperatordisable-yaml[ConsoleOperatorDisable.yaml],Yes,No
-Disconnected registry,xref:../../telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#ztp-09-openshift-marketplace-ns-yaml[09-openshift-marketplace-ns.yaml],No,No
-Disconnected registry,xref:../../telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#ztp-defaultcatsrc-yaml[DefaultCatsrc.yaml],No,No
-Disconnected registry,xref:../../telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#ztp-disableolmpprof-yaml[DisableOLMPprof.yaml],No,No
-Disconnected registry,xref:../../telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#ztp-disconnectedicsp-yaml[DisconnectedICSP.yaml],No,No
-Disconnected registry,xref:../../telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#ztp-operatorhub-yaml[OperatorHub.yaml],"OperatorHub is required for {sno} and optional for multi-node clusters",No
-Monitoring configuration,xref:../../telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#ztp-reducemonitoringfootprint-yaml[ReduceMonitoringFootprint.yaml],No,No
-Network diagnostics disable,xref:../../telco_ref_design_specs/ran/telco-ran-ref-du-crs.adoc#ztp-disablesnonetworkdiag-yaml[DisableSnoNetworkDiag.yaml],No,No
+Component,Reference CR,Description,Optional
+Cluster capabilities,`example-sno.yaml`,Representative SiteConfig CR to install single-node OpenShift with the RAN DU profile,No
+Console disable,`ConsoleOperatorDisable.yaml`,Disables the Console Operator.,No
+Disconnected registry,`09-openshift-marketplace-ns.yaml`,Defines a dedicated namespace for managing the OpenShift Operator Marketplace.,No
+Disconnected registry,`DefaultCatsrc.yaml`,Configures the catalog source for the disconnected registry.,No
+Disconnected registry,`DisableOLMPprof.yaml`,Disables performance profiling for OLM.,No
+Disconnected registry,`DisconnectedICSP.yaml`,Configures disconnected registry image content source policy.,No
+Disconnected registry,`OperatorHub.yaml`,"Optional, for multi-node clusters only. Configures the OperatorHub in OpenShift, disabling all default Operator sources. Not required for single-node OpenShift installs with marketplace capability disabled.",No
+Monitoring configuration,`ReduceMonitoringFootprint.yaml`,"Reduces the monitoring footprint by disabling Alertmanager and Telemeter, and sets Prometheus retention to 24 hours",No
+Network diagnostics disable,`DisableSnoNetworkDiag.yaml`,Configures the cluster network settings to disable built-in network troubleshooting and diagnostic features.,No
 |====