Skip to content

Commit eae160f

Browse files
aireillyrohennes
authored andcommitted
Adding Telco RAN RDS 4.17 doc updates
1 parent c9ea368 commit eae160f

File tree

110 files changed

+1102
-744
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+1102
-744
lines changed

_attributes/common-attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
:_mod-docs-content-type: SNIPPET
12
// The {product-title} attribute provides the context-sensitive name of the relevant OpenShift distribution, for example, "OpenShift Container Platform" or "OKD". The {product-version} attribute provides the product version relative to the distribution, for example "4.9".
23
// {product-title} and {product-version} are parsed when AsciiBinder queries the _distro_map.yml file in relation to the base branch of a pull request.
34
// See https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#product-name-and-version for more information on this topic.
@@ -44,6 +45,7 @@ endif::[]
4445
:product-mirror-registry: Mirror registry for Red Hat OpenShift
4546
:rh-storage-first: Red Hat OpenShift Data Foundation
4647
:rh-storage: OpenShift Data Foundation
48+
:rh-rhacm-title: Red Hat Advanced Cluster Management
4749
:rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM)
4850
:rh-rhacm: RHACM
4951
:rh-rhacm-version: 2.11

edge_computing/policygentemplate_for_ztp/ztp-advanced-policy-config.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ include::modules/ztp-using-pgt-to-configure-performance-mode.adoc[leveloffset=+2
4747

4848
include::modules/ztp-using-pgt-to-configure-high-performance-mode.adoc[leveloffset=+2]
4949

50+
* 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]
51+
5052
include::modules/ztp-using-pgt-to-configure-power-saving-mode.adoc[leveloffset=+2]
5153

5254
[role="_additional-resources"]
Loading
Loading
Loading
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-design-components.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="telco-core-agent-based-installer-abi_{context}"]
7+
= Agent-based installer
8+
9+
New in this release::
10+
* No reference design updates in this release
11+
12+
Description::
13+
You can install telco core clusters with the Agent-based installer (ABI) on bare-metal servers without requiring additional servers or virtual machines for managing the installation.
14+
ABI supports installations in disconnected environments.
15+
With ABI, you install clusters by using declarative custom resources (CRs).
16+
+
17+
[NOTE]
18+
====
19+
Agent-based installer is an optional component. The recommended installation method is by using {rh-rhacm-title} or {mce}.
20+
====
21+
22+
Limits and requirements::
23+
* You need to have a disconnected mirror registry with all required content mirrored to do Agent-based installs in a disconnected environment.
24+
25+
Engineering considerations::
26+
* Networking configuration should be applied as `NMState` custom resources (CRs) during cluster installation.
Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,36 @@
11
// Module included in the following assemblies:
22
//
3-
// * telco_ref_design_specs/core/telco-core-ref-design-components.adoc
3+
// * scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-design-components.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="telco-core-cluster-network-operator_{context}"]
7-
= Cluster Network Operator (CNO)
7+
= Cluster Network Operator
88

99
New in this release::
10-
1110
* No reference design updates in this release
1211

1312
Description::
14-
15-
The CNO deploys and manages the cluster network components including the default OVN-Kubernetes network plugin during {product-title} cluster installation. It allows configuring primary interface MTU settings, OVN gateway modes to use node routing tables for pod egress, and additional secondary networks such as MACVLAN.
16-
+
17-
In support of network traffic separation, multiple network interfaces are configured through the CNO. Traffic steering to these interfaces is configured through static routes applied by using the NMState Operator. To ensure that pod traffic is properly routed, OVN-K is configured with the `routingViaHost` option enabled. This setting uses the kernel routing table and the applied static routes rather than OVN for pod egress traffic.
18-
+
19-
The Whereabouts CNI plugin is used to provide dynamic IPv4 and IPv6 addressing for additional pod network interfaces without the use of a DHCP server.
13+
The Cluster Network Operator (CNO) deploys and manages the cluster network components including the default OVN-Kubernetes network plugin during {product-title} cluster installation. It allows configuring primary interface MTU settings, OVN gateway modes to use node routing tables for pod egress, and additional secondary networks such as MACVLAN.
2014

