diff --git a/modules/telco-ran-bios-tuning.adoc b/modules/telco-ran-bios-tuning.adoc index 288afb2a4c..9f8bbddf09 100644 --- a/modules/telco-ran-bios-tuning.adoc +++ b/modules/telco-ran-bios-tuning.adoc @@ -11,8 +11,8 @@ New in this release:: Description:: Tune host firmware settings for optimal performance during initial cluster deployment. -For more information, see link:https://docs.openshift.com/container-platform/4.19/edge_computing/ztp-reference-cluster-configuration-for-vdu.html#ztp-reference-cluster-config[Recommended {sno} cluster configuration for vDU application workloads]. -Apply tuning settings in the host firmware during initial deployment. For more information, see link:https://docs.openshift.com/container-platform/4.19/edge_computing/ztp-deploying-far-edge-sites.html#ztp-configuring-host-firmware-with-gitops-ztp_ztp-deploying-far-edge-sites[Managing host firmware settings with {ztp}]. +For more information, see "Recommended {sno} cluster configuration for vDU application workloads". +Apply tuning settings in the host firmware during initial deployment. For more information, see "Managing host firmware settings with {ztp}". 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] diff --git a/modules/telco-ran-cluster-tuning.adoc b/modules/telco-ran-cluster-tuning.adoc index 219e508e87..08c5bf64cf 100644 --- a/modules/telco-ran-cluster-tuning.adoc +++ b/modules/telco-ran-cluster-tuning.adoc @@ -10,7 +10,7 @@ New in this release:: * No reference design updates in this release Description:: -For a full list of components that you can disable using the cluster capabilities feature, see link:https://docs.openshift.com/container-platform/4.19/installing/overview/cluster-capabilities.html#cluster-capabilities[Cluster capabilities]. +For a full list of components that you can disable using the cluster capabilities feature, see "Cluster capabilities". Limits and requirements:: * Cluster capabilities are not available for installer-provisioned installation methods. diff --git a/modules/telco-ran-lca-operator.adoc b/modules/telco-ran-lca-operator.adoc index 7b4b3511d7..9522462e45 100644 --- a/modules/telco-ran-lca-operator.adoc +++ b/modules/telco-ran-lca-operator.adoc @@ -16,4 +16,5 @@ Image-based upgrade is the recommended upgrade method for {sno} clusters. Limits and requirements:: * The Lifecycle Agent is not applicable in multi-node clusters or {sno} clusters with an additional worker. * The Lifecycle Agent requires a persistent volume that you create when installing the cluster. -Partition requirements are described in link:https://docs.openshift.com/container-platform/4.19/edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.html#ztp-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container directory between ostree stateroots when using {ztp}]. + +For more information about partition requirements, see "Configuring a shared container directory between ostree stateroots when using {ztp}". diff --git a/modules/telco-ran-node-tuning-operator.adoc b/modules/telco-ran-node-tuning-operator.adoc index af80164d3a..405ae603ba 100644 --- a/modules/telco-ran-node-tuning-operator.adoc +++ b/modules/telco-ran-node-tuning-operator.adoc @@ -13,7 +13,7 @@ Description:: The RAN DU use model includes cluster performance tuning using `PerformanceProfile` CRs for low-latency performance. The RAN DU use case requires the cluster to be tuned for low-latency performance. The Node Tuning Operator reconciles the `PerformanceProfile` CRs. -For more details about node tuning with the `PerformanceProfile` CR, see link:https://docs.openshift.com/container-platform/4.19/scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.html#perf-profile[Tuning nodes for low latency with the performance profile]. +For more information about node tuning with the `PerformanceProfile` CR, see "Tuning nodes for low latency with the performance profile". Limits and requirements:: The Node Tuning Operator uses the `PerformanceProfile` CR to configure the cluster. diff --git a/modules/telco-ran-sr-iov-operator.adoc b/modules/telco-ran-sr-iov-operator.adoc index 88e72fe627..1539cb9ce2 100644 --- a/modules/telco-ran-sr-iov-operator.adoc +++ b/modules/telco-ran-sr-iov-operator.adoc @@ -15,7 +15,7 @@ Both `netdevice` (kernel VFs) and `vfio` (DPDK) devices are supported and applic Limits and requirements:: * Use devices that are supported for {product-title}. -See link:https://docs.openshift.com/container-platform/4.19/networking/hardware_networks/about-sriov.html#nw-sriov-supported-platforms_about-sriov[Supported devices]. +For more information, see "Supported devices". * SR-IOV and IOMMU enablement in host firmware settings: The SR-IOV Network Operator automatically enables IOMMU on the kernel command line. * SR-IOV VFs do not receive link state updates from the PF. If link down detection is required you must configure this at the protocol level. @@ -32,7 +32,7 @@ This CR is included in the reference configuration policies which are applied du In these scenarios, the SR-IOV Operator disables the parallel node drain functionality. * You must pre-configure NICs which do not support firmware updates under secure boot or kernel lockdown with sufficient virtual functions (VFs) to support the number of VFs needed by the application workload. For Mellanox NICs, you must disable the Mellanox vendor plugin in the SR-IOV Network Operator. -For more information, see link:https://docs.openshift.com/container-platform/4.19/networking/hardware_networks/configuring-sriov-device.html#nw-sriov-nic-mlx-secure-boot_configuring-sriov-device[Configuring an SR-IOV network device]. +For more information, see "Configuring the SR-IOV Network Operator on Mellanox cards when Secure Boot is enabled". * To change the MTU value of a virtual function after the pod has started, do not configure the MTU field in the `SriovNetworkNodePolicy` CR. Instead, configure the Network Manager or use a custom `systemd` script to set the MTU of the physical function to an appropriate value. For example: diff --git a/scalability_and_performance/telco-ran-du-rds.adoc b/scalability_and_performance/telco-ran-du-rds.adoc index e280dfa1a7..c59eec3a33 100644 --- a/scalability_and_performance/telco-ran-du-rds.adoc +++ b/scalability_and_performance/telco-ran-du-rds.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY :telco-ran: [id="telco-ran-du-ref-design-specs"] -= Telco RAN DU reference design specification for {product-title} {product-version} += Telco RAN DU reference design specification include::_attributes/common-attributes.adoc[] :context: telco-ran-du @@ -31,6 +31,8 @@ include::modules/telco-ran-bios-tuning.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources +* xref:../edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-reference-cluster-configuration-for-vdu[Recommended {sno} cluster configuration for vDU application workloads]. + * xref:../edge_computing/ztp-deploying-far-edge-sites.adoc#ztp-configuring-host-firmware-with-gitops-ztp_ztp-deploying-far-edge-sites[Managing host firmware settings with {ztp}] * xref:../edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-du-configuring-host-firmware-requirements_sno-configure-for-vdu[Configuring host firmware for low latency and high performance] @@ -44,6 +46,8 @@ include::modules/telco-ran-node-tuning-operator.adoc[leveloffset=+2] * xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#about_irq_affinity_setting_cnf-low-latency-perf-profile[Finding the effective IRQ affinity setting for a node] +* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-tuning-low-latency-nodes-with-perf-profile[Tuning nodes for low latency with the performance profile] + include::modules/telco-ran-ptp-operator.adoc[leveloffset=+2] include::modules/telco-ran-sr-iov-operator.adoc[leveloffset=+2] @@ -60,8 +64,8 @@ include::modules/telco-ran-logging.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/logging/logging-6-2[Logging 6.2] - +* link:https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.2/html/about_openshift_logging/index[About OpenShift logging] + include::modules/telco-ran-sriov-fec-operator.adoc[leveloffset=+2] [role="_additional-resources"] @@ -101,7 +105,7 @@ include::modules/telco-ran-machine-configuration.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-sno-install-time-cluster-config[Recommended {sno} cluster configuration for vDU application workloads]. +* xref:../edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-sno-install-time-cluster-config[Recommended cluster install manifests]. [id="telco-ran-du-deployment-components"] == Telco RAN DU deployment components @@ -140,7 +144,7 @@ include::modules/telco-ran-agent-based-installer-abi.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing an {product-title} cluster with the Agent-based Installer] +* xref:../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing a cluster with customizations] // include::modules/telco-ran-additional-components.adoc[leveloffset=+2]