gNB documentation improvement for deployment
Change-Id: Ic1ca79872b370dc4c35c88401ba6a5137e3ec91d
diff --git a/_static/images/Separate-cluster_2_interface.jpg b/_static/images/Separate-cluster_2_interface.jpg
new file mode 100644
index 0000000..1c7bcbd
--- /dev/null
+++ b/_static/images/Separate-cluster_2_interface.jpg
Binary files differ
diff --git a/_static/images/Separate-cluster_Single_interface.jpg b/_static/images/Separate-cluster_Single_interface.jpg
new file mode 100644
index 0000000..7939a6f
--- /dev/null
+++ b/_static/images/Separate-cluster_Single_interface.jpg
Binary files differ
diff --git a/_static/images/Single-cluster_2_interface.jpg b/_static/images/Single-cluster_2_interface.jpg
new file mode 100644
index 0000000..42f6ec1
--- /dev/null
+++ b/_static/images/Single-cluster_2_interface.jpg
Binary files differ
diff --git a/developer/gnbsim.rst b/developer/gnbsim.rst
index 927c8af..9c769b7 100644
--- a/developer/gnbsim.rst
+++ b/developer/gnbsim.rst
@@ -3,10 +3,104 @@
SPDX-License-Identifier: Apache-2.0
.. _gNB-Simulator:
-gNB Simulator
-=============
+gNB Simulator Deployment
+========================
-.. image:: ../_static/images/gNBSim.png
+gNB Simulator can be deployed in following modes,
+
+**gNB simulator in AIAB mode with 2 interfaces:**
+-------------------------------------------------
+
+- This is default mode of deployment for gNB Simulator
+- Multus cni needs to be enabled on cluster. Required for bess-upf & gNB
+- `make 5gc` will by default deploy gNB Simulator in this mode
+- One interface is used for user plane traffic towards UPF
+- Second interface is used to send traffic towards control plane (i.e. AMF).
+- UPF network & default gateway is provided in the override values.
+- Route to UPF network is added when POD comes up
+- defaultAs is configured per profile. This address is used to send data traffic during test
+
+.. note::
+ Multiple gNB's in one simulator instance need more changes in helm chart. This is pending work.
+
+To add UPF routes. Following is example of override values ::
+
+ config:
+ gnbsim:
+ gnb:
+ ip: 192.168.251.5/24 #user plane IP at gnb if 2 separate interface provided
+ singleInterface: false
+ networkTopo:
+ - upfAddr: "192.168.252.3/32"
+ upfGw: "192.168.251.1"
+
+
+.. image:: ../_static/images/Single-cluster_2_interface.jpg
+ :width: 700px
+
+**gNB simulator running standalone with 2 or more interfaces**
+--------------------------------------------------------------
+
+- Install gNB Simulator on any K8s cluster
+- Multus cni needs to be enabled on cluster. Required for bess-upf & gNB
+- Make sure gNB Simulator can communicate with AMF & UPF
+- *TODO* - New Makefile target will deploy just 5G control plane
+- *TODO* - New Makefile target will deploy only gNB Simulator
+- One interface is used for user plane traffic towards UPF
+- Second interface is used to send traffic towards control plane (i.e. AMF).
+- UPF network & default gateway is provided in the override values.
+- Route to UPF network is added when POD comes up
+- defaultAs is configured per profile. This address is used to send data traffic during test
+- configure AMF address or FQDN appropriately
+
+.. note::
+ Multiple gNB's in one simulator instance need more changes in helm chart. This is pending work.
+
+
+To add UPF routes. Following is example of override values ::
+
+ config:
+ gnbsim:
+ gnb:
+ ip: 192.168.251.5/24 #user plane IP at gnb if 2 separate interface provided
+ singleInterface: false
+ networkTopo:
+ - upfAddr: "192.168.252.3/32"
+ upfGw: "192.168.251.1"
+
+.. image:: ../_static/images/Separate-cluster_2_interface.jpg
+ :width: 700px
+
+
+**gNB simulator running standalone with single interface**
+----------------------------------------------------------
+
+- Install gNB Simulator on any K8s cluster
+- Multus cni needs to be enabled for the K8s cluster where bess-upf runs
+- Make sure gNB Simulator can communicate with AMF & UPF
+- *TODO* - New Makefile target will deploy just 5G control plane
+- *TODO* - New Makefile target will deploy only gNB Simulator
+- Single interface is used for user plane traffic towards UPF & as well traffic towards AMF
+- defaultAs is configured per profile. This address is used to send data traffic during test
+- configure AMF address or FQDN appropriately
+
+.. note::
+ Multiple gNB's can not be simulated since only 1 gNB will be able to use 2152 port
+
+
+Following is example of override values ::
+
+ config:
+ gnbsim:
+ singleInterface: true
+ yamlCfgFiles:
+ gnb.conf:
+ configuration:
+ gnbs: # pool of gNodeBs
+ gnb1:
+ n3IpAddr: "POD_IP" # set if singleInterface is true
+
+.. image:: ../_static/images/Separate-cluster_Single_interface.jpg
:width: 700px
Description
diff --git a/dict.txt b/dict.txt
index 5dfe765..3527258 100644
--- a/dict.txt
+++ b/dict.txt
@@ -12,6 +12,7 @@
Deregistration
Dockerfile
Downlink
+FQDN
GC
Gerrit
Gi
@@ -26,6 +27,7 @@
Kubernetes
LTE
MME
+Makefile
Mbps
Minikube
NRF
@@ -75,6 +77,7 @@
bess
bitrate
cd
+cni
conf
config
configPod
@@ -82,6 +85,7 @@
configs
configurability
dataplane
+defaultAs
deregistration
dev
disaggregated
@@ -131,6 +135,7 @@
mme
mnc
mtu
+multus
myvalues
namespace
natively
