blob: 4c8bca5d8663b3575952bb89bc1658043cea9781 [file] [log] [blame]
Ajay Lotan Thakure1dfc222022-10-06 17:58:34 -07001..
2 SPDX-FileCopyrightText: © 2022 Open Networking Foundation <support@opennetworking.org>
3 SPDX-License-Identifier: Apache-2.0
4
5UPF Configuration
6=================
7
8Below you may find some of the upf override configuration.
9
10Bess default values `can be found here <https://gerrit.opencord.org/plugins/gitiles/sdfabric-helm-charts/+/refs/heads/master/bess-upf/values.yaml>`_
11
12UPF Address Pool
13-----------------
14
15Below config is basic minimal config which has UE address pool configuration
16.. code-block::
17
18 config:
19 upf:
20 cfgFiles:
21 upf.json:
22 mode: af_packet #this mode means no dpdk
23 hwcksum: true
24 log_level: "trace"
25 gtppsc: true #extension header is enabled in 5G. Sending QFI in pdu session extension header
26 measure_upf: false #enable packet processing time
27 cpiface:
28 dnn: "internet" #keep it matching with Slice dnn
29 hostname: "upf"
30 #http_port: "8080"
31 enable_ue_ip_alloc: true # if true then it means UPF allocates address from below pool
32 ue_ip_pool: "172.250.0.0/16" # UE ip pool is used if enable_ue_ip_alloc is set to true
33
34
35Slice rate Configuration
36------------------------
37
38.. code-block::
39
40 config:
41 upf:
42 cfgFiles:
43 upf.json:
44 # Default global rate limits. Can be changed at runtime via BESS gRPC.
45 slice_rate_limit_config:
46 # Uplink
47 n6_bps: 1000000000 # 1Gbps
48 n6_burst_bytes: 12500000 # 10ms * 1Gbps
49 # Downlink
50 n3_bps: 1000000000 # 1Gbps
51 n3_burst_bytes: 12500000 # 10ms * 1Gbps
52
53.. note::
54 TBD : add REST api documentation to change slice QoS rates.
55
56UPF Enable dpdk & sriov
57------------------------
58
59.. code-block::
60
61 config:
62 upf:
63 # Enable privileged when run from VM with sriov support
64 privileged: false
65 hugepage:
66 enabled: true
67 sriov:
68 enabled: true
69 cniPlugin: vfioveth
70 access:
71 # Provide sriov resource name when sriov is enabled
72 resourceName: "intel.com/intel_sriov_vfio"
73 core:
74 # Provide sriov resource name when sriov is enabled
75 resourceName: "intel.com/intel_sriov_vfio"
76 cfgFiles:
77 upf.json:
78 mode: dpdk