Merge pull request #100501 from slovern/TELCODOCS-2327

TELCODOCS-2327 - TELCO RAN RDS updates for 4.20

Author: slovern

modules/telco-ran-crs-cluster-tuning.adoc

@@ -11,12 +11,12 @@
 |====
 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,`DisconnectedIDMS.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
+Console disable,`cluster-tuning/console-disable/ConsoleOperatorDisable.yaml`,Disables the Console Operator.,No
+Disconnected registry,`extra-manifest/09-openshift-marketplace-ns.yaml`,Defines a dedicated namespace for managing the OpenShift Operator Marketplace.,No
+Disconnected registry,`disconnected-registry/DefaultCatsrc.yaml`,Configures the catalog source for the disconnected registry.,No
+Disconnected registry,`cluster-tuning/DisableOLMPprof.yaml`,Disables performance profiling for OLM.,No
+Disconnected registry,`disconnected-registry/DisconnectedIDMS.yaml`,Configures disconnected registry image content source policy.,No
+Disconnected registry,`cluster-tuning/operator-hub/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,`cluster-tuning/monitoring-configuration/ReduceMonitoringFootprint.yaml`,"Reduces the monitoring footprint by disabling Alertmanager and Telemeter, and sets Prometheus retention to 24 hours",No
+Network diagnostics disable,`cluster-tuning/disabling-network-diagnostics/DisableSnoNetworkDiag.yaml`,Configures the cluster network settings to disable built-in network troubleshooting and diagnostic features.,No
 |====

modules/telco-ran-crs-day-2-operators.adoc

@@ -10,20 +10,20 @@
 [cols="4*", options="header", format=csv]
 |====
 Component,Reference CR,Description,Optional
