Updating config examples
Change-Id: I6165743a1a2d8cba4e7b3f123aacc96b3b4548e7
diff --git a/configuration/config_rest.rst b/configuration/config_rest.rst
index f34f939..8ce5ea5 100644
--- a/configuration/config_rest.rst
+++ b/configuration/config_rest.rst
@@ -9,10 +9,12 @@
subscribers, device groups and network slice
-Subscriber Configuration through REST Interface
-"""""""""""""""""""""""""""""""""""""""""""""""
+Subscriber Configuration
+""""""""""""""""""""""""
-Below example configures subscriber `208014567891209` in the SD-Core
+Below example configures subscriber `208014567891209` in the SD-Core. You can any
+number of subscribers using these APIs. SD-Core takes care of configuring Network
+Function responsible for authentication with the below details.
.. code-block::
@@ -34,9 +36,11 @@
URL: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-xxx>`
Ex: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-208014567891209>`
-
-Device Group Configuration through REST Interface
-"""""""""""""""""""""""""""""""""""""""""""""""""
+Device Group Configuration
+""""""""""""""""""""""""""
+Below example groups multiple IMSIs under one IP domain. IP domain is close
+match with APN in 4G & dnn in case of 5G. Along with UE IP pool, there is
+also configuration of QoS for the users in this group.
.. code-block::
@@ -66,7 +70,14 @@
"dnn-mbr-uplink": 4000000,
"dnn-mbr-downlink": 20000000,
"bitrate-unit": "Mbps",
- "traffic-class": "platinum"
+ "traffic-class":
+ {
+ "qci": 9,
+ "arp": 1,
+ "pdb": 2,
+ "pelr": 1,
+ "name": "platinum"
+ }
}
}
}
@@ -75,8 +86,14 @@
URL: `http://<config-service-name-or-ip>:<port>/device-group/<group-name>`
Ex: `http://config5g:8080/device-group/iot-camera`
-Network Slice Configuration through REST Interface
-""""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. note::
+ REST API can use PUT Method to modify/replace the device group configuration.
+ IMSIs can be added, removed through PUT Method.
+
+Network Slice Configuration
+"""""""""""""""""""""""""""
+Below example creates Network Slice with set of eNBs, UPF and device groups.
.. code-block::
@@ -97,7 +114,14 @@
"uplink": 4000000,
"downlink": 20000000,
"bitrate-unit": "Mbps",
- "traffic-class": "platinum"
+ "traffic-class":
+ {
+ "qci": 9,
+ "arp": 1,
+ "pdb": 2,
+ "pelr": 1,
+ "name": "platinum"
+ }
},
"site-device-group":
[
@@ -130,4 +154,93 @@
URL: `http://<config-service-name-or-ip>:<port>/network-slice/<slice-name>`
Ex: `http://config5g:8080/network-slice/slice1`
+.. note::
+ Slice needs to have single UPF. Multiple UPFs can not be added in single Slice. One or more access
+ nodes can be added in slice. For now SD-Core does not do any validation of access nodes connecting
+ to MME/AMF, but TAC & PLMN validation is done in Core Network.
+Network Slice + Application filtering Configuration
+"""""""""""""""""""""""""""""""""""""""""""""""""""
+Below example creates Network Slice with set of eNBs, UPF and device groups.
+Note that this slice only allows traffic to single application hosted at
+address 10.91.1.3
+.. code-block::
+
+ - Post:
+ URL: `http://<config-service-name-or-ip>:<port>/network-slice/<slice-name>`
+ Ex: `http://config5g:8080/network-slice/slice1`
+
+
+ Request Body:
+ {
+ "slice-id":
+ {
+ "sst": "1",
+ "sd": "010203"
+ },
+ "qos":
+ {
+ "uplink": 4000000,
+ "downlink": 20000000,
+ "bitrate-unit": "Mbps",
+ "traffic-class":
+ {
+ "qci": 9,
+ "arp": 1,
+ "pdb": 2,
+ "pelr": 1,
+ "name": "platinum"
+ }
+ },
+ "site-device-group":
+ [
+ "iot-camera"
+ ],
+ "site-info":
+ {
+ "site-name": "menlo",
+ "plmn":
+ {
+ "mcc": "315",
+ "mnc": "010"
+ },
+ "gNodeBs":
+ [
+ {
+ "name": "menlo-gnb1",
+ "tac": 1
+ }
+ ],
+ "upf":
+ {
+ "upf-name": "upf.menlo.aetherproject.org",
+ "upf-port": 8805
+ }
+ },
+ "application-filtering-rules":
+ [
+ {
+ "rule-name": rule-1,
+ "priority": 5,
+ "action" : permit,
+ "endpoint": "10.91.1.3",
+ "traffic-class":
+ {
+ "name": “platinum”,
+ "qci": 9,
+ "arp": 125,
+ "pdb": 300,
+ "pelr": 6
+ }
+ }
+ ]
+ }
+
+ - Delete
+ URL: `http://<config-service-name-or-ip>:<port>/network-slice/<slice-name>`
+ Ex: `http://config5g:8080/network-slice/slice1`
+
+
+.. note::
+ ROC uses REST APIs to configure SD-Core. ROC provides nice web portal to manage network slices and devices.
+ `Refer Aether document <https://docs.aetherproject.org/>`_.
diff --git a/configuration/config_simapp.rst b/configuration/config_simapp.rst
index 1ba0e41..6029c71 100644
--- a/configuration/config_simapp.rst
+++ b/configuration/config_simapp.rst
@@ -67,5 +67,22 @@
upf:
upf-name: "upf"
upf-port: 8805
+ application-filtering-rules:
+ - rule-name: “rule-1”
+ priority: 5
+ action : permit
+ endpoint: "10.91.1.3"
+ traffic-class:
+ name: “platinum”
+ qci: 9
+ arp: 125
+ pdb: 300
+ pelr: 6
-
+.. note::
+ Simapp takes initial configuration through helm chart. Above yaml files is initial config.
+ Operator can add multiple devices, device groups & slices in the initial config. If simapp
+ is already running then ``kubectl edit configmap simapp -n <namespace>`` can be used to update
+ the simapp configuration. Simapp handles config delete, modify & addition by watching configmap
+ for any changes. There is no need to restart simapp after configmap change. New config will
+ be automatically reloaded.
diff --git a/dict.txt b/dict.txt
index ae926e1..96a5cf9 100644
--- a/dict.txt
+++ b/dict.txt
@@ -1,3 +1,4 @@
+configmap
gNBSim
eb
152a5eb