open5gs/configs/open5gs/pcf.yaml.in

428 lines
8.8 KiB
YAML
Raw Normal View History

2020-12-11 19:03:20 +00:00
db_uri: mongodb://localhost/open5gs
#
# 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-12-11 19:03:20 +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-12-11 19:03:20 +00:00
# level: error
#
# o Set OGS_LOG_DEBUG to mme/emm domain level
# logger:
2020-12-11 19:03:20 +00:00
# level: debug
# domain: mme,emm
#
# o Set OGS_LOG_TRACE to all domain level
# logger:
2020-12-11 19:03:20 +00:00
# level: trace
# domain: core,sbi,ausf,event,tlv,mem,sock
2020-12-11 19:03:20 +00:00
#
logger:
file: @localstatedir@/log/open5gs/pcf.log
2022-11-12 00:37:43 +00:00
#
# o TLS enable/disable
# sbi:
# server|client:
# no_tls: false|true
# - false: (Default) Use TLS
# - true: TLS disabled
#
# o Verification enable/disable
# sbi:
# server|client:
# no_verify: false|true
# - false: (Default) Verify the PEER
# - true: Skip the verification step
#
# o Server-side does not use TLS
# sbi:
2022-11-12 00:37:43 +00:00
# server:
# no_tls: true
2022-11-12 00:37:43 +00:00
#
# o Client-side skips the verification step
# sbi:
2022-11-12 00:37:43 +00:00
# client:
# no_verify: true
# key: /etc/open5gs/tls/amf.key
# cert: /etc/open5gs/tls/amf.crt
2022-11-12 00:37:43 +00:00
#
# o Use the specified certificate while verifying the client
# sbi:
2022-11-12 00:37:43 +00:00
# server
# cacert: /etc/open5gs/tls/ca.crt
#
# o Use the specified certificate while verifying the server
# sbi:
2022-11-12 00:37:43 +00:00
# client
# cacert: /etc/open5gs/tls/ca.crt
#
sbi:
2022-11-12 00:37:43 +00:00
server:
no_tls: true
2022-11-12 00:37:43 +00:00
cacert: @sysconfdir@/open5gs/tls/ca.crt
key: @sysconfdir@/open5gs/tls/pcf.key
cert: @sysconfdir@/open5gs/tls/pcf.crt
client:
no_tls: true
2022-11-12 00:37:43 +00:00
cacert: @sysconfdir@/open5gs/tls/ca.crt
key: @sysconfdir@/open5gs/tls/pcf.key
cert: @sysconfdir@/open5gs/tls/pcf.crt
2020-12-11 19:03:20 +00:00
#
# <SBI Server>
#
# o SBI Server(http://<all address available>:80)
# sbi:
# server:
# no_tls: true
# pcf:
2020-12-11 19:03:20 +00:00
# sbi:
#
2022-11-12 00:37:43 +00:00
# o SBI Server(http://<any address>:7777)
# sbi:
# server:
# no_tls: true
# pcf:
2020-12-11 19:03:20 +00:00
# sbi:
# - addr:
# - 0.0.0.0
# - ::0
# port: 7777
#
# o SBI Server(https://<all address available>:443)
# sbi:
2022-11-12 00:37:43 +00:00
# server:
# key: /etc/open5gs/tls/pcf.key
# cert: /etc/open5gs/tls/pcf.crt
# pcf:
2020-12-11 19:03:20 +00:00
# sbi:
#
# o SBI Server(https://127.0.0.13:443, https://[::1]:443) without verification
# sbi:
2022-11-12 00:37:43 +00:00
# server:
# no_verify: true
2022-11-12 00:37:43 +00:00
# key: /etc/open5gs/tls/pcf.key
# cert: /etc/open5gs/tls/pcf.crt
# pcf:
2020-12-11 19:03:20 +00:00
# sbi:
# - addr: 127.0.0.13
2020-12-11 19:03:20 +00:00
# - addr: ::1
#
2022-11-12 00:37:43 +00:00
# o SBI Server(https://pcf.open5gs.org:443)
# Use the specified certificate while verifying the client
2022-11-12 00:37:43 +00:00
#
# sbi:
2022-11-12 00:37:43 +00:00
# server:
# cacert: /etc/open5gs/tls/ca.crt
# key: /etc/open5gs/tls/pcf.key
# cert: /etc/open5gs/tls/pcf.crt
2022-11-12 00:37:43 +00:00
# pcf:
2020-12-11 19:03:20 +00:00
# sbi:
# - name: pcf.open5gs.org
2020-12-11 19:03:20 +00:00
#
# o SBI Server(http://127.0.0.13:7777)
# sbi:
# server:
# no_tls: true
# pcf:
2020-12-11 19:03:20 +00:00
# sbi:
# - addr: 127.0.0.13
# port: 7777
#
# o SBI Server(http://<eth0 IP address>:80)
# sbi:
# server:
# no_tls: true
# pcf:
2020-12-11 19:03:20 +00:00
# sbi:
# - dev: eth0
#
# o Provide custom SBI address to be advertised to NRF
# sbi:
# server:
# no_tls: true
# pcf:
# sbi:
# - dev: eth0
# advertise: open5gs-pcf.svc.local
#
# o Another example of advertising on NRF
# sbi:
# server:
# no_tls: true
# pcf:
# sbi:
# - addr: localhost
# advertise:
# - 127.0.0.99
# - ::1
2020-12-11 19:03:20 +00:00
#
# o SBI Option (Default)
# - tcp_nodelay : true
# - so_linger.l_onoff : false
#
# sbi:
# server:
# no_tls: true
# pcf:
# sbi:
# addr: 127.0.0.13
# option:
# tcp_nodelay: false
# so_linger:
# l_onoff: true
# l_linger: 10
#
# <NF Service>
#
# o NF Service Name(Default : all NF services available)
# pcf:
# service_name:
#
# o NF Service Name(Only some NF services are available)
# pcf:
# service_name:
# - npcf-am-policy-control
# - npcf-smpolicycontrol
# - npcf-policyauthorization
#
# == NOTE ==
# Placing npcf-smpolicycontrol and pcf-policyauthorization
# in different NFs is not supported. Both npcf-smpolicycontrol
# and pcf-policyauthorization should be placed in the same NF.
#
# <NF Discovery Query Parameter>
#
# o (Default) If you do not set Query Parameter as shown below,
#
# sbi:
# - addr: 127.0.0.13
# port: 7777
#
# - 'service-names' is included.
#
# sbi:
# - addr: 127.0.0.13
# port: 7777
# discovery:
# option:
# no_service_names: false
#
# o To remove 'service-names' from URI query parameters in NS Discovery
# no_service_names: true
#
# * For Indirect Communication with Delegated Discovery,
# 'service-names' is always included in the URI query parameter.
# * That is, 'no_service_names' has no effect.
#
# <For Indirect Communication with Delegated Discovery>
#
# o (Default) If you do not set Delegated Discovery as shown below,
#
# sbi:
# server:
# no_tls: true
# pcf:
# sbi:
# - addr: 127.0.0.13
# port: 7777
#
# - Use SCP if SCP avaiable. Otherwise NRF is used.
# => App fails if both NRF and SCP are unavailable.
#
# sbi:
# server:
# no_tls: true
# pcf:
# sbi:
# - addr: 127.0.0.13
# port: 7777
# discovery:
# delegated: auto
#
# o To use SCP always => App fails if no SCP available.
# delegated: yes
#
# o Don't use SCP server => App fails if no NRF available.
# delegated: no
#
#
[PCF] Add metrics support Expose metrics with labels according to ETSI TS 128 552 V16.13.0 in PCF by using hash. The metrics are named respecting the rule: <generation>_<measurement_object_class>_<measurement_family_name>_<metric_name_as_in_TS_128_552> Since slice itself is not unique, the plmnid label is exposed in addition to snssai. AM policy: fivegs_pcffunction_pa_policyamassoreq and fivegs_pcffunction_pa_policyamassosucc do not expose snssai label since it is not available at the time of exposure. plmnid is defined during AM policy processing, so not to lose the difference to ...succ, the basic metric fivegs_pcffunction_pa_policyamassoreq is preserved. SM policy: snssai is defined during SM policy processing, so not to lose the difference to ...succ, the basic metric fivegs_pcffunction_pa_policysmassoreq is preserved. Those 2 basic metrics retain their position but are exposed with empty labels. Metrics with labels are called later, when the label values are known. Exposed metrics example: -standard counters: fivegs_pcffunction_pa_policyamassoreq{plmnid=""} 3 fivegs_pcffunction_pa_policyamassoreq{plmnid="99970"} 3 fivegs_pcffunction_pa_policyamassosucc{plmnid="99970"} 3 fivegs_pcffunction_pa_policysmassoreq{plmnid="",snssai=""} 3 fivegs_pcffunction_pa_policysmassoreq{plmnid="99970",snssai="1000009"} 3 fivegs_pcffunction_pa_policysmassosucc{plmnid="99970",snssai="1000009"} 3 -nonstandard gauge (added for controlling purposes - same metric as existing metric on AMF and SMF): fivegs_pcffunction_pa_sessionnbr{plmnid="99970",snssai="1000009"} 0
2022-08-18 10:20:26 +00:00
# <Metrics Server>
#
# o Metrics Server(http://<any address>:9090)
# pcf:
[PCF] Add metrics support Expose metrics with labels according to ETSI TS 128 552 V16.13.0 in PCF by using hash. The metrics are named respecting the rule: <generation>_<measurement_object_class>_<measurement_family_name>_<metric_name_as_in_TS_128_552> Since slice itself is not unique, the plmnid label is exposed in addition to snssai. AM policy: fivegs_pcffunction_pa_policyamassoreq and fivegs_pcffunction_pa_policyamassosucc do not expose snssai label since it is not available at the time of exposure. plmnid is defined during AM policy processing, so not to lose the difference to ...succ, the basic metric fivegs_pcffunction_pa_policyamassoreq is preserved. SM policy: snssai is defined during SM policy processing, so not to lose the difference to ...succ, the basic metric fivegs_pcffunction_pa_policysmassoreq is preserved. Those 2 basic metrics retain their position but are exposed with empty labels. Metrics with labels are called later, when the label values are known. Exposed metrics example: -standard counters: fivegs_pcffunction_pa_policyamassoreq{plmnid=""} 3 fivegs_pcffunction_pa_policyamassoreq{plmnid="99970"} 3 fivegs_pcffunction_pa_policyamassosucc{plmnid="99970"} 3 fivegs_pcffunction_pa_policysmassoreq{plmnid="",snssai=""} 3 fivegs_pcffunction_pa_policysmassoreq{plmnid="99970",snssai="1000009"} 3 fivegs_pcffunction_pa_policysmassosucc{plmnid="99970",snssai="1000009"} 3 -nonstandard gauge (added for controlling purposes - same metric as existing metric on AMF and SMF): fivegs_pcffunction_pa_sessionnbr{plmnid="99970",snssai="1000009"} 0
2022-08-18 10:20:26 +00:00
# metrics:
# - addr: 0.0.0.0
# port: 9090
#
2020-12-11 19:03:20 +00:00
pcf:
sbi:
- addr: 127.0.0.13
port: 7777
[PCF] Add metrics support Expose metrics with labels according to ETSI TS 128 552 V16.13.0 in PCF by using hash. The metrics are named respecting the rule: <generation>_<measurement_object_class>_<measurement_family_name>_<metric_name_as_in_TS_128_552> Since slice itself is not unique, the plmnid label is exposed in addition to snssai. AM policy: fivegs_pcffunction_pa_policyamassoreq and fivegs_pcffunction_pa_policyamassosucc do not expose snssai label since it is not available at the time of exposure. plmnid is defined during AM policy processing, so not to lose the difference to ...succ, the basic metric fivegs_pcffunction_pa_policyamassoreq is preserved. SM policy: snssai is defined during SM policy processing, so not to lose the difference to ...succ, the basic metric fivegs_pcffunction_pa_policysmassoreq is preserved. Those 2 basic metrics retain their position but are exposed with empty labels. Metrics with labels are called later, when the label values are known. Exposed metrics example: -standard counters: fivegs_pcffunction_pa_policyamassoreq{plmnid=""} 3 fivegs_pcffunction_pa_policyamassoreq{plmnid="99970"} 3 fivegs_pcffunction_pa_policyamassosucc{plmnid="99970"} 3 fivegs_pcffunction_pa_policysmassoreq{plmnid="",snssai=""} 3 fivegs_pcffunction_pa_policysmassoreq{plmnid="99970",snssai="1000009"} 3 fivegs_pcffunction_pa_policysmassosucc{plmnid="99970",snssai="1000009"} 3 -nonstandard gauge (added for controlling purposes - same metric as existing metric on AMF and SMF): fivegs_pcffunction_pa_sessionnbr{plmnid="99970",snssai="1000009"} 0
2022-08-18 10:20:26 +00:00
metrics:
- addr: 127.0.0.13
port: 9090
2020-12-11 19:03:20 +00:00
#
# scp:
#
# <SBI Client>>
#
# o SBI Client(http://127.0.1.10:7777)
# sbi:
# addr: 127.0.1.10
# port: 7777
#
# o SBI Client(https://127.0.1.10:443, http://scp.open5gs.org:80)
# sbi:
# - addr: 127.0.1.10
# tls:
2022-11-12 00:37:43 +00:00
# key: /etc/open5gs/tls/pcf.key
# cert: /etc/open5gs/tls/pcf.crt
# - name: scp.open5gs.org
#
2022-11-12 00:37:43 +00:00
# o SBI Client(https://scp.open5gs.org:443)
# Use the specified certificate to verify peer
#
# sbi:
# - name: scp.open5gs.org
# tls:
# cacert: /etc/open5gs/tls/ca.crt
#
# o SBI Client(http://[fd69:f21d:873c:fb::1]:80)
# If prefer_ipv4 is true, http://127.0.1.10:80 is selected.
#
# sbi:
# addr:
# - 127.0.1.10
# - fd69:f21d:873c:fb::1
#
# o SBI Option (Default)
# - tcp_nodelay : true
# - so_linger.l_onoff : false
#
# sbi:
# addr: 127.0.1.10
# option:
# tcp_nodelay: false
# so_linger:
# l_onoff: true
# l_linger: 10
#
#
scp:
sbi:
- addr: 127.0.1.10
port: 7777
2020-12-11 19:03:20 +00:00
#
# nrf:
#
# <SBI Client>>
#
# o SBI Client(http://127.0.0.10:7777)
# sbi:
# addr: 127.0.0.10
# port: 7777
#
2022-11-12 00:37:43 +00:00
# o SBI Client(https://127.0.0.10:443, https://[::1]:443)
# tls:
# client:
# key: /etc/open5gs/tls/pcf.key
# cert: /etc/open5gs/tls/pcf.crt
# nrf:
2020-12-11 19:03:20 +00:00
# sbi:
# - addr: 127.0.0.10
2022-11-12 00:37:43 +00:00
# - addr: ::1
#
# o SBI Client(https://nrf.open5gs.org:443)
# Use the specified certificate to verify server
#
# tls:
# client:
# cacert: /etc/open5gs/tls/ca.crt
# nrf:
# sbi:
2020-12-11 19:03:20 +00:00
# - name: nrf.open5gs.org
#
2021-11-28 07:42:47 +00:00
# o SBI Client(http://[fd69:f21d:873c:fa::1]:80)
2020-12-11 19:03:20 +00:00
# If prefer_ipv4 is true, http://127.0.0.10:80 is selected.
#
# sbi:
# addr:
# - 127.0.0.10
2021-11-28 07:42:47 +00:00
# - fd69:f21d:873c:fa::1
2020-12-11 19:03:20 +00:00
#
# o SBI Option (Default)
# - tcp_nodelay : true
# - so_linger.l_onoff : false
#
# sbi:
# addr: 127.0.0.10
# option:
# tcp_nodelay: false
# so_linger:
# l_onoff: true
# l_linger: 10
#
#nrf:
# sbi:
# - addr:
# - 127.0.0.10
# - ::1
# port: 7777
2020-12-11 19:03:20 +00:00
#
# o Disable use of IPv4 addresses (only IPv6)
# parameter:
# no_ipv4: true
2020-12-11 19:03:20 +00:00
#
# o Disable use of IPv6 addresses (only IPv4)
# parameter:
# no_ipv6: true
2020-12-11 19:03:20 +00:00
#
# o Prefer IPv4 instead of IPv6 for estabishing new GTP connections.
# parameter:
# prefer_ipv4: true
2020-12-11 19:03:20 +00:00
#
parameter:
#
# o Maximum Number of UE
# max:
2020-12-11 19:03:20 +00:00
# ue: 1024
#
# o Maximum Number of Peer(S1AP/NGAP, DIAMETER, GTP, PFCP or SBI)
# max:
# peer: 64
2020-12-11 19:03:20 +00:00
#
max:
#
# o NF Instance Heartbeat (Default : 0)
# NFs will not send heart-beat timer in NFProfile
# NRF will send heart-beat timer in NFProfile
# (Default values are used, so no configuration is required)
2020-12-11 19:03:20 +00:00
#
# o NF Instance Heartbeat (20 seconds)
# NFs will send heart-beat timer (20 seconds) in NFProfile
# NRF can change heart-beat timer in NFProfile
2020-12-11 19:03:20 +00:00
#
# time:
2020-12-11 19:03:20 +00:00
# nf_instance:
# heartbeat: 20
2020-12-11 19:03:20 +00:00
#
# o Message Wait Duration (Default : 10,000 ms = 10 seconds)
# (Default values are used, so no configuration is required)
2020-12-11 19:03:20 +00:00
#
# o Message Wait Duration (3000 ms)
# time:
2020-12-11 19:03:20 +00:00
# message:
# duration: 3000
time: