Merge pull request #106584 from kquinn1204/TELCODOCS-2725-dita-rewrite-telco-ran-du-rds

slovern · web-flow · commit 2791ccbb436c · 2026-04-15T13:54:09.000+01:00
TELCODOCS-2725: fix(telco-ran-du-rds): DITA compatibility fixes for all modules
diff --git a/modules/telco-ran-agent-based-installer-abi.adoc b/modules/telco-ran-agent-based-installer-abi.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-agent-based-installer-abi_{context}"]
 = Agent-based installer
 
+[role="_abstract"]
+The optional Agent-based Installer component provides installation capabilities without centralized infrastructure.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-bios-tuning.adoc b/modules/telco-ran-bios-tuning.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-bios-tuning_{context}"]
 = Host firmware tuning
 
+[role="_abstract"]
+Tune host firmware settings for optimal performance during initial cluster deployment.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-cluster-tuning.adoc b/modules/telco-ran-cluster-tuning.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-cluster-tuning_{context}"]
 = Cluster tuning
 
+[role="_abstract"]
+Configure cluster tuning settings including cluster capabilities and monitoring for the telco RAN DU reference design.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-crs-cluster-tuning.adoc b/modules/telco-ran-crs-cluster-tuning.adoc
@@ -6,6 +6,9 @@
 [id="cluster-tuning-crs_{context}"]
 = Cluster tuning reference CRs
 
+[role="_abstract"]
+Use the following custom resources (CRs) to configure cluster tuning for the telco RAN DU reference design.
+
 .Cluster tuning CRs
 [cols="4*", options="header", format=csv]
 |====
diff --git a/modules/telco-ran-crs-day-2-operators.adoc b/modules/telco-ran-crs-day-2-operators.adoc
@@ -6,6 +6,9 @@
 [id="day-2-operators-crs_{context}"]
 = Day 2 Operators reference CRs
 
+[role="_abstract"]
+Use the following custom resources (CRs) to configure Day 2 Operators for the telco RAN DU reference design.
+
 .Day 2 Operators CRs
 [cols="4*", options="header", format=csv]
 |====
diff --git a/modules/telco-ran-crs-machine-configuration.adoc b/modules/telco-ran-crs-machine-configuration.adoc
@@ -6,6 +6,9 @@
 [id="machine-configuration-crs_{context}"]
 = Machine configuration reference CRs
 
+[role="_abstract"]
+Use the following custom resources (CRs) to configure machine settings for the telco RAN DU reference design.
+
 .Machine configuration CRs
 [cols="4*", options="header", format=csv]
 |====
diff --git a/modules/telco-ran-du-application-workloads.adoc b/modules/telco-ran-du-application-workloads.adoc
@@ -7,6 +7,7 @@
 [id="telco-ran-du-application-workloads_{context}"]
 = Telco RAN DU application workloads
 
+[role="_abstract"]
 Develop RAN DU applications that are subject to the following requirements and limitations.
 
 Description and limits::
diff --git a/modules/telco-ran-du-deployment-components.adoc b/modules/telco-ran-du-deployment-components.adoc
@@ -0,0 +1,10 @@
+// Module included in the following assemblies:
+//
+// * scalability_and_performance/telco-ran-du-rds.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="telco-ran-du-deployment-components_{context}"]
+= Telco RAN DU deployment components
+
+[role="_abstract"]
+The following sections describe the various {product-title} components and configurations that you use to configure the hub cluster with {rh-rhacm}.
diff --git a/modules/telco-ran-du-reference-configuration-crs.adoc b/modules/telco-ran-du-reference-configuration-crs.adoc
@@ -0,0 +1,17 @@
+// Module included in the following assemblies:
+//
+// * scalability_and_performance/telco-ran-du-rds.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="telco-ran-du-reference-configuration-crs_{context}"]
+= Telco RAN DU reference configuration CRs
+
+[role="_abstract"]
+Use the following custom resources (CRs) to configure and deploy {product-title} clusters with the telco RAN DU profile.
+Use the CRs to form the common baseline used in all the specific use models unless otherwise indicated.
+
+[NOTE]
+====
+You can extract the complete set of RAN DU CRs from the `ztp-site-generate` container image.
+See "Preparing the {ztp} site configuration repository" for more information.
+====
diff --git a/modules/telco-ran-du-reference-design-components.adoc b/modules/telco-ran-du-reference-design-components.adoc
@@ -7,6 +7,7 @@
 [id="telco-ran-du-reference-design-components_{context}"]
 = Telco RAN DU reference design components
 
