blob: bf38e41046f1ddd26666ddf4d3d6cf5e435b7028 [file] [log] [blame]
ajayb3f40982021-12-08 14:26:11 -08001..
2 SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
3 SPDX-License-Identifier: Apache-2.0
4
ajay156b0262022-01-21 12:55:22 -08005SD-Core 1.0.0 Release
6=====================
Zack Williamsccaa38a2021-11-16 15:36:05 -07007
ajayce0380c2021-12-14 21:51:00 -08008SD-Core supports 4G & 5G network functions. SD-Core provides APIs for configuration, telemetry, policy
9management. Access network can connected to AMF or MME depending on type of access used. Below is the
10summary of the features delivered in SD-Core.
ajayd19711c2021-12-07 12:07:04 -080011
Zack Williamsccaa38a2021-11-16 15:36:05 -070012Highlights
13----------
14
ajayce0380c2021-12-14 21:51:00 -080015**Support of REST APIs to configure SD-Core:** Configuring multiple network functions to enable/disable a
16service in a network is complex. Single entry point for REST api based configuration is easy to use
17and less error prone. Our main motivation behind this work item was to hide the complexity of the network
18and make APIs more intuitive for the operator. These APIs work well for both 4G & 5G network functions.
ajayd19711c2021-12-07 12:07:04 -080019
ajayce0380c2021-12-14 21:51:00 -080020**Subscriber Management Interface**: 3gpp requires user security keys to be configured in the network function.
21We have provided two interfaces to configure subscribers in SD-Core. One of the way to configure subscribers
22is through REST api calls to SD-Core. The other way is to add/delete/modify subscription through helm charts.
23APIs are extensible and can be easily integrated with 3rd party sim provision solution. Also while operator
ajayf5b4f602021-12-14 22:55:47 -080024is updating the subscriptions, there is no need to restart any of the SD-Core components. This interface
ajayce0380c2021-12-14 21:51:00 -080025to SD-Core is access agnostic and same interface works for 4G as well as 5G access.
ajayd19711c2021-12-07 12:07:04 -080026
ajayce0380c2021-12-14 21:51:00 -080027**3gpp defined procedures validation and hardening for error scenarios:** SD-Core has been deployed in Aether
ajayf5b4f602021-12-14 22:55:47 -080028Network for more than 2 years now and in the year 2021 we added 5G support in the SD-Core. SD-Core is used in
29couple of operator trials. Also multiple Aether sites using different access networks to connect to
30centralized SD-Core control plane.
ajayce0380c2021-12-14 21:51:00 -080031This exercise has helped 4G/5G 3gpp procedures validations with multiple access networks, tools and user equipments.
32Some of the widely used procedures are UE Registration/De-registration, UE PDU Establishment/modification/Deletion,
33Xn handover, UE Context Release & Service request etc. This activity also includes handling of retransmission of
34messages, retrying the messages when packet loss is observed over the network, handling no response from the peer
35network functions,handling of network function failures or handling of reject responses from peer network functions.
ajayd19711c2021-12-07 12:07:04 -080036
ajayd19711c2021-12-07 12:07:04 -080037
ajayce0380c2021-12-14 21:51:00 -080038**Operations support to manage multiple PLMN within Core Network:** SD-Core supports configuration
39of multiple slices with different PLMN. This helps in sharing the same core network among multiple
40operator networks. Each SD-Core network function is capable of handling multiple PLMN in the network.
ajayd19711c2021-12-07 12:07:04 -080041
ajayce0380c2021-12-14 21:51:00 -080042**Multiple User plane support using APN (4G) and Slice Id (5G) using CUPS call flows:** SD-Core
43supports connections from multiple user planes. Even multiple user planes from the same edge can
44connect to same control plane. Control plane uses APN or Slice ID to identify user plane.
ajayd19711c2021-12-07 12:07:04 -080045
ajayce0380c2021-12-14 21:51:00 -080046**Metrics exposure to get visibility of radio network connections and UE connections:** SD-core
47uses prometheus to export metrics. These metrics are useful to get the status of various
48gNodeB/eNodeB connected to Core Network. Also SD-Core gives the metrics to share current user
49connectivity status.
ajayd19711c2021-12-07 12:07:04 -080050
ajay558fcc82021-12-15 09:18:14 -080051**SD-Core Scale support:** SD-Core 5G solution is build on top of free5gc open source code.
52Numerous enhancements done on the base code to get the production quality stability. One of
53the important goal we achieved was getting 5000 subscribers with 10 subscribers attach per
54second with single instance. We will be pushing for higher limits in upcoming changes.
55To achieve this limit, AMF & SMF has seen numerous architecture level changes. SD-Core 4G is
56built on top of OMEC project. 4G is tested for 16000 calls at the rate of 100 calls per second.
57All these results are achieved with distributed user plane. Vertical scaling can be done easily
58to achieve higher call setup rates.
ajayd19711c2021-12-07 12:07:04 -080059
ajayf5b4f602021-12-14 22:55:47 -080060**Application Filtering Support:** Network slice really becomes
ajayce0380c2021-12-14 21:51:00 -080061useful when operator has the capability to apply access control. Operator can deploy multiple
62applications at the edge or internet and can restrict the users from accessing it based on the
63slice user belongs to. This adds extra layer of security in the edge app deployment.
ajayd19711c2021-12-07 12:07:04 -080064
ajayd9952a52021-12-15 14:09:06 -080065**Policy framework to support QoS at multiple levels:** SD-Core makes use of policy network
ajayce0380c2021-12-14 21:51:00 -080066function (PCF/PCRF) to enforce qos decisions on the subscriber session. Policies are configured
ajayf5b4f602021-12-14 22:55:47 -080067per network slice using configuration interface. PCF/PCRF binds those policies to the subscribers.
ajayce0380c2021-12-14 21:51:00 -080068APIs gives the flexibility to Operator to assign UE level QoS, per application QoS and also slice level QoS.
Zack Williamsccaa38a2021-11-16 15:36:05 -070069
ajayd9952a52021-12-15 14:09:06 -080070**5G gNB simulator:** gNB simulator simulates 5G UE & 5G gNodeB. gNBSim is capable of supporting
Vini Gajjare43a47f2021-12-16 13:47:04 +053071multiple UEs and multiple gNodeBs. The tool is also capable of doing data tests. This assists quick
ajayd9952a52021-12-15 14:09:06 -080072development of the features. This tool can be used to run automated tests for the 5G core network.
Vini Gajjare43a47f2021-12-16 13:47:04 +053073Please refer :ref:`gNB-Simulator` documentation for more details.
ajayd9952a52021-12-15 14:09:06 -080074
Zack Williamsccaa38a2021-11-16 15:36:05 -070075Testing
76-------
ajayce0380c2021-12-14 21:51:00 -080077For various testing related details refer (see :ref:`sdcore-testing`)
ajayd19711c2021-12-07 12:07:04 -080078
Zack Williamsccaa38a2021-11-16 15:36:05 -070079Documentation
80-------------
81
ajayd19711c2021-12-07 12:07:04 -080082SD-Core documentation is available at `docs.sd-core.opennetworking.org
Zack Williamsccaa38a2021-11-16 15:36:05 -070083<https://docs.sd-core.opennetworking.org>`_
84
85
86Known Issues and Limitations
87----------------------------
88
ajayce0380c2021-12-14 21:51:00 -080089 - Same IMSI can not part of multiple device groups
ajay07514982021-12-07 22:24:32 -080090 - Only 5 application filtering rules can be added per Slice
ajayce0380c2021-12-14 21:51:00 -080091 - Application filtering should be configured with only /32 endpoint address. Subnet is not supported
92 - Application filtering does not work if port ranges are used in filter configuration
93 - Each device group should have unique DNN configuration
94
95.. note::
ajayf5b4f602021-12-14 22:55:47 -080096 For any 3gpp release compliance refer - (:ref:`4g-compliance`) and (:ref:`5g-compliance`)
ajayd19711c2021-12-07 12:07:04 -080097
Zack Williamsccaa38a2021-11-16 15:36:05 -070098Component Versions in the 1.0 Release
99-------------------------------------
100
101Helm Chart Versions and their component charts and containers:
102
ajay4433aeb2021-12-16 16:03:27 -0800103* sdcore-helm-chart: ``0.9.17``
ajayce0380c2021-12-14 21:51:00 -0800104 * omec-control-plane: ``0.9.15``
ajay07514982021-12-07 22:24:32 -0800105 * hssdb: ``registry.aetherproject.org/proxy/omecproject/c3po-hssdb:master-771c0c3``
106 * hss : ``registry.aetherproject.org/proxy/omecproject/c3po-hss:master-771c0c3``
107 * pcrf : ``registry.aetherproject.org/proxy/omecproject/c3po-pcrf:pcrf-a6bdc3d``
108 * pcrfdb : ``registry.aetherproject.org/proxy/omecproject/c3po-pcrf:pcrf-a6bdc3d``
ajayce0380c2021-12-14 21:51:00 -0800109 * config4g : ``registry.aetherproject.org/omecproject/5gc-webui:onf-release3.0.5-e29f159``
110 * spgwc : ``registry.aetherproject.org/omecproject/spgw:master-144bd86``
111 * mme : ``registry.aetherproject.org/proxy/omecproject/nucleus:master-ccdbf69``
ajay07514982021-12-07 22:24:32 -0800112 * omec-sub-provision: ``0.3.2``
113 * simapp: ``registry.aetherproject.org/omecproject/simapp:main-329c82d``
114 * 5g-control-plane: ``0.5.5``
115 * amf: ``registry.aetherproject.org/omecproject/5gc-amf:onf-release3.0.5-9683d5c``
116 * smf: ``registry.aetherproject.org/omecproject/5gc-smf:onf-release3.0.5-46dfe2d``
117 * nrf: ``registry.aetherproject.org/omecproject/5gc-nrf:onf-release3.0.5-13304e8``
118 * nssf: ``registry.aetherproject.org/omecproject/5gc-nssf:onf-release3.0.5-aa3a60b``
119 * pcf: ``registry.aetherproject.org/omecproject/5gc-pcf:onf-release3.0.5-9f7734b``
120 * udm: ``registry.aetherproject.org/omecproject/5gc-udm:onf-release3.0.5-c28433a``
121 * udr: ``registry.aetherproject.org/omecproject/5gc-udr:onf-release3.0.5-deef506``
122 * ausf: ``registry.aetherproject.org/omecproject/5gc-ausf:onf-release3.0.5-be7d4ac``
ajay4433aeb2021-12-16 16:03:27 -0800123 * User Plane ``0.5.4``
124 * bess: ``"registry.aetherproject.org/proxy/omecproject/upf-epc-bess:master-103b198"``
125 * pfcpiface: ``"registry.aetherproject.org/proxy/omecproject/upf-epc-pfcpiface:master-103b198"``
ajayd9952a52021-12-15 14:09:06 -0800126 * 5g-ran-sim ``0.3.2``
127 * gnbsim: ``registry.aetherproject.org/omecproject/5gc-gnbsim:dev-new-gnbsim-025ae2b``
ajay156b0262022-01-21 12:55:22 -0800128
129SD-Core 1.0.1 Release
Zack Williams7d058a92022-03-08 14:50:08 -0700130---------------------
ajay156b0262022-01-21 12:55:22 -0800131
132Minor release with bug fixes on top of release 1.0.0. Below is the list of defects fixed,
133
134* MME crash due to OOM kill.
135* MME fails to send PCO to SPGW - MME had NAS decoding issue which was causing MME to not send
136 PCO IE towards SPGW.
137* SPGW main thread blocks on DNS query - Improved SPGW code to raise DNS request in separate thread. Also
138 added support for DNS query timeout.
139* SMF changes to fix FAR action flags
140* SMF changes to support session report message to handle Downlink Data Notification from UPF.
141
142Helm Chart Versions and their component charts and containers:
143
144* sdcore-helm-chart: ``0.9.19``
145 * omec-control-plane: ``0.9.17``
146 * hssdb: ``registry.aetherproject.org/proxy/omecproject/c3po-hssdb:master-771c0c3``
147 * hss : ``registry.aetherproject.org/proxy/omecproject/c3po-hss:master-771c0c3``
148 * pcrf : ``registry.aetherproject.org/proxy/omecproject/c3po-pcrf:pcrf-a6bdc3d``
149 * pcrfdb : ``registry.aetherproject.org/proxy/omecproject/c3po-pcrf:pcrf-a6bdc3d``
150 * config4g : ``registry.aetherproject.org/omecproject/5gc-webui:onf-release3.0.5-e29f159``
151 * spgwc : ``registry.aetherproject.org/omecproject/spgw:master-4fce2e6``
152 * mme : ``registry.aetherproject.org/proxy/omecproject/nucleus:master-a503ae3``
153 * omec-sub-provision: ``0.3.2``
154 * simapp: ``registry.aetherproject.org/omecproject/simapp:main-329c82d``
155 * 5g-control-plane: ``0.5.6``
156 * amf: ``registry.aetherproject.org/omecproject/5gc-amf:onf-release3.0.5-9683d5c``
157 * smf: ``registry.aetherproject.org/omecproject/5gc-smf:onf-release3.0.5-3c91931``
158 * nrf: ``registry.aetherproject.org/omecproject/5gc-nrf:onf-release3.0.5-13304e8``
159 * nssf: ``registry.aetherproject.org/omecproject/5gc-nssf:onf-release3.0.5-aa3a60b``
160 * pcf: ``registry.aetherproject.org/omecproject/5gc-pcf:onf-release3.0.5-9f7734b``
161 * udm: ``registry.aetherproject.org/omecproject/5gc-udm:onf-release3.0.5-c28433a``
162 * udr: ``registry.aetherproject.org/omecproject/5gc-udr:onf-release3.0.5-deef506``
163 * ausf: ``registry.aetherproject.org/omecproject/5gc-ausf:onf-release3.0.5-be7d4ac``
164 * User Plane ``0.5.4``
165 * bess: ``"registry.aetherproject.org/proxy/omecproject/upf-epc-bess:master-103b198"``
166 * pfcpiface: ``"registry.aetherproject.org/proxy/omecproject/upf-epc-pfcpiface:master-103b198"``
167 * 5g-ran-sim ``0.3.2``
168 * gnbsim: ``registry.aetherproject.org/omecproject/5gc-gnbsim:dev-new-gnbsim-025ae2b``