Gitiles
Code Review Sign In
gerrit.opencord.org / sdcore-docs / 1ca2c96b586bacb9a5873722e738f19e39aeac8c / . / configuration / config_simapp.rst
blob: 452f459cf55e3d17294bd0bdc0379810ee72df50 [file] [log] [blame]
ajayb3f40982021-12-08 14:26:11 -0800[diff] [blame]1..
2 SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
3 SPDX-License-Identifier: Apache-2.0
4
ajayce0380c2021-12-14 21:51:00 -0800[diff] [blame]5Configuration using Simapp interface
6====================================
ajay87945292021-12-08 00:52:00 -0800[diff] [blame]7
8Easiest way to configure SD-Core is to use simapp. Simapp is the POD which takes
9yaml configuration and configures the subscribers, device groups, network slices
10
ajaycbd17062022-03-06 11:12:58 -0800[diff] [blame]11Simapp Initial Configuration Helm Values
12----------------------------------------
13
ajay87945292021-12-08 00:52:00 -0800[diff] [blame]14.. code-block::
15
16 config:
17 simapp:
18 cfgFiles:
19 simapp.yaml:
20 configuration:
21 provision-network-slice: true
22 sub-provision-endpt:
23 addr: config4g
24 port: 5000
25 subscribers:
Ajay Lotan Thakurcafac842022-09-15 23:15:58 -0700[diff] [blame]26 - ueId-start: "208014567891201"
27 ueId-end: "208014567891205"
ajay87945292021-12-08 00:52:00 -0800[diff] [blame]28 plmnId: 20801
29 opc: "d4416644f6154936193433dd20a0ace0"
30 op: ""
31 key: "465b5ce8b199b49faa5f0a2ee238a6bc"
32 sequenceNumber: 96
33 device-groups:
34 - name: "4g-oaisim-user"
35 imsis:
36 - "208014567891201"
37 - "208014567891202"
Ajay Lotan Thakurcafac842022-09-15 23:15:58 -0700[diff] [blame]38 - "208014567891203"
39 - "208014567891204"
40 - "208014567891205"
ajay87945292021-12-08 00:52:00 -0800[diff] [blame]41 ip-domain-name: "pool1"
42 ip-domain-expanded:
43 dnn: internet
44 dns-primary: "8.8.8.8"
45 mtu: 1460
46 ue-ip-pool: "172.250.0.0/16"
47 ue-dnn-qos:
48 dnn-mbr-downlink: 20000000
49 dnn-mbr-uplink: 4000000
50 bitrate-unit: bps
51 traffic-class: #default bearer QCI/ARP
52 name: "platinum"
53 qci: 9
54 arp: 1
55 pdb: 300
56 pelr: 6
57 site-info: "aiab"
58 network-slices:
59 - name: "default"
60 slice-id:
61 sd: "010203"
62 sst: 1
63 site-device-group:
64 - "4g-oaisim-user"
65 site-info:
66 gNodeBs:
67 - name: "aiab-gnb1"
68 tac: 1
69 plmn:
70 mcc: "208"
71 mnc: "01"
72 site-name: "aiab"
73 upf:
74 upf-name: "upf"
75 upf-port: 8805
76
ajay4783e862021-12-15 21:47:25 -0800[diff] [blame]77.. note::
78 Simapp takes initial configuration through helm chart. Above yaml files is initial config.
ajaycbd17062022-03-06 11:12:58 -0800[diff] [blame]79 Operator can add multiple devices, device groups & slices in the initial config.
80
81Configuration Modification through Simapp interface
82---------------------------------------------------
Ajay Lotan Thakurcafac842022-09-15 23:15:58 -0700[diff] [blame]83
84Adding new subscribers
85"""""""""""""""""""""""
86
87If 5G core is already started and subscriber needs to be added in the 5G-Core then do the following,
88
89Run the command - ``kubectl edit configmap simapp -n <namespace>`` and update subscribers section.
90Once config is updated then save the
91file and exit from the file. Subscribers will get added within 60 seconds. In below we are updating
92ueId-end from 208014567891205 to 208014567891210. This will add 5 new subscribers.
93
94.. code-block::
95
96 config:
97 simapp:
98 cfgFiles:
99 simapp.yaml:
100 configuration:
101 provision-network-slice: true
102 sub-provision-endpt:
103 addr: config4g
104 port: 5000
105 subscribers:
106 - ueId-start: "208014567891201"
107 ueId-end: "208014567891210"
108 plmnId: 20801
109 opc: "d4416644f6154936193433dd20a0ace0"
110 op: ""
111 key: "465b5ce8b199b49faa5f0a2ee238a6bc"
112 sequenceNumber: 96
113 device-groups:
114 - name: "4g-oaisim-user"
115 imsis:
116 - "208014567891201"
117 - "208014567891202"
118 - "208014567891203"
119 - "208014567891204"
120 - "208014567891205"
121 - "208014567891206"
122 - "208014567891207"
123 - "208014567891208"
124 - "208014567891209"
125 - "208014567891210"
126 ip-domain-name: "pool1"
127 ip-domain-expanded:
128 dnn: internet
129 dns-primary: "8.8.8.8"
130 mtu: 1460
131 ue-ip-pool: "172.250.0.0/16"
132 ue-dnn-qos:
133 dnn-mbr-downlink: 20000000
134 dnn-mbr-uplink: 4000000
135 bitrate-unit: bps
136 traffic-class: #default bearer QCI/ARP
137 name: "platinum"
138 qci: 9
139 arp: 1
140 pdb: 300
141 pelr: 6
142 site-info: "aiab"
143 network-slices:
144 - name: "default"
145 slice-id:
146 sd: "010203"
147 sst: 1
148 site-device-group:
149 - "4g-oaisim-user"
150 site-info:
151 gNodeBs:
152 - name: "aiab-gnb1"
153 tac: 1
154 plmn:
155 mcc: "208"
156 mnc: "01"
157 site-name: "aiab"
158 upf:
159 upf-name: "upf"
160 upf-port: 8805
161
162.. note::
163 There is no need to restart simapp after configmap change. New config will be automatically
164 reloaded and updated configuration is passed to SD-Core.
165
166Deleting subscribers
167""""""""""""""""""""
168
169If 5G core is already started and subscriber needs to be removed in the 5G-Core then do the following,
170
171Run the command - ``kubectl edit configmap simapp -n <namespace>`` and update subscribers section.
172Once config is updated then save the file and exit from the file. Subscribers will get added within
17360 seconds. In below we are updating ueId-end from 208014567891210 to 208014567891208. This will
174remove 2 subscribers from 5G core.
175
176.. code-block::
177
178 config:
179 simapp:
180 cfgFiles:
181 simapp.yaml:
182 configuration:
183 provision-network-slice: true
184 sub-provision-endpt:
185 addr: config4g
186 port: 5000
187 subscribers:
188 - ueId-start: "208014567891201"
189 ueId-end: "208014567891208"
190 plmnId: 20801
191 opc: "d4416644f6154936193433dd20a0ace0"
192 op: ""
193 key: "465b5ce8b199b49faa5f0a2ee238a6bc"
194 sequenceNumber: 96
195 device-groups:
196 - name: "4g-oaisim-user"
197 imsis:
198 - "208014567891201"
199 - "208014567891202"
200 - "208014567891203"
201 - "208014567891204"
202 - "208014567891205"
203 - "208014567891206"
204 - "208014567891207"
205 - "208014567891208"
206 ip-domain-name: "pool1"
207 ip-domain-expanded:
208 dnn: internet
209 dns-primary: "8.8.8.8"
210 mtu: 1460
211 ue-ip-pool: "172.250.0.0/16"
212 ue-dnn-qos:
213 dnn-mbr-downlink: 20000000
214 dnn-mbr-uplink: 4000000
215 bitrate-unit: bps
216 traffic-class: #default bearer QCI/ARP
217 name: "platinum"
218 qci: 9
219 arp: 1
220 pdb: 300
221 pelr: 6
222 site-info: "aiab"
223 network-slices:
224 - name: "default"
225 slice-id:
226 sd: "010203"
227 sst: 1
228 site-device-group:
229 - "4g-oaisim-user"
230 site-info:
231 gNodeBs:
232 - name: "aiab-gnb1"
233 tac: 1
234 plmn:
235 mcc: "208"
236 mnc: "01"
237 site-name: "aiab"
238 upf:
239 upf-name: "upf"
240 upf-port: 8805
241
242Adding subscribers with multiple subscriber ranges
243"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
244
245If 5G core is already started and subscriber needs to be added in the 5G-Core then do the following,
246
247Run the command - ``kubectl edit configmap simapp -n <namespace>`` and update subscribers section.
248Once config is updated then save the file and exit from the file. Subscribers will get added within 60 seconds.
249In below we are adding new subscriber range 208014567891216 to 208014567891220. This will add 5 new subscribers.
250If you have multiple ranges with different key & opc values then adding multiple subscriber blocks helps.
251
252
253.. code-block::
254
255 config:
256 simapp:
257 cfgFiles:
258 simapp.yaml:
259 configuration:
260 provision-network-slice: true
261 sub-provision-endpt:
262 addr: config4g
263 port: 5000
264 subscribers:
265 - ueId-start: "208014567891201"
266 ueId-end: "208014567891205"
267 plmnId: 20801
268 opc: "d4416644f6154936193433dd20a0ace0"
269 op: ""
270 key: "465b5ce8b199b49faa5f0a2ee238a6bc"
271 sequenceNumber: 96
272 - ueId-start: "208014567891216"
273 ueId-end: "208014567891220"
274 plmnId: 20801
275 opc: "d4416644f6154936193433dd20a0ace0"
276 op: ""
277 key: "465b5ce8b199b49faa5f0a2ee238a6bc"
278 sequenceNumber: 96
279 device-groups:
280 - name: "4g-oaisim-user"
281 imsis:
282 - "208014567891201"
283 - "208014567891202"
284 - "208014567891203"
285 - "208014567891204"
286 - "208014567891205"
287 - "208014567891216"
288 - "208014567891217"
289 - "208014567891218"
290 - "208014567891219"
291 - "208014567891220"
292 ip-domain-name: "pool1"
293 ip-domain-expanded:
294 dnn: internet
295 dns-primary: "8.8.8.8"
296 mtu: 1460
297 ue-ip-pool: "172.250.0.0/16"
298 ue-dnn-qos:
299 dnn-mbr-downlink: 20000000
300 dnn-mbr-uplink: 4000000
301 bitrate-unit: bps
302 traffic-class: #default bearer QCI/ARP
303 name: "platinum"
304 qci: 9
305 arp: 1
306 pdb: 300
307 pelr: 6
308 site-info: "aiab"
309 network-slices:
310 - name: "default"
311 slice-id:
312 sd: "010203"
313 sst: 1
314 site-device-group:
315 - "4g-oaisim-user"
316 site-info:
317 gNodeBs:
318 - name: "aiab-gnb1"
319 tac: 1
320 plmn:
321 mcc: "208"
322 mnc: "01"
323 site-name: "aiab"
324 upf:
325 upf-name: "upf"
326 upf-port: 8805
327
328Updating QoS Values for subscribers
329"""""""""""""""""""""""""""""""""""
330
331Run the command - ``kubectl edit configmap simapp -n <namespace>`` and update QoS values mentioned in ip domain.
332Config snippet is provided below.
333
334.. code-block::
335
336 ue-dnn-qos:
337 dnn-mbr-downlink: 20000000
338 dnn-mbr-uplink: 4000000
339 bitrate-unit: bps
340
341.. note::
342 If subscriber QoS is changed and if subscriber is already connected to the network then new values
343 are not used for already connected subscribers. To use new QoS rates, subscriber needs to be
344 disconnected and reconnected.