Misc changes
Fixing gnbsim reference
Adding sdcore logo image
separated configuration section
Change-Id: Ib6ec73d8528a3e197c0e19be6a3ee7c1942c6211
diff --git a/configuration/application_filtering.rst b/configuration/application_filtering.rst
new file mode 100644
index 0000000..606f76e
--- /dev/null
+++ b/configuration/application_filtering.rst
@@ -0,0 +1,95 @@
+.. _application-filtering:
+
+Application Filtering Overview
+==============================
+
+Below config snapshot shows how to configure application filtering in the network slice.
+Each application filter in the network slice can have action either ``permit`` or ``deny``
+
+.. code-block::
+
+ config:
+ simapp:
+ cfgFiles:
+ simapp.yaml:
+ configuration:
+ provision-network-slice: true
+ sub-provision-endpt:
+ addr: config4g
+ port: 5000
+ subscribers:
+ - ueId-start: 208014567891201
+ ueId-end: 208014567891211
+ plmnId: 20801
+ opc: "d4416644f6154936193433dd20a0ace0"
+ op: ""
+ key: "465b5ce8b199b49faa5f0a2ee238a6bc"
+ sequenceNumber: 96
+ device-groups:
+ - name: "4g-oaisim-user"
+ imsis:
+ - "208014567891201"
+ - "208014567891202"
+ ip-domain-name: "pool1"
+ ip-domain-expanded:
+ dnn: internet
+ dns-primary: "8.8.8.8"
+ mtu: 1460
+ ue-ip-pool: "172.250.0.0/16"
+ ue-dnn-qos:
+ dnn-mbr-downlink: 20000000
+ dnn-mbr-uplink: 4000000
+ bitrate-unit: bps
+ traffic-class: #default bearer QCI/ARP
+ name: "platinum"
+ qci: 9
+ arp: 1
+ pdb: 300
+ pelr: 6
+ site-info: "aiab"
+
+ network-slices:
+ - name: "default"
+ slice-id:
+ sd: "010203"
+ sst: 1
+ site-device-group:
+ - "4g-oaisim-user"
+ application-filtering-rules:
+ - rule-name: "deny-private1"
+ priority: 250
+ action: permit
+ endpoint: "10.0.0.0/8"
+ protocol: 6
+ dest-port-start: 20005
+ dest-port-end : 20005
+ traffic-class:
+ name: “platinum”
+ qci: 9
+ arp: 1
+ pdb: 300
+ pelr: 6
+ - rule-name: “deny-private-2”
+ priority: 251
+ action : permit
+ endpoint: "172.16.0.0/16"
+ protocol: 6
+ dest-port-start: 20005
+ dest-port-end : 20005
+ traffic-class:
+ name: “platinum”
+ qci: 9
+ arp: 1
+ pdb: 300
+ pelr: 6
+ site-info:
+ gNodeBs:
+ - name: "aiab-gnb1"
+ tac: 1
+ plmn:
+ mcc: "208"
+ mnc: "01"
+ site-name: "aiab"
+ upf:
+ upf-name: "upf"
+ upf-port: 8805
diff --git a/configuration/config.rst b/configuration/config.rst
index b83b16e..155082f 100644
--- a/configuration/config.rst
+++ b/configuration/config.rst
@@ -46,200 +46,6 @@
- Add device Group into Network Slice
- Slice contains the Slice level QoS configuration
- Site configuration including UPF, eNBs/gNBs assigned to the slice
- - Applications allowed to be accessed by this slice
-
-Option I - Configuration using Simapp POD
------------------------------------------
-
-Easiest way to configure SD-Core is to use simapp. Simapp is the POD which takes
-yaml configuration and configures the subscribers, device groups, network slices
-
-.. code-block::
-
- config:
- simapp:
- cfgFiles:
- simapp.yaml:
- configuration:
- provision-network-slice: true
- sub-provision-endpt:
- addr: config4g
- port: 5000
- subscribers:
- - ueId-start: 208014567891201
- ueId-end: 208014567891211
- plmnId: 20801
- opc: "d4416644f6154936193433dd20a0ace0"
- op: ""
- key: "465b5ce8b199b49faa5f0a2ee238a6bc"
- sequenceNumber: 96
- device-groups:
- - name: "4g-oaisim-user"
- imsis:
- - "208014567891201"
- - "208014567891202"
- ip-domain-name: "pool1"
- ip-domain-expanded:
- dnn: internet
- dns-primary: "8.8.8.8"
- mtu: 1460
- ue-ip-pool: "172.250.0.0/16"
- ue-dnn-qos:
- dnn-mbr-downlink: 20000000
- dnn-mbr-uplink: 4000000
- bitrate-unit: bps
- traffic-class: #default bearer QCI/ARP
- name: "platinum"
- qci: 9
- arp: 1
- pdb: 300
- pelr: 6
- site-info: "aiab"
- network-slices:
- - name: "default"
- slice-id:
- sd: "010203"
- sst: 1
- site-device-group:
- - "4g-oaisim-user"
- site-info:
- gNodeBs:
- - name: "aiab-gnb1"
- tac: 1
- plmn:
- mcc: "208"
- mnc: "01"
- site-name: "aiab"
- upf:
- upf-name: "upf"
- upf-port: 8805
-
-Option II - Configuration using REST Interface
-----------------------------------------------
-
-You can decide to use any other tool to generate REST messages towards SD-Core to configure
-subscribers, device groups and network slice
-
-
-Subscriber Configuration through REST Interface
-"""""""""""""""""""""""""""""""""""""""""""""""
-
-Below example configures subscriber `208014567891209` in the SD-Core
-
-.. code-block::
-
- - Post:
- URL: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-xxx>`
- Ex: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-208014567891209>`
-
- Request Body:
-
- {
- "UeId":"208014567891209",
- "plmnId":"20801",
- "opc":"d4416644f6154936193433dd20a0ace0",
- "key":"465b5ce8b199b49faa5f0a2ee238a6bc",
- "sequenceNumber":"96"
- }
-
- - Delete:
- 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
-"""""""""""""""""""""""""""""""""""""""""""""""""
-
-.. code-block::
-
- - Post:
- URL: `http://<config-service-name-or-ip>:<port>/device-group/<group-name>`
- Ex: `http://config5g:8080/device-group/iot-camera`
-
- Request Body:
- {
- "imsis":
- [
- "123456789123456"
- "123456789123457"
- "123456789123458"
- ],
- "site-info": "menlo",
- "ip-domain-name": "pool1",
- "ip-domain-expanded":
- {
- "dnn": "internet",
- "ue-ip-pool": "10.91.0.0/16",
- "dns-primary": "8.8.8.8",
- "dns-secondary": "8.8.4.4",
- "mtu": 1460,
- "ue-dnn-qos":
- {
- "dnn-mbr-uplink": 4000000,
- "dnn-mbr-downlink": 20000000,
- "bitrate-unit": "Mbps",
- "traffic-class": "platinum"
- }
- }
- }
-
- - Delete
- 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
-""""""""""""""""""""""""""""""""""""""""""""""""""
-
-.. 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": "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
- }
- },
- }
-
- - Delete
- URL: `http://<config-service-name-or-ip>:<port>/network-slice/<slice-name>`
- Ex: `http://config5g:8080/network-slice/slice1`
+ - Applications allowed to be accessed by this slice (see :ref:`application-filtering`)
diff --git a/configuration/config_rest.rst b/configuration/config_rest.rst
new file mode 100644
index 0000000..63d6a76
--- /dev/null
+++ b/configuration/config_rest.rst
@@ -0,0 +1,129 @@
+Configuration using REST Interface
+==================================
+
+You can decide to use any other tool to generate REST messages towards SD-Core to configure
+subscribers, device groups and network slice
+
+
+Subscriber Configuration through REST Interface
+"""""""""""""""""""""""""""""""""""""""""""""""
+
+Below example configures subscriber `208014567891209` in the SD-Core
+
+.. code-block::
+
+ - Post:
+ URL: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-xxx>`
+ Ex: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-208014567891209>`
+
+ Request Body:
+
+ {
+ "UeId":"208014567891209",
+ "plmnId":"20801",
+ "opc":"d4416644f6154936193433dd20a0ace0",
+ "key":"465b5ce8b199b49faa5f0a2ee238a6bc",
+ "sequenceNumber":"96"
+ }
+
+ - Delete:
+ 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
+"""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. code-block::
+
+ - Post:
+ URL: `http://<config-service-name-or-ip>:<port>/device-group/<group-name>`
+ Ex: `http://config5g:8080/device-group/iot-camera`
+
+ Request Body:
+ {
+ "imsis":
+ [
+ "123456789123456"
+ "123456789123457"
+ "123456789123458"
+ ],
+ "site-info": "menlo",
+ "ip-domain-name": "pool1",
+ "ip-domain-expanded":
+ {
+ "dnn": "internet",
+ "ue-ip-pool": "10.91.0.0/16",
+ "dns-primary": "8.8.8.8",
+ "dns-secondary": "8.8.4.4",
+ "mtu": 1460,
+ "ue-dnn-qos":
+ {
+ "dnn-mbr-uplink": 4000000,
+ "dnn-mbr-downlink": 20000000,
+ "bitrate-unit": "Mbps",
+ "traffic-class": "platinum"
+ }
+ }
+ }
+
+ - Delete
+ 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
+""""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. 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": "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
+ }
+ },
+ }
+
+ - Delete
+ URL: `http://<config-service-name-or-ip>:<port>/network-slice/<slice-name>`
+ Ex: `http://config5g:8080/network-slice/slice1`
+
+
diff --git a/configuration/config_simapp.rst b/configuration/config_simapp.rst
new file mode 100644
index 0000000..28bef33
--- /dev/null
+++ b/configuration/config_simapp.rst
@@ -0,0 +1,67 @@
+Configuration using Simapp POD
+==============================
+
+Easiest way to configure SD-Core is to use simapp. Simapp is the POD which takes
+yaml configuration and configures the subscribers, device groups, network slices
+
+.. code-block::
+
+ config:
+ simapp:
+ cfgFiles:
+ simapp.yaml:
+ configuration:
+ provision-network-slice: true
+ sub-provision-endpt:
+ addr: config4g
+ port: 5000
+ subscribers:
+ - ueId-start: 208014567891201
+ ueId-end: 208014567891211
+ plmnId: 20801
+ opc: "d4416644f6154936193433dd20a0ace0"
+ op: ""
+ key: "465b5ce8b199b49faa5f0a2ee238a6bc"
+ sequenceNumber: 96
+ device-groups:
+ - name: "4g-oaisim-user"
+ imsis:
+ - "208014567891201"
+ - "208014567891202"
+ ip-domain-name: "pool1"
+ ip-domain-expanded:
+ dnn: internet
+ dns-primary: "8.8.8.8"
+ mtu: 1460
+ ue-ip-pool: "172.250.0.0/16"
+ ue-dnn-qos:
+ dnn-mbr-downlink: 20000000
+ dnn-mbr-uplink: 4000000
+ bitrate-unit: bps
+ traffic-class: #default bearer QCI/ARP
+ name: "platinum"
+ qci: 9
+ arp: 1
+ pdb: 300
+ pelr: 6
+ site-info: "aiab"
+ network-slices:
+ - name: "default"
+ slice-id:
+ sd: "010203"
+ sst: 1
+ site-device-group:
+ - "4g-oaisim-user"
+ site-info:
+ gNodeBs:
+ - name: "aiab-gnb1"
+ tac: 1
+ plmn:
+ mcc: "208"
+ mnc: "01"
+ site-name: "aiab"
+ upf:
+ upf-name: "upf"
+ upf-port: 8805
+
+