Updated Release feature and 4G compliance
Change-Id: Ic9127e3f7a7bd91f61e16839f13eda1ea4aaaeca
Updated Release feature and 4G compliance
and updated deployment guide
Change-Id: I835d4bf4ed194fa207027f3200ad966d15e3a904
diff --git a/deployment/deployment.rst b/deployment/deployment4G.rst
similarity index 68%
rename from deployment/deployment.rst
rename to deployment/deployment4G.rst
index c104782..46aa7c3 100644
--- a/deployment/deployment.rst
+++ b/deployment/deployment4G.rst
@@ -2,10 +2,10 @@
SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-.. _deployment_guide:
+.. _deployment_4G_guide:
-Deployment Guide
-================
+4G Deployment Guide
+====================
Deployment Overview
-------------------
@@ -94,49 +94,3 @@
helm -n sdcore-4g uninstall sdcore-4g
kubectl delete namespace sdcore-4g # also remove the sdcore-4g if needed
-
-
-Production Environments - 5G
-""""""""""""""""""""""""""""
-
-To install SD-Core into your Kubernetes cluster, follow instructions
-
-Step1 - Clone SD-Core 5G Helm chart
-'''''''''''''''''''''''''''''''''''
-.. code-block::
-
- git clone ssh://gerrit.opencord.org:29418/sdcore-helm-charts
- cd sdcore-helm-charts/sdcore-helm-charts/
- helm dep update #Update Helm dependencies
-
-Step2 - Prepare your Helm value for 5G
-''''''''''''''''''''''''''''''''''''''
-
-You can modify existing values.yaml directly, but we recommend composing another value
-file myvalues.yaml using values.yaml as an example. We are highlighting a few things we
-need to modify here. More explanation of the supported Helm values can be found in the
-Configuration section below.
-
-Step3 - Install 5G using SD-Core umbrella helm chart
-''''''''''''''''''''''''''''''''''''''''''''''''''''
-
-The following command will deploy the SD-Core helm chart with release name sdcore-4g in the sdcore-4g namespace.
-
-.. code-block::
-
- helm install -n sdcore-5g --create-namespace -f myvaules.yaml sdcore-5g .
-
-To verify the installation:
-
-.. code-block::
-
- helm -n sdcore-5g ls
-
-To uninstall:
-
-.. code-block::
-
- helm -n sdcore-5g uninstall sdcore-5g
- kubectl delete namespace sdcore-5g # also remove the sdcore-5g if needed
-
-
diff --git a/deployment/deployment.rst b/deployment/deployment5G.rst
similarity index 62%
copy from deployment/deployment.rst
copy to deployment/deployment5G.rst
index c104782..30537d6 100644
--- a/deployment/deployment.rst
+++ b/deployment/deployment5G.rst
@@ -2,10 +2,10 @@
SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-.. _deployment_guide:
+.. _deployment_5G_guide:
-Deployment Guide
-================
+5G Deployment Guide
+===================
Deployment Overview
-------------------
@@ -17,15 +17,17 @@
Hardware resource requirement
-----------------------------
-SD-Core 4G has following K8s pods
+SD-Core 5G has following K8s pods
- - 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
+ - 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
Prepare access credential for SD-Core images
--------------------------------------------
@@ -52,50 +54,6 @@
TODO - AIAB document link
-Production Environments - 4G
-""""""""""""""""""""""""""""
-
-To install SD-Core into your Kubernetes cluster, follow instructions
-
-Step1 - Clone SD-Core 4G Helm chart
-'''''''''''''''''''''''''''''''''''
-.. code-block::
-
- git clone ssh://gerrit.opencord.org:29418/sdcore-helm-charts
- cd sdcore-helm-charts/sdcore-helm-charts/
- helm dep update #Update Helm dependencies
-
-Step2 - Prepare your Helm values for 4G
-'''''''''''''''''''''''''''''''''''''''
-
-You can modify existing values.yaml directly, but we recommend composing another value
-file myvalues.yaml using values.yaml as an example. We are highlighting a few things we
-need to modify here. More explanation of the supported Helm values can be found in the
-Configuration section below.
-
-Step3 - Install 4G using SD-Core umbrella helm chart
-''''''''''''''''''''''''''''''''''''''''''''''''''''
-
-The following command will deploy the SD-Core helm chart with release name sdcore-4g in the sdcore-4g namespace.
-
-.. code-block::
-
- helm install -n sdcore-4g --create-namespace -f myvaules.yaml sdcore-4g .
-
-To verify the installation:
-
-.. code-block::
-
- helm -n sdcore-4g ls
-
-To uninstall:
-
-.. code-block::
-
- helm -n sdcore-4g uninstall sdcore-4g
- kubectl delete namespace sdcore-4g # also remove the sdcore-4g if needed
-
-
Production Environments - 5G
""""""""""""""""""""""""""""
diff --git a/dict.txt b/dict.txt
index b127cf6..cdcf4f5 100644
--- a/dict.txt
+++ b/dict.txt
@@ -1,3 +1,7 @@
+ap
+Gx
+Sxab
+Resynchronization
Aether
Dockerfile
ONF
@@ -15,7 +19,9 @@
virtualenv
MME
SPGW
+spgwc
HSS
+hss
PCRF
AMF
SMF
@@ -34,7 +40,6 @@
Downlink
Keepalive
grpc
-hss
mme
spgw
pcrf
diff --git a/index.rst b/index.rst
index fb3b569..3e68b0b 100644
--- a/index.rst
+++ b/index.rst
@@ -1,9 +1,8 @@
SD-Core Documentation
=====================
-SD-Core is an ONF's 5G/LTE Core. More information about SD-Core can be found at
-the `ONF website <https://opennetworking.org/sd-core/>`_.
-
+SD-Core is an ONF's 4G/5G Core. SD-Core is cloud native implementation of 4G/5G core network functions.
+Aether uses SD-Core to provided connectivity as a service.
Getting Started with SD-Core
----------------------------
@@ -24,7 +23,7 @@
---------
Information about participating in the SD Core community and development process
-can be found on the `ONF Wiki
+can be found on the `SD-Core Wiki
<https://wiki.opennetworking.org/display/COM/SD-Core>`_.
.. toctree::
@@ -47,7 +46,8 @@
:glob:
configuration/config.rst
- deployment/deployment.rst
+ deployment/deployment4G.rst
+ deployment/deployment5G.rst
.. toctree::
:maxdepth: 2
diff --git a/overview/3gpp-compliance-4g.rst b/overview/3gpp-compliance-4g.rst
index 097e6ed..b9e1bfe 100644
--- a/overview/3gpp-compliance-4g.rst
+++ b/overview/3gpp-compliance-4g.rst
@@ -1,38 +1,85 @@
+.. _4g-compliance:
+
4G - 3GPP Release Compliance
============================
+High Level Procedures Supported
+-------------------------------
+
+ - Initial UE Attach
+ - UE Detach
+ - S1 Release
+ - Service Request
+ - N/W initiated Detach
+ - Downlink Data Notification
+ - s1/x2 Handover for eNB change
+ - 5G-NSA related procedure support
+
+High Level Procedures/Functions Not Supported
+---------------------------------------------
+
+ - MME, SGW handover
+ - Indirect tunnel forwarding
+ - Roaming architecture
+ - Charging
+ - Lawful intercept
+ - IMS integration
+
MME Compliance
--------------
-* Interface support
+* Interface supported : NAS, s1ap, S6a, S11
* Functions supported
+
+ - All the procedures mentioned above and following,
+ - Dedicated bearer handling
+ - s1ap interface management procedure
+ - S1 Context management procedures
+ - Subscriber management procedure on S6a interface
+
* Functions not supported
+ - HSS modify/delete subscriber data
+
SPGW Compliance
----------------
-* Interface support
-* Functions supported
+* Interface supported: Gx, Sxab
+* Functions supported: All the procedures mentioned above and following,
+
+ - PFCP Association management
+ - Control plane based UE address allocation
+ - User Plane based UE address allocation
+ - Receive and handle Usage Report sent by user plane
+
* Functions not supported
PCRF Compliance
----------------
-* Interface support
+* Interface supported: Gx
* Functions supported
+
+ - Installing PCC rules for the subscribers
+ - Removal of Rules with timer trigger
+ - Removal of Gx Session with timer trigger
+
* Functions not supported
+ - Charging functionality
+ - PCEF initiated Gx session update
+
HSS Compliance
---------------
-* Interface support
+* Interface supported: S6a
* Functions supported
+
+ - Subscriber management
+ - Authentication Vector generation
+ - Resynchronization of authentication vector
+ - Update Location procedure
+ - Purge Location procedure
+
* Functions not supported
-SD Core High Level Features supported
--------------------------------------
-* UE Attach
-* UE Detach
-* Service Request
-* S1 Release
-* Downlink Data Notification
-* eNB s1 handover
-* eNB x2 handover
+ - Insert subscriber data runtime
+ - Delete Subscriber data runtime
diff --git a/overview/3gpp-compliance-5g.rst b/overview/3gpp-compliance-5g.rst
index 3dfdf2e..a86e168 100644
--- a/overview/3gpp-compliance-5g.rst
+++ b/overview/3gpp-compliance-5g.rst
@@ -1,3 +1,5 @@
+.. _5g-compliance:
+
5G - 3GPP Release Compliance
============================
diff --git a/release/1.0.rst b/release/1.0.rst
index fd16dbf..b4abdf4 100644
--- a/release/1.0.rst
+++ b/release/1.0.rst
@@ -25,7 +25,8 @@
- UE Registration/De-registration
- UE PDU Establishment/modification/Deletion
- - ``More details about Compliance can be found in compliance section``
+ - More details about 3gpp compliance can be found at (see :ref:`4g-compliance`)
+ and (see :ref:`5g-compliance`)
- Multiple PLMN support. Sending multiple PLMNs in NRF registration
- Error handling on all interfaces. This includes message retransmission,
@@ -56,7 +57,7 @@
- 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``
+ filtering can be found at - `TODO </overview/3gpp-compliance-4g>`
New Features and Improvements
-----------------------------
@@ -77,31 +78,32 @@
Known Issues and Limitations
----------------------------
- - Dedicated bearers are not supported in SD-Core
+ - For any 3gpp release compliance refer - (see :ref:`4g-compliance`) and (see :ref:`5g-compliance`)
- Same IMSI can not part of multiple slices
+ - Only 5 application filtering rules can be added per Slice
Component Versions in the 1.0 Release
-------------------------------------
Helm Chart Versions and their component charts and containers:
-* sdcore-helm-chart: ``0.1.0``
- * omec-control-plane: ``0.1.0``
- * hssdb: ``c3po-hssdb:0.1.0``
- * hss : ``TODO``
- * pcrf : ``TODO``
- * pcrfdb : ``TODO``
- * config4g : ``TODO``
- * spgw : ``TODO``
- * mme : ``TODO``
- * omec-sub-provision: ``TODO``
- * simapp: ``TODO``
- * 5g-control-plane: ``TODO``
- * amf: ``TODO``
- * smf: ``TODO``
- * nrf: ``TODO``
- * nssf: ``TODO``
- * pcf: ``TODO``
- * udm: ``TODO``
- * udr: ``TODO``
- * ausf: ``TODO``
+* sdcore-helm-chart: ``0.9.14``
+ * omec-control-plane: ``0.9.13``
+ * 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``
+ * omec-sub-provision: ``0.3.2``
+ * simapp: ``registry.aetherproject.org/omecproject/simapp:main-329c82d``
+ * 5g-control-plane: ``0.5.5``
+ * amf: ``registry.aetherproject.org/omecproject/5gc-amf:onf-release3.0.5-9683d5c``
+ * smf: ``registry.aetherproject.org/omecproject/5gc-smf:onf-release3.0.5-46dfe2d``
+ * nrf: ``registry.aetherproject.org/omecproject/5gc-nrf:onf-release3.0.5-13304e8``
+ * nssf: ``registry.aetherproject.org/omecproject/5gc-nssf:onf-release3.0.5-aa3a60b``
+ * pcf: ``registry.aetherproject.org/omecproject/5gc-pcf:onf-release3.0.5-9f7734b``
+ * udm: ``registry.aetherproject.org/omecproject/5gc-udm:onf-release3.0.5-c28433a``
+ * udr: ``registry.aetherproject.org/omecproject/5gc-udr:onf-release3.0.5-deef506``
+ * ausf: ``registry.aetherproject.org/omecproject/5gc-ausf:onf-release3.0.5-be7d4ac``