TELCODOCS-1920: Updating RDS for 4.16

Author: rohennes

_topic_maps/_topic_map.yml

@@ -3009,37 +3009,38 @@ Topics:
     File: recommended-infrastructure-practices
   - Name: Recommended etcd practices
     File: recommended-etcd-practices
-# Uncomment on release branch when RDS for that release is published
-# - 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:
-#     - Name: Telco core reference design overview
-#       File: telco-core-rds-overview
-#     - Name: Telco core use model overview
-#       File: telco-core-rds-use-cases
-#     - Name: Core reference design components
-#       File: telco-core-ref-design-components
-#     - Name: Core reference design configuration CRs
-#       File: telco-core-ref-crs
+- 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:
+    - Name: Telco core reference design overview
+      File: telco-core-rds-overview
+    - Name: Telco core use model overview
+      File: telco-core-rds-use-cases
+    - Name: Core reference design components
+      File: telco-core-ref-design-components
+    - Name: Core reference design configuration CRs
+      File: telco-core-ref-crs
+    - Name: Telco core software specifications
+      File: telco-core-ref-software-artifacts
 - Name: Planning your environment according to object maximums
   File: planning-your-environment-according-to-object-maximums
   Distros: openshift-origin,openshift-enterprise

modules/telco-core-cpu-partitioning-performance-tune.adoc

@@ -7,7 +7,7 @@
 = CPU partitioning and performance tuning
 
 New in this release::
-* No reference design updates in this release
+* In this release, {product-title} deployments use Control Groups version 2 (cgroup v2) by default. As a consequence, performance profiles in a cluster use cgroups v2 for the underlying resource management layer. 
 
 Description::
 CPU partitioning allows for the separation of sensitive workloads from generic purposes, auxiliary processes, interrupts, and driver work queues to achieve improved performance and latency. The CPUs allocated to those auxiliary processes are referred to as `reserved` in the following sections. In hyperthreaded systems, a CPU is one hyperthread.
@@ -42,3 +42,4 @@ Engineering considerations::
 * Hardware without Interrupt Request (IRQ) affinity support will impact isolated CPUs. To ensure that pods with guaranteed CPU QoS have full use of allocated CPU, all hardware in the server must support IRQ affinity.
 * OVS dynamically manages its `cpuset` configuration to adapt to network traffic needs.
 You do not need to reserve additional CPUs for handling high network throughput on the primary CNI.
+* If workloads running on the cluster require cgroups v1, you can configure nodes to use cgroups v1. You can make this configuration as part of initial cluster deployment. For more information, see _Enabling Linux cgroup v1 during installation_ in the _Additional resources_ section.

modules/telco-core-crs-networking.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * telco_ref_design_specs/core/telco-core-ref-crs.adoc
+// *
 
 :_mod-docs-content-type: REFERENCE
 [id="networking-crs_{context}"]
@@ -16,14 +16,19 @@ Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#tel
 Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-bfd-profile-yaml[bfd-profile.yaml],No,No
 Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-bgp-advr-yaml[bgp-advr.yaml],No,No
 Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-bgp-peer-yaml[bgp-peer.yaml],No,No
+Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-community-yaml[community.yaml],No,Yes
 Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallb-yaml[metallb.yaml],No,No
 Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallbns-yaml[metallbNS.yaml],Yes,No
 Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallbopergroup-yaml[metallbOperGroup.yaml],Yes,No
 Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallbsubscription-yaml[metallbSubscription.yaml],No,No
 Multus - Tap CNI for rootless DPDK pod,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-mc_rootless_pods_selinux-yaml[mc_rootless_pods_selinux.yaml],No,No
+NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstate-yaml[NMState.yaml],No,Yes
+NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstatens-yaml[NMStateNS.yaml],No,Yes
+NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstateopergroup-yaml[NMStateOperGroup.yaml],No,Yes
+NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstatesubscription-yaml[NMStateSubscription.yaml],No,Yes
 SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovnetwork-yaml[sriovNetwork.yaml],Yes,No
-SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovnetworknodepolicy-yaml[sriovNetworkNodePolicy.yaml],No,Yes
-SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovoperatorconfig-yaml[SriovOperatorConfig.yaml],No,Yes
+SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovnetworknodepolicy-yaml[sriovNetworkNodePolicy.yaml],No,No
+SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovoperatorconfig-yaml[SriovOperatorConfig.yaml],No,No
 SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovsubscription-yaml[SriovSubscription.yaml],No,No
 SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovsubscriptionns-yaml[SriovSubscriptionNS.yaml],No,No
 SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovsubscriptionopergroup-yaml[SriovSubscriptionOperGroup.yaml],No,No

modules/telco-core-crs-other.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * telco_ref_design_specs/core/telco-core-ref-crs.adoc
+// *
 
 :_mod-docs-content-type: REFERENCE
 [id="other-crs_{context}"]