-Container runtime (crun),`enable-crun-master.yaml`,Configures the container runtime (crun) for control plane nodes.,No
-Container runtime (crun),`enable-crun-worker.yaml`,Configures the container runtime (crun) for worker nodes.,No
-CRI-O wipe disable,`99-crio-disable-wipe-master.yaml`,Disables automatic CRI-O cache wipe following a reboot for on control plane nodes.,No
-CRI-O wipe disable,`99-crio-disable-wipe-worker.yaml`,Disables automatic CRI-O cache wipe following a reboot for on worker nodes.,No
-Kdump enable,`06-kdump-master.yaml`,Configures kdump crash reporting on control plane nodes.,No
-Kdump enable,`06-kdump-worker.yaml`,Configures kdump crash reporting on worker nodes.,No
-Kubelet configuration and container mount hiding,`01-container-mount-ns-and-kubelet-conf-master.yaml`,Configures a mount namespace for sharing container-specific mounts between kubelet and CRI-O on control plane nodes.,No
-Kubelet configuration and container mount hiding,`01-container-mount-ns-and-kubelet-conf-worker.yaml`,Configures a mount namespace for sharing container-specific mounts between kubelet and CRI-O on worker nodes.,No
-One-shot time sync,`99-sync-time-once-master.yaml`,Synchronizes time once on control plane nodes.,No
-One-shot time sync,`99-sync-time-once-worker.yaml`,Synchronizes time once on worker nodes.,No
-SCTP,`03-sctp-machine-config-master.yaml`,Loads the SCTP kernel module on control plane nodes.,Yes
-SCTP,`03-sctp-machine-config-worker.yaml`,Loads the SCTP kernel module on worker nodes.,Yes
-Set RCU normal,`08-set-rcu-normal-master.yaml`,Disables rcu_expedited by setting rcu_normal after the control plane node has booted.,No
-Set RCU normal,`08-set-rcu-normal-worker.yaml`,Disables rcu_expedited by setting rcu_normal after the worker node has booted.,No
-SRIOV-related kernel arguments,`07-sriov-related-kernel-args-master.yaml`,Enables SR-IOV support on control plane nodes.,No
-SRIOV-related kernel arguments,`07-sriov-related-kernel-args-worker.yaml`,Enables SR-IOV support on worker nodes.,No
+Container runtime (crun),`optional-extra-manifest/enable-crun-master.yaml`,Configures the container runtime (crun) for control plane nodes.,No
+Container runtime (crun),`optional-extra-manifest/enable-crun-worker.yaml`,Configures the container runtime (crun) for worker nodes.,No
+CRI-O wipe disable,`extra-manifest/99-crio-disable-wipe-master.yaml`,Disables automatic CRI-O cache wipe following a reboot for on control plane nodes.,No
+CRI-O wipe disable,`extra-manifest/99-crio-disable-wipe-worker.yaml`,Disables automatic CRI-O cache wipe following a reboot for on worker nodes.,No
+Kdump enable,`extra-manifest/06-kdump-master.yaml`,Configures kdump crash reporting on master nodes.,No
+Kdump enable,`extra-manifest/06-kdump-worker.yaml`,Configures kdump crash reporting on worker nodes.,No
+Kubelet configuration and container mount hiding,`extra-manifest/01-container-mount-ns-and-kubelet-conf-master.yaml`,Configures a mount namespace for sharing container-specific mounts between kubelet and CRI-O on control plane nodes.,No
+Kubelet configuration and container mount hiding,`extra-manifest/01-container-mount-ns-and-kubelet-conf-worker.yaml`,Configures a mount namespace for sharing container-specific mounts between kubelet and CRI-O on worker nodes.,No
+One-shot time sync,`extra-manifest/99-sync-time-once-master.yaml`,Synchronizes time once on master nodes.,No
+One-shot time sync,`extra-manifest/99-sync-time-once-worker.yaml`,Synchronizes time once on worker nodes.,No
+SCTP,`extra-manifest/03-sctp-machine-config-master.yaml`,Loads the SCTP kernel module on master nodes.,Yes
+SCTP,`extra-manifest/03-sctp-machine-config-worker.yaml`,Loads the SCTP kernel module on worker nodes.,Yes
+Set RCU normal,`extra-manifest/08-set-rcu-normal-master.yaml`,Disables rcu_expedited by setting rcu_normal after the control plane node has booted.,No
+Set RCU normal,`extra-manifest/08-set-rcu-normal-worker.yaml`,Disables rcu_expedited by setting rcu_normal after the worker node has booted.,No
+SRIOV-related kernel arguments,`extra-manifest/07-sriov-related-kernel-args-master.yaml`,Enables SR-IOV support on master nodes.,No
+SRIOV-related kernel arguments,`extra-manifest/07-sriov-related-kernel-args-worker.yaml`,Enables SR-IOV support on worker nodes.,No
 |====

modules/telco-ran-crs-machine-configuration.adoc

@@ -80,7 +80,7 @@ Workloads::
 . DU worker nodes are Intel 3rd Generation Xeon (IceLake) 2.20 GHz or newer with host firmware tuned for maximum performance.
 
 Resources::
-The maximum number of running pods in the system, inclusive of application workload and {product-title} pods, is 120.
+The maximum number of running pods in the system, inclusive of application workload and {product-title} pods, is 160.
 
 Resource utilization::
 +
@@ -109,10 +109,10 @@ You might need to allocate additional cluster resources to meet these requiremen
 --
 
 Reference application workload characteristics::
-. Uses 15 pods and 30 containers for the vRAN application including its management and control functions
-. Uses an average of 2 `ConfigMap` and 4 `Secret` CRs per pod
-. Uses a maximum of 10 exec probes with a frequency of not less than 10 seconds
-. Incremental application load on the kube-apiserver is less than or equal to 10% of the cluster platform usage
+. Uses 75 pods across 5 namespaces with 4 containers per pod for the vRAN application including its management and control functions
+. Creates 30 `ConfigMap` CRs and 30 `Secret` CRs per namespace
+. Uses no exec probes
+. Uses a secondary network
 +
 [NOTE]
 ====