+[role="_abstract"]
 The following sections describe the various {product-title} components and configurations that you use to configure and deploy clusters to run RAN DU workloads.
 
 .Telco RAN DU reference design components
diff --git a/modules/telco-ran-engineering-considerations-for-the-ran-du-use-model.adoc b/modules/telco-ran-engineering-considerations-for-the-ran-du-use-model.adoc
@@ -6,6 +6,7 @@
 [id="telco-ran-engineering-considerations-for-the-ran-du-use-model_{context}"]
 = Engineering considerations for the RAN DU use model
 
+[role="_abstract"]
 The RAN DU use model configures an {product-title} cluster running on commodity hardware for hosting RAN distributed unit (DU) workloads.
 Model and system level considerations are described below.
 Specific limits, requirements and engineering considerations for individual components are detailed in later sections.
diff --git a/modules/telco-ran-gitops-operator-and-ztp-plugins.adoc b/modules/telco-ran-gitops-operator-and-ztp-plugins.adoc
@@ -7,6 +7,9 @@
 [id="telco-ran-gitops-operator-and-ztp-plugins_{context}"]
 = GitOps Operator and {ztp}
 
+[role="_abstract"]
+GitOps Operator and {ztp} provide a GitOps-based infrastructure for managing cluster deployment and configuration.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-lca-operator.adoc b/modules/telco-ran-lca-operator.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-lca-operator_{context}"]
 = Lifecycle Agent
 
+[role="_abstract"]
+The Lifecycle Agent provides local lifecycle management services for image-based upgrade of {sno} clusters.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-local-storage-operator.adoc b/modules/telco-ran-local-storage-operator.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-local-storage-operator_{context}"]
 = Local Storage Operator
 
+[role="_abstract"]
+You can create persistent volumes that can be used as `PVC` resources by applications with the Local Storage Operator.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-logging.adoc b/modules/telco-ran-logging.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-logging_{context}"]
 = Logging
 
+[role="_abstract"]
+Use logging to collect logs from the far edge node for remote analysis.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-lvms-operator.adoc b/modules/telco-ran-lvms-operator.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-lvms-operator_{context}"]
 = Logical Volume Manager Storage
 
+[role="_abstract"]
+{lvms-first} provides dynamic provisioning of block and file storage by creating logical volumes from local devices that can be consumed as persistent volume claim (PVC) resources by applications.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-machine-configuration.adoc b/modules/telco-ran-machine-configuration.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-machine-configuration_{context}"]
 = Machine configuration
 
+[role="_abstract"]
+Configure machine configuration settings for container runtime, kubelet, SCTP, kdump, and other system-level components in the telco RAN DU reference design.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-node-tuning-operator.adoc b/modules/telco-ran-node-tuning-operator.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-node-tuning-operator_{context}"]
 = CPU partitioning and performance tuning
 
+[role="_abstract"]
+The RAN DU use model includes cluster performance tuning using `PerformanceProfile` CRs for low-latency performance, and a `TunedPerformancePatch` CR that adds additional RAN-specific tuning.
+
 New in this release::
 * There is now optional support for `acpi_idle` CPUIdle driver.
 * Updates to `TunedPerformancePatch` to enable the triggering a kernel panic for system recovery and diagnostic purposes when x86_64 architecture nodes become unresponsive. The `TunedPerformancePatch` configures the `kernel.panic_on_unrecovered_nmi` sysctl parameter to enable triggering a kernel panic through BMC Non-Maskable Interrupt (NMI) on x86_64 architectures.
diff --git a/modules/telco-ran-ptp-operator.adoc b/modules/telco-ran-ptp-operator.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-ptp-operator_{context}"]
 = PTP Operator
 
+[role="_abstract"]
+Configure Precision Time Protocol (PTP) in cluster nodes to ensure precise timing and reliability in the RAN environment.
+
 New in this release::
 * {product-title} 4.20 introduced unassisted holdover for boundary clocks and time synchronous clocks as a Technology Preview feature. This feature is now Generally Available (GA).
 
diff --git a/modules/telco-ran-red-hat-advanced-cluster-management-rhacm.adoc b/modules/telco-ran-red-hat-advanced-cluster-management-rhacm.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-red-hat-advanced-cluster-management-rhacm_{context}"]
 = Red Hat Advanced Cluster Management
 