@@ -17,7 +17,7 @@ Cluster logging,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#t
 Cluster logging,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-clusterlogging-yaml[ClusterLogging.yaml],No,No
 Cluster logging,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-clusterlogns-yaml[ClusterLogNS.yaml],No,No
 Cluster logging,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-clusterlogopergroup-yaml[ClusterLogOperGroup.yaml],No,No
-Cluster logging,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-clusterlogsubscription-yaml[ClusterLogSubscription.yaml],No,Yes
+Cluster logging,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-clusterlogsubscription-yaml[ClusterLogSubscription.yaml],No,No
 Disconnected configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-catalog-source-yaml[catalog-source.yaml],No,No
 Disconnected configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-icsp-yaml[icsp.yaml],No,No
 Disconnected configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-operator-hub-yaml[operator-hub.yaml],No,No

modules/telco-core-crs-resource-tuning.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * telco_ref_design_specs/core/telco-core-ref-crs.adoc
+// *
 
 :_mod-docs-content-type: REFERENCE
 [id="resource-tuning-crs_{context}"]

modules/telco-core-crs-scheduling.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * telco_ref_design_specs/core/telco-core-ref-crs.adoc
+// *
 
 :_mod-docs-content-type: REFERENCE
 [id="scheduling-crs_{context}"]
@@ -11,5 +11,9 @@
 |====
 Component,Reference CR,Optional,New in this release
 NUMA-aware scheduler,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nrop-yaml[nrop.yaml],No,No
+NUMA-aware scheduler,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nropsubscription-yaml[NROPSubscription.yaml],No,No
+NUMA-aware scheduler,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nropsubscriptionns-yaml[NROPSubscriptionNS.yaml],No,No
+NUMA-aware scheduler,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nropsubscriptionopergroup-yaml[NROPSubscriptionOperGroup.yaml],No,No
 NUMA-aware scheduler,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sched-yaml[sched.yaml],No,No
+NUMA-aware scheduler,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-scheduler-yaml[Scheduler.yaml],No,Yes
 |====

modules/telco-core-crs-storage.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * telco_ref_design_specs/core/telco-core-ref-crs.adoc
+// *
 
 :_mod-docs-content-type: REFERENCE
 [id="storage-crs_{context}"]
@@ -10,8 +10,9 @@
 [cols="4*", options="header", format=csv]
 |====
 Component,Reference CR,Optional,New in this release
-External {rh-storage-first} configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-01-rook-ceph-external-cluster-details.secret-yaml[01-rook-ceph-external-cluster-details.secret.yaml],No,Yes
-External {rh-storage} configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-02-ocs-external-storagecluster-yaml[02-ocs-external-storagecluster.yaml],No,No
-External {rh-storage} configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-odfns-yaml[odfNS.yaml],No,No
-External {rh-storage} configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-odfopergroup-yaml[odfOperGroup.yaml],No,No
+External ODF configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-01-rook-ceph-external-cluster-details.secret-yaml[01-rook-ceph-external-cluster-details.secret.yaml],No,No
+External ODF configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-02-ocs-external-storagecluster-yaml[02-ocs-external-storagecluster.yaml],No,No
+External ODF configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-odfns-yaml[odfNS.yaml],No,No
+External ODF configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-odfopergroup-yaml[odfOperGroup.yaml],No,No
+External ODF configuration,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-odfsubscription-yaml[odfSubscription.yaml],No,No
 |====

modules/telco-core-installation.adoc

@@ -8,6 +8,8 @@
 
 New in this release::
 
+* No reference design updates in this release
+
 
 Description::
 

modules/telco-core-ref-design-baseline-model.adoc

@@ -14,6 +14,7 @@ The cluster conforms to these requirements:
 
 * High-availability (3+ supervisor nodes) control plane
 * Non-schedulable supervisor nodes
+* Multiple `MachineConfigPool` resources
 
 Storage::
 
@@ -38,7 +39,7 @@ Core clusters have multiple layers of networking supported by underlying RHCOS,
 
 ** Host interface configuration
 
-** A/A Bonding (Link Aggregation Control Protocol (LACP))
+** Active/Active Bonding (Link Aggregation Control Protocol (LACP))
 
 * Secondary or additional networks: OpenShift CNI is configured through the Network `additionalNetworks` or NetworkAttachmentDefinition CRs.
 

modules/telco-core-software-stack.adoc

@@ -0,0 +1,28 @@
+// Module included in the following assemblies:
+//
+// * telco_ref_design_specs/ran/telco-core-ref-components.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="telco-core-software-stack_{context}"]
+= Software stack
+
+
+The following software versions were used for validating the telco core reference design specification:
+
+.Software versions for validation
+[cols="1,1"]
+|===
+|Component |Software version
+
+|Cluster Logging Operator |5.9.1
+
+|{rh-storage} |4.16
+
+|SR-IOV Operator |4.16
+
+|MetalLB | 4.16
+
+|NMState Operator |4.16
+
+|NUMA-aware scheduler|4.16
+|===