2115
Limits and requirements::
22-
2316
* OVN-Kubernetes is required for IPv6 support.
17+
2418
* Large MTU cluster support requires connected network equipment to be set to the same or larger value.
2519
20+
* MACVLAN and IPVLAN cannot co-locate on the same main interface due to their reliance on the same underlying kernel mechanism, specifically the `rx_handler`.
21+
This handler allows a third-party module to process incoming packets before the host processes them, and only one such handler can be registered per network interface.
22+
Since both MACVLAN and IPVLAN need to register their own `rx_handler` to function, they conflict and cannot coexist on the same interface.
23+
See link:https://elixir.bootlin.com/linux/v6.10.2/source/drivers/net/ipvlan/ipvlan_main.c#L82[ipvlan/ipvlan_main.c#L82] and link:https://elixir.bootlin.com/linux/v6.10.2/source/drivers/net/macvlan.c#L1260[net/macvlan.c#L1260] for details.
24+
25+
* Alternative NIC configurations include splitting the shared NIC into multiple NICs or using a single dual-port NIC.
26+
+
27+
[IMPORTANT]
28+
====
29+
Splitting the shared NIC into multiple NICs or using a single dual-port NIC has not been validated with the telco core reference design.
30+
====
31+
32+
* Single-stack IP cluster not validated.
33+
34+
2635
Engineering considerations::
2736
* Pod egress traffic is handled by kernel routing table with the `routingViaHost` option. Appropriate static routes must be configured in the host.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability_and_performance/telco_ref_design_specs/core/telco-core-rds-overview.adoc
4+
:_mod-docs-content-type: REFERENCE
5+
[id="telco-core-cluster-service-based-architecture-and-networking-topology_{context}"]
6+
= {rds-caps} cluster service-based architecture and networking topology
7+
8+
The {rds-caps} reference design specification (RDS) describes a platform that supports large-scale telco applications including control plane functions such as signaling and aggregation. It also includes some centralized data plane functions, for example, user plane functions (UPF). These functions generally require scalability, complex networking support, resilient software-defined storage, and support performance requirements that are less stringent and constrained than far-edge deployments like RAN.
9+
10+
.{rds-caps} cluster service-based architecture and networking topology
11+
image::openshift-5g-core-cluster-architecture-networking.png[5G core cluster showing a service-based architecture with overlaid networking topology]
12+
13+
The telco core cluster service-based architecture consists of the following components:
14+
15+
* Network data analytics functions (**NWDAF**)
16+
* Network slice selection functions (**NSFF**)
17+
* Authentication server functions (**AUSF**)
18+
* Unified data managements (**UDM**)
19+
* Network repository functions (**NRF**)
20+
* Network exposure functions (**NEF**)
21+
* Application functions (**AF**)
22+
* Access and mobility functions (**AMF**)
23+
* Session management functions (**SMF**)
24+
* Policy control functions (**PCF**)
25+
* Charging functions (**CHF**)
26+
* User equipment (**UE**)
27+
* Radio access network (**RAN**)
28+
* User plane functions (**UPF**)
29+
* Data plane networking (**DN**)

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
// Module included in the following assemblies:
22
//
3-
// * telco_ref_design_specs/core/telco-core-ref-design-components.adoc
3+
// * scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-design-components.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="telco-core-cpu-partitioning-performance-tune_{context}"]
77
= CPU partitioning and performance tuning
88

99
New in this release::
10-
* 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.
10+
* No reference design updates in this release
1111

1212
Description::
13-
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.
13+
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.
1414

1515
Limits and requirements::
1616
* The operating system needs a certain amount of CPU to perform all the support tasks including kernel networking.
@@ -42,4 +42,5 @@ Engineering considerations::
4242
* 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.
4343
* OVS dynamically manages its `cpuset` configuration to adapt to network traffic needs.
4444
You do not need to reserve additional CPUs for handling high network throughput on the primary CNI.
45-
* 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.
45+
* If workloads running on the cluster require cgroups v1, you can configure nodes to use cgroups v1 as part of the initial cluster deployment.
46+
For more information, see "Enabling Linux cgroup v1 during installation".

modules/telco-core-crs-networking.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// *
3+
// * scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-crs.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="networking-crs_{context}"]
@@ -10,23 +10,23 @@
1010
[cols="4*", options="header", format=csv]
1111
|====
1212
Component,Reference CR,Optional,New in this release
13-
Baseline,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-network-yaml[Network.yaml],No,No
14-
Baseline,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-networkattachmentdefinition-yaml[networkAttachmentDefinition.yaml],Yes,Yes
13+
Baseline,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-network-yaml[Network.yaml],Yes,No
14+
Baseline,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-networkattachmentdefinition-yaml[networkAttachmentDefinition.yaml],Yes,No
1515
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-addr-pool-yaml[addr-pool.yaml],No,No
1616
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-bfd-profile-yaml[bfd-profile.yaml],No,No
1717
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-bgp-advr-yaml[bgp-advr.yaml],No,No
1818
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-bgp-peer-yaml[bgp-peer.yaml],No,No
19-
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-community-yaml[community.yaml],No,Yes
19+
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-community-yaml[community.yaml],No,No
2020
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallb-yaml[metallb.yaml],No,No
21-
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallbns-yaml[metallbNS.yaml],Yes,No
22-
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallbopergroup-yaml[metallbOperGroup.yaml],Yes,No
21+
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallbns-yaml[metallbNS.yaml],No,No
22+
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallbopergroup-yaml[metallbOperGroup.yaml],No,No
2323
Load balancer,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-metallbsubscription-yaml[metallbSubscription.yaml],No,No
24-
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
25-
NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstate-yaml[NMState.yaml],No,Yes
26-
NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstatens-yaml[NMStateNS.yaml],No,Yes
27-
NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstateopergroup-yaml[NMStateOperGroup.yaml],No,Yes
28-
NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstatesubscription-yaml[NMStateSubscription.yaml],No,Yes
29-
SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovnetwork-yaml[sriovNetwork.yaml],Yes,No
24+
Multus - Tap CNI for rootless DPDK pods,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
25+
NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstate-yaml[NMState.yaml],No,No
26+
NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstatens-yaml[NMStateNS.yaml],No,No
27+
NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstateopergroup-yaml[NMStateOperGroup.yaml],No,No
28+
NMState Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-nmstatesubscription-yaml[NMStateSubscription.yaml],No,No
29+
SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovnetwork-yaml[sriovNetwork.yaml],No,No
3030
SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovnetworknodepolicy-yaml[sriovNetworkNodePolicy.yaml],No,No
3131
SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovoperatorconfig-yaml[SriovOperatorConfig.yaml],No,No
3232
SR-IOV Network Operator,xref:../../telco_ref_design_specs/core/telco-core-ref-crs.adoc#telco-core-sriovsubscription-yaml[SriovSubscription.yaml],No,No

0 commit comments

Comments
 (0)