Improve overview documentation (omec-project#98)

* Improve overview documentation

Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>

* Address Copilot's comments

Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>

* Address spell check issue

Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>

---------

Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>

Author: gab-arrobo

dict.txt

@@ -27,6 +27,7 @@ HSS
 Haswell
 Homebrew
 IDmap
+IPv
 Keepalive
 Kubernetes
 LTE
@@ -101,6 +102,7 @@ configurability
 cpu
 customProfile
 customProfiles
+datapath
 dataplane
 de
 defaultAs

overview/3gpp-compliance-5g.rst

@@ -28,10 +28,10 @@ High Level Summary
     * N8, N10, N13, N21, N35, N36, N37
 
 * NF supported
-    * AMF, NRF, SMF, PCF, UDM, UDR, NSSF, AUSF
+    * AMF, NRF, SMF, PCF, UDM, UDR, NSSF, AUSF, N3IWF
 
 * NF not supported
-    * NEF, NWDAF, CHF, N3IWF, UDSF, AF
+    * NEF, NWDAF, CHF, UDSF, AF
 
 * High Level Features supported
     * UE Registration
@@ -48,7 +48,6 @@ High Level Summary
     * Location Based Services
     * Inter NG-RAN node N2 based handover
     * TSN ( Time Sensitive Networking)
-    * Non-3gpp access
 
 
 SMF Compliance

overview/architecture.rst

@@ -5,22 +5,22 @@
 SD-Core as a Cloud Managed Service
 ==================================
 
-    * SD-Core is a flexible, agile, scalable and configurable dual-mode 4G/5G core
-      network platform that builds upon and enhances ONF’s OMEC and free 5GC core
-      network platforms to support LTE, 5G NSA and 5G SA services.
+    * SD-Core is a flexible, agile, scalable, and configurable dual-mode 4G/5G core
+      network platform that builds upon and enhances ONF's OMEC and free5GC core
+      network platforms to support LTE, 5G NSA, and 5G SA services.
 
-    * The SD-Core control plane provides the flexibility of simultaneous supports
-      for 5G standalone, 5G non-standalone and 4G/LTE deployments.
+    * The SD-Core control plane provides the flexibility to simultaneously support
+      5G standalone, 5G non-standalone, and 4G/LTE deployments.
 
     * SD-Core provides a rich set of APIs to Runtime Operation Control (ROC).
 
-        * Operators can use these APIs to provision the subscribers in the mobile core
-          and their associated access and connectivity policies.
-        * Control runtime configuration of network functions e.g. management of Network slices
-        * ROC includes built-in adapters for SD-Core to translate its monitoring and configuration
-          APIs to customer and operator portals as well as third-party applications with corresponding
-          levels of abstraction. Third party applications can leverage telemetry data to create
-          applications for closed loop control.
+        * Operators can use these APIs to provision subscribers in the mobile core
+          and their associated access and connectivity policies
+        * Control runtime configuration of network functions (e.g., management of network slices)
+        * ROC includes built-in adapters for SD-Core to translate its monitoring and
+          configuration APIs to customer and operator portals as well as third-party applications
+        * Third-party applications can leverage telemetry data to create applications for
+          closed-loop control
 
 .. image:: ../_static/images/SD-Core-Architecture.png
   :width: 700px
@@ -33,9 +33,9 @@ SD-Core architecture enables the following distinct features:
       external networks and systems (e.g., RAN, communication services, etc.). As such,
       components can be consumed independently and be used as part of a multi-vendor
       mobile core deployment.
-    - SD-Core’s 5G core control plane functions leverage seed code from the free5GC project,
+    - SD-Core's 5G core control plane functions leverage seed code from the free5GC project,
       upon which the SD-Core community has implemented numerous architectural changes that
-      are integrated and optimized with SD-Core’s set of UPF solutions along with several
+      are integrated and optimized with SD-Core's BESS-UPF implementation along with several
       new features
     - The solution enables 4G, 5G Standalone (SA) and 5G Non-Standalone (NSA) connectivity.
     - The architecture is fully disaggregated, composed of containerized components. Helm charts are
@@ -44,28 +44,31 @@ SD-Core architecture enables the following distinct features:
     - The solution is consumable as a cloud-managed service.
     - All interfaces are designed to be robust in order to handle all network errors including but
       not limited to packet loss, peer network function failure, and duplicate packets.
-    - SD-Core’s 4G Core is designed to have a CUPS (Control-User Plane Separation) compliant architecture and
+    - SD-Core's 4G Core is designed to have a CUPS (Control-User Plane Separation) compliant architecture and
       uses the 3GPP Packet Forwarding Control Protocol (PFCP) to implement CUPS
-    - SD-Core’s 4G control plane has been enhanced to provide functional support for 5G Nonstandalone
+    - SD-Core's 4G control plane has been enhanced to provide functional support for 5G Nonstandalone
       operation with compliant eNBs and gNBs as per 3GPP specifications. 5G NSA related enhancements
       include support of the extended bearer rates on required interfaces as well as the 5G NSA attributes
       in the HSS.
 
 .. image:: ../_static/images/Sd-Core-NFs.png
   :width: 700px
 
-Multiple Distributed User Planes
---------------------------------
+User Plane Function (UPF)
+--------------------------
+
+SD-Core provides a software-based User Plane Function (UPF) designed to be deployed throughout
+the network edge. The UPF is optimized to handle various classes of applications and supports
+multiple hardware acceleration options.
 
-SD-Core has two User Plane Functions (UPFs) designed to be deployed throughout
-the network edge. Each UPF is optimized to handle specific classes of application
-and take advantage of various hardware acceleration options. Deployments can
-intermix the UPF variants.
+**BESS-UPF**
 
-    * P4-Based UPF optimized for private enterprise deployments, and providing fine-grained
-      visibility for verifiable performance and secure operations
-    * Containerized Dual-Core UPF optimized for private enterprise deployments, capable of
-      processing LTE and 5G traffic simultaneously
+  A software-based datapath built on top of the Berkeley Extensible Software Switch (BESS) framework.
+  BESS-UPF is optimized for private enterprise deployments, capable of processing both LTE and 5G
+  traffic simultaneously. It supports multiple modes including DPDK, CNDP, AF_PACKET and AF_XDP for
+  flexible deployment options. BESS-UPF provides features such as IPv4 support, N3/N4/N6/N9 interfacing,
+  static and dynamic IP routing, QoS enforcement with per-slice and per-session rate limiting, and
+  comprehensive monitoring capabilities.
 
 
 In SD-Core, a connected device is assigned to a UPF based on the network-wide slice configuration.
@@ -83,7 +86,7 @@ service-based architecture of 5G core, this isolation may include only the UPF o
 of the control plane services such as the SMF. However, mobile core control functions that
 are responsible for managing user mobility, user authentication, and network slicing need
 to remain centralized across all slices. SD-Core provides the necessary APIs to manage
-network slices using external agents. ONF’s ROC, pre-integrated with SD-Core, allows for this
+network slices using external agents. ONF's ROC, pre-integrated with SD-Core, allows for this
 central management via portals as well as automation. If the management requires
 instantiation of a new UPF and/or a new SMF instance, ROC oversees this by interacting with
 edge cloud or hyperscale container management services to provision such new network
@@ -93,7 +96,7 @@ Once all mobile core service instances are provisioned for a new slice, ROC uses
 APIs to configure the slice as well as all required central network functions. SD-Core provides
 APIs to create and configure network slices and assign resources to each slice. Operators can
 assign a slice for a group of users/devices based on the use case. The behavior of each slice
-is configurable and can be dynamically changed during run time. SD-Core’s architecture
+is configurable and can be dynamically changed during run time. SD-Core's architecture
 supports assigning dedicated network functions to a specific slice or providing logical
 separation if network functions are to be shared among various slices. Various QoS and
 access policies can be applied to each slice to control the assigned resources as well as IP
@@ -103,14 +106,12 @@ specific packet data networks/edge applications or keeping all devices or flows
 same QoS classification grouped under one slice. Network slice selection is achieved through
 3GPP-specified network functions like Network Slice Selection Function (NSSF) and Network
 Repository Function (NRF). NSSF helps in mapping the device/flow to a specific slice and
-steering the device/flow traffic to the right set of core network elements. SD-Core’s 5G
+steering the device/flow traffic to the right set of core network elements. SD-Core's 5G
 implementation natively includes both NSSF and NRF for slice selection.
-As described earlier, SD-Core’s P4-based dual-core UPF allows for the monitoring of all
-4G/5G traffic with fine-grained granularity using INT. This effectively means that with the P4-
-based dual-core UPF, it is possible to conduct per packet network monitoring to track
-whether slice-specific SLAs are being met and automatically adapt network behavior by
-changing per slice resource allocations, QoS priorities etc., to automatically sustain the
-required network performance using closed-loop control.
+SD-Core's BESS-UPF provides comprehensive monitoring capabilities with per-flow latency and
+throughput metrics. This allows operators to track whether slice-specific SLAs are being met
+and make informed decisions about network behavior by adjusting per-slice resource allocations,
+QoS priorities, and other parameters to maintain the required network performance.
 
 SD-Core Deployment Options
 --------------------------
@@ -122,7 +123,7 @@ oversee many UPFs, potentially instantiated at geographically diverse locations,
 It is possible to deploy all components of SD-Core collocated in an edge cloud or a central
 cloud for private consumption. It is also possible to distribute the components of SD-Core
 across multiple clouds, edge and central, to deliver a cloud-managed multi-tenant
-connectivity service. In this distributed deployment option, SD-Core’s control plane will run
+connectivity service. In this distributed deployment option, SD-Core's control plane will run
 on a central/hyperscaler cloud and control multiple user planes running on different onpremises
 edge clouds, potentially serving distinct customers as illustrated in Figure 8. In this
 deployment, the 4G and 5G control plane functions can scale as necessary. Each customer
@@ -137,7 +138,7 @@ at the customer edge or in the central cloud, as needed and best suited.
 .. image:: ../_static/images/hybrid-cloud.png
   :width: 700px
 
-SD-Core’s hybrid cloud deployment is an important enabler for a managed 4G/5G
+SD-Core's hybrid cloud deployment is an important enabler for a managed 4G/5G
 connectivity service where each customer site may be deployed to serve a different set of
 use cases and may have different types of underlying cloud environments. The 4G/5G core
 control planes running on the central cloud have been designed and optimized to support

overview/faq.rst

@@ -2,45 +2,50 @@
    SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
    SPDX-License-Identifier: Apache-2.0
 
-FAQs
-====
+Frequently Asked Questions
+==========================
 
-    * **Does SD-Core support for roaming architecture?**
+**Does SD-Core support roaming architecture?**
 
-      *SD-Core is primarily focused for private 5G  & private LTE use cases and*
-      *hence roaming aspects of architecture are not supported.*
+   SD-Core is primarily focused on private 5G and private LTE use cases, and
+   therefore roaming aspects of the architecture are not currently supported.
 
-    * **Does SD-Core support charging functionality or CHF (charging network function)?**
+**Does SD-Core support charging functionality or CHF (Charging Network Function)?**
 
-        *SD-Core is primarily focussed for private 5G & private LTE use cases and*
-        *hence charging related aspects are not supported.*
+   SD-Core is primarily focused on private 5G and private LTE use cases, and
+   therefore charging-related aspects are not currently supported.
 
-    * **Is SD-Core/5G-Core cloud native?**
+**Is SD-Core/5G-Core cloud native?**
 
-        *SD-Core is not cloud native, but it runs in K8s environment.*
-        *As per road map AMF, SMF will be cloud native by the Q3 of 2022. This is WIP.*
+   SD-Core components are designed to run in Kubernetes environments with cloud-native
+   principles including containerization, scalability, and dynamic configuration.
 
-    * **What are the changes omec 5G has on top of free5gc?**
+**What is SD-Core's relationship with free5GC?**
 
-        * Configuration APIs to configure all network functions
-        * QoS support at default flow and per application flow
-        * 5000 subscribers with 10 calls per second stability achieved (Single Instance)
-        * Error cases with UPF connectivity fixed
-        * Error case of no response or message retransmission towards UPF
-        * Error cases with Network functions restarts fixed
-        * Stability issues on NGAP interfaces and N1 interfaces fixed
-        * 100+ code commits to achieve code stability
-        * 3gpp compliance of 5G core is added in SD core documentation
-        * per UE FSM in AMF & SMF
-        * Transaction support in AMF & SMF
-        * UE address allocation by UPF support at SMF
-        * **There are many more changes done and above are just high level summary**
-        * Go through `google document link <https://docs.google.com/document/d/1B4WQdgK5QwLcsmgg9qMRP0lupawVzh1F8N5YjTpLBCM/edit#>`_ to get more details about changes.
+   SD-Core's 5G control plane leverages seed code from the free5GC project, upon which
+   the SD-Core community has implemented numerous architectural enhancements and optimizations.
+   Key improvements include:
 
-    * **Network Performance Testing of SD-Core**
+   - Configuration APIs to configure all network functions
+   - QoS support for default flows and per-application flows
+   - Stability improvements supporting 5000 subscribers with 10 calls per second
+     (single instance)
+   - Fixed error cases related to UPF connectivity
+   - Improved handling of message retransmission and timeout scenarios with UPF
+   - Enhanced stability during network function restarts
+   - Stability improvements on NGAP and N1 interfaces
+   - Over 100 code commits focused on stability improvements
+   - 3GPP compliance documentation for 5G core
+   - Per-UE Finite State Machine (FSM) in AMF and SMF
+   - Transaction support in AMF and SMF
+   - UE address allocation by UPF support in SMF
 
-        *No performance results available. Limited scale testing is performed to check*
-        *the control plane subscriber capacity and  transaction rate. But still its not*
-        *formal enough to share with wider community. Watch out for release notes and testing
-        *section to get current performance results*
+   This is a high-level summary. For more details, see the
+   `detailed changes document <https://docs.google.com/document/d/1B4WQdgK5QwLcsmgg9qMRP0lupawVzh1F8N5YjTpLBCM/edit#>`_.
+
+**What about network performance testing of SD-Core?**
+
+   Limited scale testing has been performed to evaluate control plane subscriber capacity
+   and transaction rates. Formal performance results will be published in the release notes
+   and testing sections as they become available.
 

overview/introduction.rst

@@ -5,9 +5,9 @@
 Introduction
 ============
 
-SD-Core™ is the Open Networking Foundation™ (ONF)’s open source, flexible, agile,
+SD-Core™ is the Open Networking Foundation™ (ONF)'s open source, flexible, agile,
 scalable, and configurable dual-mode 4G/5G mobile core network solution that enables a
-cloud-based Connectivity-as-a-Service. SD-Core builds and enhances on ONF’s 4G Open
+cloud-based Connectivity-as-a-Service. SD-Core builds on and enhances ONF's 4G Open
 Mobile Evolved Core (OMEC)™ as well as the free5GC© core network platform to create a
 dual-mode solution that supports LTE, 5G NSA and 5G SA services optimized for hybrid-cloud
 environments.
@@ -25,14 +25,16 @@ SD-Core can be configured for dynamically programmable network slicing, subscrib
 and policy management, providing precise access control for users, devices, data networks
 and edge applications.
 
-Overview
---------
+Key Capabilities
+----------------
 
-    - Ensure only authenticated mobile devices have network access
-    - Provides IP connectivity for data & voice services
-    - Ensures connectivity adheres to QoS and network slice policies
-    - Tracks user mobility to ensure uninterrupted service
-    - Tracks subscriber usage
+SD-Core provides the following core capabilities:
+
+- Ensure only authenticated mobile devices have network access
+- Provide IP connectivity for data and voice services
+- Enforce QoS and network slice policies
+- Track user mobility to ensure uninterrupted service
+- Monitor and track subscriber usage
 
 .. image:: ../_static/images/SD-Core-Overview.png
   :width: 700px
@@ -46,20 +48,18 @@ In order to optimize for the hybrid cloud and to support emerging Industry 4.0 u
 SD-Core includes multiple user plane functions (UPFs) to handle different classes of
 enterprise traffic:
 
-    - A P4-based UPF offloads the packet processing and forwarding operations to a
-      programmable edge fabric to achieve significant performance with much higher
-      bandwidths, significantly lower latencies, and highly predictable very low jitter, albeit
-      for a relatively modest number of devices/flows
-    - A containerized, highly scalable solution provides high performance by leveraging
-      acceleration technologies like DPDK.
+- **Software-based UPF**: Provides high performance and scalability by leveraging acceleration
+  technologies like DPDK, suitable for handling large numbers of devices and flows.
 
 SD-Core is an Integral Part of Aether
--------------------------------------
+--------------------------------------
+
+SD-Core serves as an integral component of Aether, ONF's 5G Connected Edge platform
+for private mobile connectivity and edge cloud services. Key integration points include:
 
-    - SD-Core is an integral component of Aether, ONF’s 5G Connected Edge platform for
-      private mobile connectivity and edge cloud services.
-    - SD-Core provides the 4G/5G connectivity and the SD-Core control plane at the central
-      site controls multiple user plane components running at each Aether Edge site.
+- SD-Core provides the 4G/5G connectivity layer
+- The SD-Core control plane at the central site manages multiple user plane components
+  distributed across Aether Edge sites
 
 .. image:: ../_static/images/Sd-Core-Aether-Integral.jpg
   :width: 700px