+[role="_abstract"]
+{rh-rhacm} provides Multi Cluster Engine (MCE) installation and ongoing lifecycle management functionality for deployed clusters.
+
 New in this release::
 * The CRI-O wipe disable `MachineConfig` CR is no longer needed as cri-o now handles unclean shutdowns by performing a quick check and repair.
 
diff --git a/modules/telco-ran-siteconfig-operator.adoc b/modules/telco-ran-siteconfig-operator.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-siteconfig-operator_{context}"]
 = SiteConfig Operator
 
+[role="_abstract"]
+The SiteConfig Operator is a template-driven solution designed to provision clusters through various installation methods.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-sr-iov-operator.adoc b/modules/telco-ran-sr-iov-operator.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-sr-iov-operator_{context}"]
 = SR-IOV Operator
 
+[role="_abstract"]
+The SR-IOV Operator provisions and configures the SR-IOV CNI and device plugins.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-sriov-fec-operator.adoc b/modules/telco-ran-sriov-fec-operator.adoc
@@ -7,6 +7,9 @@
 [id="telco-ran-sriov-fec-operator_{context}"]
 = SRIOV-FEC Operator
 
+[role="_abstract"]
+SRIOV-FEC Operator is an optional 3rd party Certified Operator supporting FEC accelerator hardware.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-sysctls.adoc b/modules/telco-ran-sysctls.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-sysctls_{context}"]
 = Kubelet Settings
 
+[role="_abstract"]
+Configure kubelet settings and sysctls for the telco RAN DU use model, including `systemReserved` and unsafe sysctl parameters.
+
 New in this release::
 Support for configuring `systemReserved` settings (cpu and memory).
 
diff --git a/modules/telco-ran-topology-aware-lifecycle-manager-talm.adoc b/modules/telco-ran-topology-aware-lifecycle-manager-talm.adoc
@@ -7,6 +7,9 @@
 [id="telco-ran-topology-aware-lifecycle-manager-talm_{context}"]
 = Topology Aware Lifecycle Manager
 
+[role="_abstract"]
+{cgu-operator} manages how changes like cluster upgrades, Operator upgrades, and cluster configuration are rolled out to the network.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ran-workload-partitioning.adoc b/modules/telco-ran-workload-partitioning.adoc
@@ -6,6 +6,9 @@
 [id="telco-ran-workload-partitioning_{context}"]
 = Workload partitioning
 
+[role="_abstract"]
+Workload partitioning pins {product-title} and Day 2 Operator pods that are part of the DU profile to the reserved CPU set and removes the reserved CPU from node accounting.
+
 New in this release::
 * No reference design updates in this release
 
diff --git a/modules/telco-ref-design-overview.adoc b/modules/telco-ref-design-overview.adoc
@@ -7,6 +7,7 @@
 [id="telco-ref-design-overview_{context}"]
 = Reference design specifications for telco RAN DU 5G deployments
 
+[role="_abstract"]
 Red Hat and certified partners offer deep technical expertise and support for networking and operational capabilities required to run telco applications on {product-title} {product-version} clusters.
 
 Red Hat's telco partners require a well-integrated, well-tested, and stable environment that can be replicated at scale for enterprise 5G solutions.
diff --git a/modules/using-cluster-compare-telco-ran.adoc b/modules/using-cluster-compare-telco-ran.adoc
@@ -12,6 +12,7 @@
 [id="using-cluster-compare-telco-ran_{context}"]
 = Comparing a cluster with the {rds} reference configuration
 
+[role="_abstract"]
 After you deploy a {rds} cluster, you can use the `cluster-compare` plugin to assess the cluster's compliance with the {rds} reference design specifications (RDS). The `cluster-compare` plugin is an OpenShift CLI (`oc`) plugin. The plugin uses a {rds} reference configuration to validate the cluster with the {rds} custom resources (CRs).
 
 The plugin-specific reference configuration for {rds} is packaged in a container image with the {rds} CRs.
@@ -66,29 +67,29 @@ $ oc cluster-compare -r out/reference/metadata.yaml
 
 **********************************
 