@@ -124,7 +124,7 @@ $ query=avg_over_time(pod:container_cpu_usage:sum{namespace="openshift-kube-apis
 ----
 ====
 . Application logs are not collected by the platform log collector.
-. Aggregate traffic on the primary CNI is less than 8 Mbps
+. Aggregate traffic on the primary CNI is up to 30 Mbps and up to 5 Gbps on the secondary network
 
 Hub cluster management characteristics::
 +

modules/telco-ran-engineering-considerations-for-the-ran-du-use-model.adoc

@@ -8,7 +8,7 @@
 = GitOps Operator and {ztp}
 
 New in this release::
-* https://issues.redhat.com/browse/CNF-9183[GA support for ACM PolicyGenerator with gitops/ZTP (as recommended reference)]
+* No reference design updates in this release
 
 Description::
 +

modules/telco-ran-gitops-operator-and-ztp-plugins.adoc

@@ -35,7 +35,9 @@ Limits and requirements::
 * Log reduction must be enabled with `true` or `enhanced`.
 
 Engineering considerations::
-* RAN DU RDS configurations are provided for ordinary clocks, boundary clocks, grandmaster clocks, and highly available dual NIC boundary clocks.
+* * Example RAN DU RDS configurations are provided for:
+** T-GM, T-BC, and T-TSC
+** Variations with and without HA
 * PTP fast event notifications use `ConfigMap` CRs to persist subscriber details.
 * Hierarchical event subscription as described in the O-RAN specification is not supported for PTP events.
 * The PTP fast events REST API v1 is end of life.

modules/telco-ran-ptp-operator.adoc

@@ -23,7 +23,7 @@ You manage cluster configuration and upgrades declaratively by applying `Policy`
 
 The recommended method for {sno} cluster installation is the image-based installation approach, available in MCE, using the `ClusterInstance` CR for cluster definition.
 
-The recommended method for {sno} cluster upgrade is the image-based upgrade method.
+Image-based upgrade is the recommended method for {sno} cluster upgrade.
 --
 
 Limits and requirements::

modules/telco-ran-red-hat-advanced-cluster-management-rhacm.adoc

@@ -7,7 +7,7 @@
 = SR-IOV Operator
 
 New in this release::
-* https://issues.redhat.com/browse/CNF-12813[Support moving failed policy in resource injector to failed for SR-IOV operator]
+* No reference design updates in this release
 
 Description::
 The SR-IOV Operator provisions and configures the SR-IOV CNI and device plugins.

modules/telco-ran-sr-iov-operator.adoc

@@ -18,13 +18,6 @@ Following the RDS minimizes high severity escalations and improves application s
 5G use cases are evolving and your workloads are continually changing.
 Red Hat is committed to iterating over the telco core and RAN DU RDS to support evolving requirements based on customer and partner feedback.
 
-[NOTE]
-====
-Support for an ARM based platform is currently a Developer Preview feature for {product-title} 4.19.
-All information is subject to change on release.
-For more details, see the following Red Hat knowledge base article : https://access.redhat.com/articles/7118870[How to use ARM platform hardware in OpenShift 4.19 Telco RDS (Developer Preview)]
-====
-
 The reference configuration includes the configuration of the far edge clusters and hub cluster components.
 
 The reference configurations in this document are deployed using a centrally managed hub cluster infrastructure as shown in the following image.

modules/telco-ref-design-overview.adoc

@@ -18,24 +18,23 @@ The Red Hat telco RAN DU {product-version} solution has been validated using the
 |4.19
 
 |Cluster Logging Operator
-|6.2^1^
+|6.2
 
 |Local Storage Operator
-|4.19
+|4.20
 
 |OpenShift API for Data Protection (OADP)
 |1.5
 
 |PTP Operator
-|4.19
+|4.20
 
 |SR-IOV Operator
-|4.19
+|4.20
 
 |SRIOV-FEC Operator
 |2.11
 
 |Lifecycle Agent
-|4.19
+|4.20
 |====
-[1] This table will be updated when the aligned Cluster Logging Operator version 6.3 is released.