Update on various section.
Change-Id: Ibfe0875de178505079cb13fe5077a8e620c03780
diff --git a/configuration/config_simapp.rst b/configuration/config_simapp.rst
index b015b19..1ba0e41 100644
--- a/configuration/config_simapp.rst
+++ b/configuration/config_simapp.rst
@@ -2,8 +2,8 @@
SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-Configuration using Simapp POD
-==============================
+Configuration using Simapp interface
+====================================
Easiest way to configure SD-Core is to use simapp. Simapp is the POD which takes
yaml configuration and configures the subscribers, device groups, network slices
diff --git a/deployment/deployment4G.rst b/deployment/deployment4G.rst
index 46aa7c3..65f822b 100644
--- a/deployment/deployment4G.rst
+++ b/deployment/deployment4G.rst
@@ -17,15 +17,35 @@
Hardware resource requirement
-----------------------------
-SD-Core 4G has following K8s pods
+.. list-table:: CPU & Memory Requirements for 4G components
+ :widths: 5 5 5
+ :header-rows: 1
- - MME: 2 CPU Cores, 4Gi RAM
- - SPGW: 2 CPU Cores, 4Gi RAM
- - PCRF: 2 CPU Cores, 1Gi RAM
- - HSS : 2 CPU Cores, 1Gi RAM
- - ConfigPod: 1 CPU Core, 1Gi RAM
- - SimApp: 1 CPU Core, 1Gi RAM
- - Cassandra: 2 CPU Core, 4Gi RAM
+ * - SD-Core Component
+ - Required CPU
+ - Required Memory in Gi
+ * - MME
+ - 2 CPU Cores
+ - 2Gi
+ * - SPGW
+ - 2 CPU Cores
+ - 5Gi
+ * - PCRF
+ - 2 CPU Cores
+ - 1Gi
+ * - HSS
+ - 2 CPU Cores
+ - 1Gi
+ * - Config4G
+ - 1 CPU Cores
+ - 1Gi
+ * - SimApp
+ - 1 CPU Cores
+ - 1Gi
+ * - Cassandra
+ - 2 CPU Cores
+ - 4Gi
+
Prepare access credential for SD-Core images
--------------------------------------------
@@ -49,8 +69,7 @@
Development Environments
""""""""""""""""""""""""
-
-TODO - AIAB document link
+Please refer (see :ref:`aiab-guide`) to setup 4G development environment.
Production Environments - 4G
""""""""""""""""""""""""""""
diff --git a/deployment/deployment5G.rst b/deployment/deployment5G.rst
index 30537d6..317c528 100644
--- a/deployment/deployment5G.rst
+++ b/deployment/deployment5G.rst
@@ -17,17 +17,47 @@
Hardware resource requirement
-----------------------------
-SD-Core 5G has following K8s pods
+.. list-table:: CPU & Memory Requirements for 5G components
+ :widths: 5 5 5
+ :header-rows: 1
- - AMF: 2 CPU Cores, 4Gi RAM
- - SMF: 2 CPU Cores, 4Gi RAM
- - NRF: 2 CPU Cores, 1Gi RAM
- - NSSF : 2 CPU Cores, 1Gi RAM
- - AUSF: 1 CPU Core, 1Gi RAM
- - PCF: 1 CPU Core, 1Gi RAM
- - UDR
- - UDM
- - MongoDB: 2 CPU Core, 4Gi RAM
+ * - SD-Core Component
+ - Required CPU
+ - Required Memory in Gi
+ * - AMF
+ - 2 CPU Cores
+ - 4Gi
+ * - SMF
+ - 2 CPU Cores
+ - 4Gi
+ * - NRF
+ - 2 CPU Cores
+ - 1Gi
+ * - NSSF
+ - 2 CPU Cores
+ - 1Gi
+ * - AUSF
+ - 1 CPU Cores
+ - 1Gi
+ * - PCF
+ - 1 CPU Cores
+ - 1Gi
+ * - UDR
+ - 2 CPU Cores
+ - 1Gi
+ * - UDM
+ - 2 CPU Cores
+ - 1Gi
+ * - Config5G(webconsole)
+ - 1 CPU Cores
+ - 1Gi
+ * - SimApp
+ - 1 CPU Cores
+ - 1Gi
+ * - MongoDB
+ - 2 CPU Cores
+ - 4Gi
+
Prepare access credential for SD-Core images
--------------------------------------------
@@ -52,7 +82,7 @@
Development Environments
""""""""""""""""""""""""
-TODO - AIAB document link
+Please refer (see :ref:`aiab-guide`) to setup 5G development environment.
Production Environments - 5G
""""""""""""""""""""""""""""
diff --git a/developer/aiab.rst b/developer/aiab.rst
index e4b9c6b..242a80a 100644
--- a/developer/aiab.rst
+++ b/developer/aiab.rst
@@ -2,7 +2,7 @@
SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-.. vim: syntax=rst
+.. _aiab-guide:
================
Aether In a Box
diff --git a/dict.txt b/dict.txt
index bd46000..b3d43d5 100644
--- a/dict.txt
+++ b/dict.txt
@@ -1,3 +1,11 @@
+webconsole
+equipments
+api
+APIs
+testcases
+Nighly
+Subnet
+gc
Rscript
orchestrator
Grafana
diff --git a/index.rst b/index.rst
index 892631e..c2787cb 100644
--- a/index.rst
+++ b/index.rst
@@ -71,7 +71,7 @@
.. toctree::
:maxdepth: 3
- :caption: SD-Core Test Automation
+ :caption: Test Automation
:hidden:
:glob:
diff --git a/overview/architecture.rst b/overview/architecture.rst
index 9e2efcf..53cfd9b 100644
--- a/overview/architecture.rst
+++ b/overview/architecture.rst
@@ -147,18 +147,3 @@
delays communicating with the remote edge sites and is equipped to handle potential
packet losses and retransmissions to support a multi-tenant, distributed geography
deployment.
-
-
-
-Architecture Diagram of SD-Core 4G block
-----------------------------------------
-- show configPod, config distribution, Cassandra DB, SIMApp, 4G network Functions
-
-Architecture Diagram of SD-Core 5G block
-----------------------------------------
-- show configPod, config distribution, MongoDB, SIMApp, 5G network functions
-
-Configuration Distribution Architecture
----------------------------------------
-- how grpc, rest is used to distribute the configuration
-
diff --git a/overview/faq.rst b/overview/faq.rst
index dd19249..cbe0c3a 100644
--- a/overview/faq.rst
+++ b/overview/faq.rst
@@ -4,3 +4,22 @@
FAQs
====
+
+ * ** Q: Does SD-Core support for roaming architecture?**
+
+ *SD-Core is primarily focused for private 5G & private LTE use cases and*
+ *hence roaming aspects of architecture are not supported.*
+
+ * ** Q: 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.*
+
+ * ** Q: 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 mid of 2022. This is WIP.*
+
+ * ** Q. What are the changes omec 5G has on top of free5gc? **
+
+ * Please refer this - document for details of the changes.*
diff --git a/overview/introduction.rst b/overview/introduction.rst
index 5570e06..acf55d6 100644
--- a/overview/introduction.rst
+++ b/overview/introduction.rst
@@ -2,8 +2,8 @@
SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-SD-Core Introduction
-====================
+Introduction
+============
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
@@ -25,8 +25,8 @@
and policy management, providing precise access control for users, devices, data networks
and edge applications.
-SD-Core Overview
-----------------
+Overview
+--------
- Ensure only authenticated mobile devices have network access
- Provides IP connectivity for data & voice services
diff --git a/release/1.0.rst b/release/1.0.rst
index 222c393..c8098ac 100644
--- a/release/1.0.rst
+++ b/release/1.0.rst
@@ -5,72 +5,69 @@
SD-Core 1.0 Release
===================
-SD-Core support 4G & 5G network functions. SD-Core gives configuration APIs, metrics APIs.
-Access network can connected to AMF or MME depending on type of access used.
+SD-Core supports 4G & 5G network functions. SD-Core provides APIs for configuration, telemetry, policy
+management. Access network can connected to AMF or MME depending on type of access used. Below is the
+summary of the features delivered in SD-Core.
Highlights
----------
- - REST configuration interface support
+**Support of REST APIs to configure SD-Core:** Configuring multiple network functions to enable/disable a
+service in a network is complex. Single entry point for REST api based configuration is easy to use
+and less error prone. Our main motivation behind this work item was to hide the complexity of the network
+and make APIs more intuitive for the operator. These APIs work well for both 4G & 5G network functions.
- - Network Slices can be added, deleted, modified using REST interface
- - ``Refer Configuration Guide for more details``
+**Subscriber Management Interface**: 3gpp requires user security keys to be configured in the network function.
+We have provided two interfaces to configure subscribers in SD-Core. One of the way to configure subscribers
+is through REST api calls to SD-Core. The other way is to add/delete/modify subscription through helm charts.
+APIs are extensible and can be easily integrated with 3rd party sim provision solution. Also while operator
+is updating the subscriptions, there is not need to restart any of the SD-Core components. This interface
+to SD-Core is access agnostic and same interface works for 4G as well as 5G access.
- - SIMapp support for subscriber management
+**3gpp defined procedures validation and hardening for error scenarios:** SD-Core has been deployed in Aether
+Network for more than 2 year now and in the year 2021 we added 5G support in the SD-Core. SD-Core is used in couple of
+trials. Also multiple Aether sites using different access networks to connect to centralized SD-Core control plane.
+This exercise has helped 4G/5G 3gpp procedures validations with multiple access networks, tools and user equipments.
+Some of the widely used procedures are UE Registration/De-registration, UE PDU Establishment/modification/Deletion,
+Xn handover, UE Context Release & Service request etc. This activity also includes handling of retransmission of
+messages, retrying the messages when packet loss is observed over the network, handling no response from the peer
+network functions,handling of network function failures or handling of reject responses from peer network functions.
- - created to add subscriber contents in webui/config4g pod
- - Simapp also supports addition of network slice, device group in the SD-Core (5G/4G)
- - Simapp can update the configuration during runtime (add, delete, modify config)
- - Support of API to send the Network Slice & Device Group slice when configPod asks for it
- - 5G Specific Features
+**Operations support to manage multiple PLMN within Core Network:** SD-Core supports configuration
+of multiple slices with different PLMN. This helps in sharing the same core network among multiple
+operator networks. Each SD-Core network function is capable of handling multiple PLMN in the network.
- - 3gpp Supported & Validated Procedures are,
+**Multiple User plane support using APN (4G) and Slice Id (5G) using CUPS call flows:** SD-Core
+supports connections from multiple user planes. Even multiple user planes from the same edge can
+connect to same control plane. Control plane uses APN or Slice ID to identify user plane.
- - UE Registration/De-registration
- - UE PDU Establishment/modification/Deletion
- - More details about 3gpp compliance can be found at (see :ref:`4g-compliance`)
- and (see :ref:`5g-compliance`)
+**Metrics exposure to get visibility of radio network connections and UE connections:** SD-core
+uses prometheus to export metrics. These metrics are useful to get the status of various
+gNodeB/eNodeB connected to Core Network. Also SD-Core gives the metrics to share current user
+connectivity status.
- - Multiple PLMN support. Sending multiple PLMNs in NRF registration
- - Error handling on all interfaces. This includes message retransmission,
- rejected response handling, no response handling
+**SD-Core support 5000 calls at the rate of 10 calls per second per instance:** SD-Core 5G
+solution is build on top of free5gc open source code. Numerous enhancements done on the base
+code to get the production quality stability. One of the important goal we achieved was getting
+5000 subscribers with 10 subscribers attach per second. We will be pushing for higher limits in
+upcoming changes. To achieve this limit, AMF & SMF has seen numerous architecture level
+changes.
- - 4G specific features
- - APN based Selection of User Plane Network function.
- - CUPS compliant control plane
+**Slice Application Access Control using policy configuration:** Network slice really becomes
+useful when operator has the capability to apply access control. Operator can deploy multiple
+applications at the edge or internet and can restrict the users from accessing it based on the
+slice user belongs to. This adds extra layer of security in the edge app deployment.
- - Metrics
- - Subscriber metrics
- - eNB/gNB metrics
-
- - Scale Support
-
- - 4G - 16K calls at the rate of 100 calls have been tried
- - Handover rate of 50 handovers per second is supported by SD-Core
- - 5G - 5000 Calls at the rate of 10 calls per second
-
- - Operations Feature
-
- - UE/IMSI can be added while SD-Core is running
- - Network slice can be created in runtime
- - UE/IMSI can be removed from the slice at any time
-
- - Application Filtering
-
- - When multiple slices are created then devices in the slice can
- have access to only specified networks. More details of the application
- filtering can be found at - `TODO </overview/3gpp-compliance-4g>`
-
-New Features and Improvements
------------------------------
+**Policy framework to support QoS at multiple levels** SD-Core makes use of policy network
+function (PCF/PCRF) to enforce qos decisions on the subscriber session. Policies are configured
+per network slices using configuration interface. PCF/PCRF binds those policies to the subscribers.
+APIs gives the flexibility to Operator to assign UE level QoS, per application QoS and also slice level QoS.
Testing
-------
-
- - CI Run for all SD-Core repository
- - Common Repository like simapp, config pod changes trigger CI for 4G/5G
+For various testing related details refer (see :ref:`sdcore-testing`)
Documentation
-------------
@@ -82,9 +79,14 @@
Known Issues and Limitations
----------------------------
- - For any 3gpp release compliance refer - (see :ref:`4g-compliance`) and (see :ref:`5g-compliance`)
- - Same IMSI can not part of multiple slices
+ - Same IMSI can not part of multiple device groups
- Only 5 application filtering rules can be added per Slice
+ - Application filtering should be configured with only /32 endpoint address. Subnet is not supported
+ - Application filtering does not work if port ranges are used in filter configuration
+ - Each device group should have unique DNN configuration
+
+.. note::
+ For any 3gpp release compliance refer - (see :ref:`4g-compliance`) and (see :ref:`5g-compliance`)
Component Versions in the 1.0 Release
-------------------------------------
@@ -92,14 +94,14 @@
Helm Chart Versions and their component charts and containers:
* sdcore-helm-chart: ``0.9.14``
- * omec-control-plane: ``0.9.13``
+ * omec-control-plane: ``0.9.15``
* hssdb: ``registry.aetherproject.org/proxy/omecproject/c3po-hssdb:master-771c0c3``
* hss : ``registry.aetherproject.org/proxy/omecproject/c3po-hss:master-771c0c3``
* pcrf : ``registry.aetherproject.org/proxy/omecproject/c3po-pcrf:pcrf-a6bdc3d``
* pcrfdb : ``registry.aetherproject.org/proxy/omecproject/c3po-pcrf:pcrf-a6bdc3d``
- * config4g : ``registry.aetherproject.org/omecproject/5gc-webui:onf-release3.0.5-03d4139``
- * spgwc : ``registry.aetherproject.org/omecproject/spgw:master-282dc78``
- * mme : ``registry.aetherproject.org/proxy/omecproject/nucleus:master-1225da6``
+ * config4g : ``registry.aetherproject.org/omecproject/5gc-webui:onf-release3.0.5-e29f159``
+ * spgwc : ``registry.aetherproject.org/omecproject/spgw:master-144bd86``
+ * mme : ``registry.aetherproject.org/proxy/omecproject/nucleus:master-ccdbf69``
* omec-sub-provision: ``0.3.2``
* simapp: ``registry.aetherproject.org/omecproject/simapp:main-329c82d``
* 5g-control-plane: ``0.5.5``
diff --git a/testing/about_system_tests.rst b/testing/about_system_tests.rst
index b1ec5de..935052f 100644
--- a/testing/about_system_tests.rst
+++ b/testing/about_system_tests.rst
@@ -2,8 +2,8 @@
SPDX-FileCopyrightText: © 2021 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-About
-=====
+Overview
+========
The goal and objective of SD-Core test automation is to build a framework that
provides highly scalable and low maintenance code which will help cover various
diff --git a/testing/sdcore_testing.rst b/testing/sdcore_testing.rst
index ed3be94..64e9899 100644
--- a/testing/sdcore_testing.rst
+++ b/testing/sdcore_testing.rst
@@ -2,8 +2,10 @@
SPDX-FileCopyrightText: © 2021 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-SD-Core Testing
-===============
+.. _sdcore-testing:
+
+Test frameworks and coverage
+============================
Test Framework
--------------