Updated deployment & config section
Updated deployment & config section, release 1.0 documentation
Change-Id: I8013fca369fcc687ccb9e2bd23985189558fc2a9
diff --git a/configuration/config.rst b/configuration/config.rst
index 63cd9be..fe0c678 100644
--- a/configuration/config.rst
+++ b/configuration/config.rst
@@ -1,5 +1,5 @@
-Overview
-========
+Configuration Overview
+======================
Reference helm chart
--------------------
diff --git a/deployment/deployment.rst b/deployment/deployment.rst
new file mode 100644
index 0000000..c104782
--- /dev/null
+++ b/deployment/deployment.rst
@@ -0,0 +1,142 @@
+..
+ SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+ SPDX-License-Identifier: Apache-2.0
+
+.. _deployment_guide:
+
+Deployment Guide
+================
+
+Deployment Overview
+-------------------
+SD-Core is released with Helm chart and container images.
+We recommend using **Kubernetes** and **Helm** to deploy SD-Core.
+SD-Core images are hosted on an ONF member-only Docker registry.
+You need to obtain access token and supply that as part of the Helm value.
+
+Hardware resource requirement
+-----------------------------
+
+SD-Core 4G 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
+
+Prepare access credential for SD-Core images
+--------------------------------------------
+
+Container images can be download from ONF self-hosted container registry but you have to gain the access token first.
+
+1. Login to `Aether Harbor Registry <https://registry.aetherproject.org/harbor/sign-in?redirect_url=%2Fharbor%2Fprojects>`_ using your ONF Crowd credential,
+2. Select ``User Profile`` drop-down menu in the upper-right corner
+3. Generate the CLI secret and it's the secret token you have to access the container registry via CLI tool.
+4. Login to the container registry with your username and access token
+ by ``docker login command`` to ensure you can access it.
+
+.. code-block::
+
+ ╰─$ docker login registry.aetherproject.org --username hwchiu
+ Password:
+ Login Succeeded
+
+Deployment Options
+------------------
+
+Development Environments
+""""""""""""""""""""""""
+
+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
+""""""""""""""""""""""""""""
+
+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/developer/aiab.rst b/developer/aiab.rst
new file mode 100644
index 0000000..b1ab030
--- /dev/null
+++ b/developer/aiab.rst
@@ -0,0 +1,2 @@
+Aether In a Box
+===============
diff --git a/dict.txt b/dict.txt
index 3918254..5ee6bd4 100644
--- a/dict.txt
+++ b/dict.txt
@@ -113,3 +113,10 @@
Nudm
Nausf
Namf
+Gi
+Kubernetes
+myvalues
+namespace
+webui
+runtime
+retransmission
diff --git a/index.rst b/index.rst
index c78612f..fb3b569 100644
--- a/index.rst
+++ b/index.rst
@@ -42,11 +42,12 @@
.. toctree::
:maxdepth: 2
- :caption: Configuration
+ :caption: Configuration & Deployment
:hidden:
:glob:
configuration/config.rst
+ deployment/deployment.rst
.. toctree::
:maxdepth: 2
@@ -63,6 +64,7 @@
:glob:
developer/guide.rst
+ developer/aiab.rst
developer/gnbsim.rst
developer/testpod.rst
diff --git a/release/1.0.rst b/release/1.0.rst
index e04e4fc..fd16dbf 100644
--- a/release/1.0.rst
+++ b/release/1.0.rst
@@ -1,25 +1,85 @@
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.
+
Highlights
----------
+ - REST configuration interface support
+
+ - Network Slices can be added, deleted, modified using REST interface
+ - ``Refer Configuration Guide for more details``
+
+ - SIMapp support for subscriber management
+
+ - 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
+
+ - 3gpp Supported & Validated Procedures are,
+
+ - UE Registration/De-registration
+ - UE PDU Establishment/modification/Deletion
+ - ``More details about Compliance can be found in compliance section``
+
+ - Multiple PLMN support. Sending multiple PLMNs in NRF registration
+ - Error handling on all interfaces. This includes message retransmission,
+ rejected response handling, no response handling
+
+ - 4G specific features
+ - APN based Selection of User Plane Network function.
+ - CUPS compliant control plane
+
+ - 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``
+
New Features and Improvements
-----------------------------
Testing
-------
+ - CI Run for all SD-Core repository
+ - Common Repository like simapp, config pod changes trigger CI for 4G/5G
+
Documentation
-------------
-Aether documentation is available at `docs.sd-core.opennetworking.org
+SD-Core documentation is available at `docs.sd-core.opennetworking.org
<https://docs.sd-core.opennetworking.org>`_
Known Issues and Limitations
----------------------------
+ - Dedicated bearers are not supported in SD-Core
+ - Same IMSI can not part of multiple slices
+
Component Versions in the 1.0 Release
-------------------------------------