Change in osmo-hnbgw[master]: manual: explain the PFCP port

laforge has submitted this change. ( https://gerrit.osmocom.org/c/osmo-hnbgw/+/29075 ) Change subject: manual: explain the PFCP port ...................................................................... manual: explain the PFCP port Change-Id: I383befb226caa49e4a2577657806aef1ee11faa3 --- M doc/manuals/chapters/running.adoc 1 file changed, 34 insertions(+), 0 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, approved dexter: Looks good to me, but someone else must approve diff --git a/doc/manuals/chapters/running.adoc b/doc/manuals/chapters/running.adoc index 0bcca70..e575215 100644 --- a/doc/manuals/chapters/running.adoc +++ b/doc/manuals/chapters/running.adoc @@ -70,6 +70,7 @@ - The SCCP/M3UA links are established by OsmoHNBGW contacting an STP. - The MGCP link is established by OsmoHNBGW contacting an MGW. +- The PFCP link is established by OsmoHNBGW contacting a UPF. To run multiple OsmoHNBGW instances on the same SCCP routing, each HNBGW has to configure a distinct point-code, see <<configure_iucs_iups>>. @@ -140,3 +141,36 @@ mgw remote-port 2427 mgw reset-endpoint rtpbridge/* ---- + +==== Configure co-located User Plane Function + +OsmoHNBGW optionally supports relaying the GTP user plane via a co-located UPF, +which is controlled by the PFCP protocol. + +PFCP support is optional at compile time, as well as run time. To use a co-located UPF, + +* osmo-hnbgw needs to be compiled with 'configure --enable-pfcp', +* and osmo-hnbgw.cfg needs to configure a 'pfcp' / 'remote-addr' and + 'local-addr'. + +The following example configures OsmoHNBGW to associate via PFCP with a UPF +listening on UDP 127.0.0.2:8805, ready to setup GTP tunnel relays. + +---- +hnbgw + pfcp + remote-addr 127.0.0.2 + local-addr 127.0.0.1 +---- + +3GPP TS 29.244 4.2.2 specifies that PFCP Request messages shall be sent to UDP +port 8805, i.e. the PFCP port is fixed as 8805 and currently not configurable in +osmo-hnbgw. + +Setting a 'local-addr' is required: the PFCP protocol features a Node ID, which +uniquely identifies PFCP peers across different interfaces. According to the +PFCP specification, the Node ID can be a fully-qualified domain name (FQDN) or +an IP address. Currently, osmo-hnbgw has no support for using an FQDN as Node +ID, and so far uses the 'local-addr' as local Node ID -- hence the 'local-addr' +must not be "0.0.0.0", which is an unfortunate consequence. This is likely to +improve in the future, see https://osmocom.org/issues/5647 . -- To view, visit https://gerrit.osmocom.org/c/osmo-hnbgw/+/29075 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-hnbgw Gerrit-Branch: master Gerrit-Change-Id: I383befb226caa49e4a2577657806aef1ee11faa3 Gerrit-Change-Number: 29075 Gerrit-PatchSet: 6 Gerrit-Owner: neels &lt;nhofmeyr(a)sysmocom.de&gt; Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter &lt;pmaier(a)sysmocom.de&gt; Gerrit-Reviewer: fixeria &lt;vyanitskiy(a)sysmocom.de&gt; Gerrit-Reviewer: laforge &lt;laforge(a)osmocom.org&gt; Gerrit-MessageType: merged