-Cluster CR: config.openshift.io/v1_OperatorHub_cluster <1>
-Reference File: required/other/operator-hub.yaml <2>
+Cluster CR: config.openshift.io/v1_OperatorHub_cluster
+Reference File: required/other/operator-hub.yaml
 Diff Output: diff -u -N /tmp/MERGED-2801470219/config-openshift-io-v1_operatorhub_cluster /tmp/LIVE-2569768241/config-openshift-io-v1_operatorhub_cluster
 --- /tmp/MERGED-2801470219/config-openshift-io-v1_operatorhub_cluster	2024-12-12 14:13:22.898756462 +0000
 +++ /tmp/LIVE-2569768241/config-openshift-io-v1_operatorhub_cluster	2024-12-12 14:13:22.898756462 +0000
 @@ -1,6 +1,6 @@
  apiVersion: config.openshift.io/v1
  kind: OperatorHub
  metadata:
-+  annotations: <3>
++  annotations:
 +    include.release.openshift.io/hypershift: "true"
    name: cluster
 -spec:
 -  disableAllDefaultSources: true
 
 **********************************
 
-Summary <4>
-CRs with diffs: 11/12 <5>
-CRs in reference missing from the cluster: 40 <6>
+Summary
+CRs with diffs: 11/12
+CRs in reference missing from the cluster: 40
 optional-image-registry:
   image-registry:
-    Missing CRs: <7>
+    Missing CRs:
     - optional/image-registry/ImageRegistryPV.yaml
 optional-ptp-config:
   ptp-config:
@@ -114,17 +115,31 @@ optional-storage:
 
 ...
 
-No CRs are unmatched to reference CRs <8>
-Metadata Hash: 09650c31212be9a44b99315ec14d2e7715ee194a5d68fb6d24f65fd5ddbe3c3c <9>
-No patched CRs <10>
+No CRs are unmatched to reference CRs
+Metadata Hash: 09650c31212be9a44b99315ec14d2e7715ee194a5d68fb6d24f65fd5ddbe3c3c
+No patched CRs
 ----
-<1> The CR under comparison. The plugin displays each CR with a difference from the corresponding template.
-<2> The template matching with the CR for comparison.
-<3> The output in Linux diff format shows the difference between the template and the cluster CR.
-<4> After the plugin reports the line diffs for each CR, the summary of differences are reported.
-<5> The number of CRs in the comparison with differences from the corresponding templates.
-<6> The number of CRs represented in the reference configuration, but missing from the live cluster.
-<7> The list of CRs represented in the reference configuration, but missing from the live cluster.
-<8> The CRs that did not match to a corresponding template in the reference configuration.
-<9> The metadata hash identifies the reference configuration.
-<10> The list of patched CRs.
++
+--
+Where:
+
+Cluster CR:: The CR under comparison. The plugin displays each CR with a difference from the corresponding template.
+
+Reference File:: The template matching with the CR for comparison.
+
+Diff Output:: The output in Linux diff format shows the difference between the template and the cluster CR.
+
+Summary:: After the plugin reports the line diffs for each CR, the summary of differences are reported.
+
+CRs with diffs:: The number of CRs in the comparison with differences from the corresponding templates.
+
+CRs in reference missing from the cluster:: The number of CRs represented in the reference configuration, but missing from the live cluster.
+
+Missing CRs:: The list of CRs represented in the reference configuration, but missing from the live cluster.
+
+No CRs are unmatched to reference CRs:: The CRs that did not match to a corresponding template in the reference configuration.
+
+Metadata Hash:: Identifies the reference configuration.
+
+No patched CRs:: The list of patched CRs.
+--
diff --git a/modules/ztp-telco-hub-cluster-software-versions.adoc b/modules/ztp-telco-hub-cluster-software-versions.adoc
@@ -6,6 +6,7 @@
 [id="ztp-telco-hub-cluster-software-versions_{context}"]
 = Telco RAN DU {product-version} hub cluster validated software components
 
+[role="_abstract"]
 The Red Hat telco RAN {product-version} solution has been validated using the following Red Hat software products for {product-title} hub clusters.
 
 .Telco hub cluster validated software components
diff --git a/modules/ztp-telco-ran-software-versions.adoc b/modules/ztp-telco-ran-software-versions.adoc
@@ -6,6 +6,7 @@
 [id="ztp-telco-ran-software-versions_{context}"]
 = Telco RAN DU {product-version} validated software components
 
+[role="_abstract"]
 The Red Hat telco RAN DU {product-version} solution has been validated using the following Red Hat software products for {product-title} managed clusters.
 
 .Telco RAN DU managed cluster validated software components
diff --git a/scalability_and_performance/telco-ran-du-rds.adoc b/scalability_and_performance/telco-ran-du-rds.adoc
