open5gs/configs/open5gs/upf.yaml.in

258 lines
5.5 KiB
YAML
Raw Normal View History

2020-04-26 19:36:05 +00:00
#
# o Set OGS_LOG_INFO to all domain level
# - If `level` is omitted, the default level is OGS_LOG_INFO)
# - If `domain` is omitted, the all domain level is set from 'level'
# (Default values are used, so no configuration is required)
2020-04-26 19:36:05 +00:00
#
# o Set OGS_LOG_ERROR to all domain level
# - `level` can be set with none, fatal, error, warn, info, debug, trace
# logger:
2020-04-26 19:36:05 +00:00
# level: error
#
# o Set OGS_LOG_DEBUG to mme/emm domain level
# logger:
2020-04-26 19:36:05 +00:00
# level: debug
# domain: mme,emm
#
# o Set OGS_LOG_TRACE to all domain level
# logger:
2020-04-26 19:36:05 +00:00
# level: trace
# domain: core,sbi,ausf,event,tlv,mem,sock
2020-04-26 19:36:05 +00:00
#
logger:
file: @localstatedir@/log/open5gs/upf.log
#
# <PFCP Server>
#
# o PFCP Server(127.0.0.7:8805, ::1:8805)
# upf:
2020-04-26 19:36:05 +00:00
# pfcp:
# - addr: 127.0.0.7
# - addr: ::1
2020-04-26 19:36:05 +00:00
#
2021-03-15 01:01:55 +00:00
# o PFCP-U Server(127.0.0.1:2152, [::1]:2152)
# upf:
2021-03-15 01:01:55 +00:00
# pfcp:
# name: localhost
2020-04-26 19:36:05 +00:00
#
# o PFCP Option (Default)
# - so_bindtodevice : NULL
#
# upf:
# pfcp:
# addr: 127.0.0.7
# option:
# so_bindtodevice: vrf-blue
#
2023-02-23 07:59:59 +00:00
# o Provide custom PFCP address to be advertised to SMF in PFCP association
# request/respond
# upf:
# pfcp:
# - addr: 0.0.0.0
# advertise: open5gs-smf.svc.local
#
2021-03-15 01:01:55 +00:00
# <GTP-U Server>>
#
2020-08-22 03:33:45 +00:00
# o GTP-U Server(127.0.0.7:2152, [::1]:2152)
# upf:
2020-04-26 19:36:05 +00:00
# gtpu:
2021-03-15 01:01:55 +00:00
# - addr: 127.0.0.7
# - addr: ::1
2020-04-26 19:36:05 +00:00
#
# o GTP-U Server(127.0.0.1:2152, [::1]:2152)
# upf:
2020-04-26 19:36:05 +00:00
# gtpu:
# name: localhost
#
2021-03-19 04:48:27 +00:00
# o User Plane IP Resource information
# upf:
2021-03-19 04:48:27 +00:00
# gtpu:
# - addr:
# - 127.0.0.7
# - ::1
# teid_range_indication: 4
# teid_range: 10
# network_instance: internet
# source_interface: 0
# - addr: 127.0.10.4
# teid_range_indication: 4
# teid_range: 5
# network_instance: ims
# source_interface: 1
#
# o Provide custom UPF GTP-U address to be advertised inside NGAP messages
# upf:
2021-03-19 04:48:27 +00:00
# gtpu:
# - addr: 10.4.128.21
# advertise: 172.24.15.30
2021-03-19 04:48:27 +00:00
#
# upf:
2021-03-19 04:48:27 +00:00
# gtpu:
# - addr: 10.4.128.21
# advertise:
2021-03-19 04:48:27 +00:00
# - 127.0.0.1
# - ::1
#
# upf:
2021-03-19 04:48:27 +00:00
# gtpu:
# - addr: 10.4.128.21
# advertise: upf1.5gc.mnc001.mcc001.3gppnetwork.org
2021-03-19 04:48:27 +00:00
#
# upf:
2021-03-19 04:48:27 +00:00
# gtpu:
# - dev: ens3
# advertise: upf1.5gc.mnc001.mcc001.3gppnetwork.org
2021-03-19 04:48:27 +00:00
#
# o GTP-U Option (Default)
# - so_bindtodevice : NULL
#
# upf:
# gtpu:
# addr: 127.0.0.7
# option:
# so_bindtodevice: vrf-blue
#
# <Subnet for UE network>
#
# Note that you need to setup your UE network using TUN device.
# (ogstun, ogstun2, ogstunX, ..)
2020-08-27 01:03:15 +00:00
#
# o IPv4 Pool
# $ sudo ip addr add 10.45.0.1/16 dev ogstun
#
# upf:
# subnet:
2020-08-27 01:03:15 +00:00
# addr: 10.45.0.1/16
#
# o IPv4/IPv6 Pool
# $ sudo ip addr add 10.45.0.1/16 dev ogstun
# $ sudo ip addr add 2001:db8:cafe::1/48 dev ogstun
2020-08-27 01:03:15 +00:00
#
# upf:
# subnet:
2020-08-27 01:03:15 +00:00
# - addr: 10.45.0.1/16
# - addr: 2001:db8:cafe::1/48
2020-08-27 01:03:15 +00:00
#
#
2022-01-14 02:53:15 +00:00
# o Specific DNN/APN(e.g 'ims') uses 10.46.0.1/16, 2001:db8:babe::1/48
# All other APNs use 10.45.0.1/16, 2001:db8:cafe::1/48
2020-08-27 01:03:15 +00:00
# $ sudo ip addr add 10.45.0.1/16 dev ogstun
# $ sudo ip addr add 10.46.0.1/16 dev ogstun
# $ sudo ip addr add 2001:db8:cafe::1/48 dev ogstun
2022-01-14 02:53:15 +00:00
# $ sudo ip addr add 2001:db8:babe::1/48 dev ogstun
2020-08-27 01:03:15 +00:00
#
# ; If the UE has unknown DNN/APN(not internet/ims), SMF/UPF will crash.
#
# upf:
# subnet:
2020-08-27 01:03:15 +00:00
# - addr: 10.45.0.1/16
# dnn: internet
# - addr: 2001:db8:cafe::1/48
# dnn: internet
2020-08-27 01:03:15 +00:00
# - addr: 10.46.0.1/16
# dnn: ims
2022-01-14 02:53:15 +00:00
# - addr: 2001:db8:babe::1/48
# dnn: ims
2020-08-27 01:03:15 +00:00
#
# o Specific DNN/APN with the FALLBACK SUBNET(10.47.0.1/16)
# ; Note that put the FALLBACK SUBNET last to avoid SMF/UPF crash.
#
# upf:
# subnet:
# - addr: 10.45.0.1/16
# dnn: internet
# - addr: 10.46.0.1/16
# dnn: ims
# - addr: 10.50.0.1/16 ## FALLBACK SUBNET
#
2020-08-27 01:03:15 +00:00
# o Multiple Devices (default: ogstun)
# $ sudo ip addr add 10.45.0.1/16 dev ogstun
# $ sudo ip addr add 2001:db8:cafe::1/48 dev ogstun2
2020-08-27 01:03:15 +00:00
# $ sudo ip addr add 10.46.0.1/16 dev ogstun3
2022-01-14 02:53:15 +00:00
# $ sudo ip addr add 2001:db8:babe::1/48 dev ogstun3
2020-08-27 01:03:15 +00:00
#
# upf:
# subnet:
2020-08-27 01:03:15 +00:00
# - addr: 10.45.0.1/16
# dnn: internet
# - addr: 2001:db8:cafe::1/48
# dnn: internet
2020-08-27 01:03:15 +00:00
# dev: ogstun2
# - addr: 10.46.0.1/16
# dnn: ims
2020-08-27 01:03:15 +00:00
# dev: ogstun3
2022-01-14 02:53:15 +00:00
# - addr: 2001:db8:babe::1/48
# dnn: ims
2020-08-27 01:03:15 +00:00
# dev: ogstun3
#
[UPF] Add metrics support Expose metrics with labels according to ETSI TS 128 552 V16.13.0 in UPF by using hash. The metrics are named respecting the rule: <generation>_<measurement_object_class>_<measurement_family_name>_<metric_name_as_in_TS_128_552> 5qi is not available in UPF. To present 5qi to the user, MN will have to maintain a table qfi->5qi for each QoS flow (will have to get information from SMF). So UPF has to expose qfi. qfi itself is not useful. When used, UPF will have to expose additional label to define the session (e.g. source interface). Label dnn is set to value of APN/DNN received in Establishment. Since SMF does not add APN/DNN to Establishment, the label is empty. When APN/DNN will be set by SMF, it should be added to sess in UPF and used in metrics on Modification and Deletion. Both datavolumeqosleveln3upf are exposed in bytes. MN is providing the transformation to kbits. fivegs_upffunction_upf_qosflows should expose the number of QFIs used in sessions, but exposes number of QER rules, which is currently equal to QFIs. The label snsssai is not provided since the slice is not available on UPF. Exposed metrics example: Standard counters: fivegs_ep_n3_gtp_indatapktn3upf 28637 fivegs_ep_n3_gtp_outdatapktn3upf 14729 fivegs_upffunction_sm_n4sessionestabreq 4 fivegs_upffunction_sm_n4sessionestabfail{cause="66"} 1 fivegs_upffunction_sm_n4sessionestabfail{cause="71"} 68 fivegs_upffunction_sm_n4sessionestabfail{cause="68"} 4 fivegs_upffunction_sm_n4sessionestabfail{cause="72"} 15 fivegs_upffunction_sm_n4sessionestabfail{cause="75"} 3 fivegs_upffunction_sm_n4sessionestabfail{cause="65"} 4 fivegs_upffunction_sm_n4sessionreport 0 fivegs_upffunction_sm_n4sessionreportsucc 0 fivegs_ep_n3_gtp_indatavolumeqosleveln3upf{qfi="1"} 39792997 fivegs_ep_n3_gtp_outdatavolumeqosleveln3upf{qfi="1"} 737548 Nonstandard gauge (added for controlling purposes - same metric as existing metric on AMF and SMF): fivegs_upffunction_upf_sessionnbr 1 Standard gauge: fivegs_upffunction_upf_qosflows{dnn=""} 1
2022-08-19 12:08:27 +00:00
# <Metrics Server>
#
# o Metrics Server(http://<any address>:9090)
# upf:
[UPF] Add metrics support Expose metrics with labels according to ETSI TS 128 552 V16.13.0 in UPF by using hash. The metrics are named respecting the rule: <generation>_<measurement_object_class>_<measurement_family_name>_<metric_name_as_in_TS_128_552> 5qi is not available in UPF. To present 5qi to the user, MN will have to maintain a table qfi->5qi for each QoS flow (will have to get information from SMF). So UPF has to expose qfi. qfi itself is not useful. When used, UPF will have to expose additional label to define the session (e.g. source interface). Label dnn is set to value of APN/DNN received in Establishment. Since SMF does not add APN/DNN to Establishment, the label is empty. When APN/DNN will be set by SMF, it should be added to sess in UPF and used in metrics on Modification and Deletion. Both datavolumeqosleveln3upf are exposed in bytes. MN is providing the transformation to kbits. fivegs_upffunction_upf_qosflows should expose the number of QFIs used in sessions, but exposes number of QER rules, which is currently equal to QFIs. The label snsssai is not provided since the slice is not available on UPF. Exposed metrics example: Standard counters: fivegs_ep_n3_gtp_indatapktn3upf 28637 fivegs_ep_n3_gtp_outdatapktn3upf 14729 fivegs_upffunction_sm_n4sessionestabreq 4 fivegs_upffunction_sm_n4sessionestabfail{cause="66"} 1 fivegs_upffunction_sm_n4sessionestabfail{cause="71"} 68 fivegs_upffunction_sm_n4sessionestabfail{cause="68"} 4 fivegs_upffunction_sm_n4sessionestabfail{cause="72"} 15 fivegs_upffunction_sm_n4sessionestabfail{cause="75"} 3 fivegs_upffunction_sm_n4sessionestabfail{cause="65"} 4 fivegs_upffunction_sm_n4sessionreport 0 fivegs_upffunction_sm_n4sessionreportsucc 0 fivegs_ep_n3_gtp_indatavolumeqosleveln3upf{qfi="1"} 39792997 fivegs_ep_n3_gtp_outdatavolumeqosleveln3upf{qfi="1"} 737548 Nonstandard gauge (added for controlling purposes - same metric as existing metric on AMF and SMF): fivegs_upffunction_upf_sessionnbr 1 Standard gauge: fivegs_upffunction_upf_qosflows{dnn=""} 1
2022-08-19 12:08:27 +00:00
# metrics:
# - addr: 0.0.0.0
# port: 9090
#
2020-04-26 19:36:05 +00:00
upf:
pfcp:
2020-08-22 03:33:45 +00:00
- addr: 127.0.0.7
2020-04-26 19:36:05 +00:00
gtpu:
2020-09-12 16:16:08 +00:00
- addr: 127.0.0.7
subnet:
2020-08-22 03:33:45 +00:00
- addr: 10.45.0.1/16
- addr: 2001:db8:cafe::1/48
[UPF] Add metrics support Expose metrics with labels according to ETSI TS 128 552 V16.13.0 in UPF by using hash. The metrics are named respecting the rule: <generation>_<measurement_object_class>_<measurement_family_name>_<metric_name_as_in_TS_128_552> 5qi is not available in UPF. To present 5qi to the user, MN will have to maintain a table qfi->5qi for each QoS flow (will have to get information from SMF). So UPF has to expose qfi. qfi itself is not useful. When used, UPF will have to expose additional label to define the session (e.g. source interface). Label dnn is set to value of APN/DNN received in Establishment. Since SMF does not add APN/DNN to Establishment, the label is empty. When APN/DNN will be set by SMF, it should be added to sess in UPF and used in metrics on Modification and Deletion. Both datavolumeqosleveln3upf are exposed in bytes. MN is providing the transformation to kbits. fivegs_upffunction_upf_qosflows should expose the number of QFIs used in sessions, but exposes number of QER rules, which is currently equal to QFIs. The label snsssai is not provided since the slice is not available on UPF. Exposed metrics example: Standard counters: fivegs_ep_n3_gtp_indatapktn3upf 28637 fivegs_ep_n3_gtp_outdatapktn3upf 14729 fivegs_upffunction_sm_n4sessionestabreq 4 fivegs_upffunction_sm_n4sessionestabfail{cause="66"} 1 fivegs_upffunction_sm_n4sessionestabfail{cause="71"} 68 fivegs_upffunction_sm_n4sessionestabfail{cause="68"} 4 fivegs_upffunction_sm_n4sessionestabfail{cause="72"} 15 fivegs_upffunction_sm_n4sessionestabfail{cause="75"} 3 fivegs_upffunction_sm_n4sessionestabfail{cause="65"} 4 fivegs_upffunction_sm_n4sessionreport 0 fivegs_upffunction_sm_n4sessionreportsucc 0 fivegs_ep_n3_gtp_indatavolumeqosleveln3upf{qfi="1"} 39792997 fivegs_ep_n3_gtp_outdatavolumeqosleveln3upf{qfi="1"} 737548 Nonstandard gauge (added for controlling purposes - same metric as existing metric on AMF and SMF): fivegs_upffunction_upf_sessionnbr 1 Standard gauge: fivegs_upffunction_upf_qosflows{dnn=""} 1
2022-08-19 12:08:27 +00:00
metrics:
- addr: 127.0.0.7
port: 9090
2020-04-26 19:36:05 +00:00
#
# <PFCP Client>>
#
2021-04-21 13:42:39 +00:00
# o PFCP Client(127.0.0.4:8805)
# smf:
2020-04-26 19:36:05 +00:00
# pfcp:
2021-04-21 13:42:39 +00:00
# addr: 127.0.0.4
2020-04-26 19:36:05 +00:00
#
smf:
#
# o Number of output streams per SCTP associations.
# parameter:
# sctp_streams: 30
2020-04-26 19:36:05 +00:00
#
# o Disable use of IPv4 addresses (only IPv6)
# parameter:
# no_ipv4: true
2020-04-26 19:36:05 +00:00
#
# o Disable use of IPv6 addresses (only IPv4)
# parameter:
# no_ipv6: true
2020-04-26 19:36:05 +00:00
#
# o Prefer IPv4 instead of IPv6 for estabishing new GTP connections.
# parameter:
# prefer_ipv4: true
2020-04-26 19:36:05 +00:00
#
parameter:
#
# o Maximum Number of UE
2020-04-26 19:36:05 +00:00
# max:
# ue: 1024
2020-04-26 19:36:05 +00:00
#
# o Maximum Number of Peer(S1AP/NGAP, DIAMETER, GTP, PFCP or SBI)
# max:
# peer: 64
2020-04-26 19:36:05 +00:00
#
max:
2020-11-07 22:27:12 +00:00
#
# o Message Wait Duration (Default : 10,000 ms = 10 seconds)
# (Default values are used, so no configuration is required)
2020-11-07 22:27:12 +00:00
#
# o Message Wait Duration (3000 ms)
# time:
2020-11-07 22:27:12 +00:00
# message:
# duration: 3000
time: