lynxis lazus has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-epdg/+/36822?usp=email )

Change subject: docs: add chapter operating ......................................................................

docs: add chapter operating

Change-Id: If4546fd98c470bcb29523bebae0ffa6bcf7f6cde --- D docs/manuals/chapters/epcrequirements.adoc A docs/manuals/chapters/operating.adoc M docs/manuals/osmoepdg-usermanual.adoc 3 files changed, 57 insertions(+), 18 deletions(-)

git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-epdg refs/changes/22/36822/1

diff --git a/docs/manuals/chapters/epcrequirements.adoc b/docs/manuals/chapters/epcrequirements.adoc deleted file mode 100644 index 8905c84..0000000 --- a/docs/manuals/chapters/epcrequirements.adoc +++ /dev/null @@ -1,18 +0,0 @@ -[[epcrequirements]] -== EPC requirements - -The osmo-epdg was tested and developed against open5gs (version 2.7.0.83.290df). - -=== HSS - -When a UE connects it requests an APN via SWu. By default the UE will request -the APN "ims". The subscriber entry must allow connections to the requested APN to succeed. - -=== PGW - -The osmo-epdg/erlang expects the PGW to support S2b and S6b. -An UE will request attributes via IKEv2 which are translated into Additional PCO (APCO) in GTP on the S2b -reference point. THe PGW should support Additional PCO via S2b. -open5gs supports Additional PCO by 2.7.1. - -osmo-epdg only supports S2b over GTP. diff --git a/docs/manuals/chapters/operating.adoc b/docs/manuals/chapters/operating.adoc new file mode 100644 index 0000000..ccb20db --- /dev/null +++ b/docs/manuals/chapters/operating.adoc @@ -0,0 +1,46 @@ +[[operating]] +== Operating osmo-epdg + +The osmo-epdg requires to run on Linux. +osmo-epdg has been tested and developed with Debian 12. + +=== Linux requirements + +The osmo-epdg is using the following Linux subsystems: + +* nftables (soft) +* IP policy routing (soft) +* ESP user-plane (soft) +* GTP user-plane (hard) + +Soft dependencies can be changed by configuration. +Hard dependencies are required and can't changed without code changes. + +The user-plane is configured in the default configuration to use nftables and +policy routing to ensure the traffic from UEs will only flow between the GTP network +interface and ESP encrypted tunnels. + +strongSwan will use the kernel ESP subsystem to encrypt, decrypt and route traffic. +strongSwan can be configured to replace the kernel ESP subsystem with a user space +imeplementation, which comes with a performance impact. + +osmo-epdg/erlang is using the GTP subsystem to de- and encapsulate. It only supports using +the kernel subsystem. + +=== EPC requirements + +The osmo-epdg was tested and developed against open5gs and requires version 2.7.1 or newer. + +==== HSS + +When a UE connects it requests an APN via SWu. By default the UE will request +the APN "ims". The subscriber entry must allow connections to the requested APN to succeed. + +==== PGW + +The osmo-epdg/erlang expects the PGW to support S2b and S6b. +An UE will request attributes via IKEv2 which are translated into Additional PCO (APCO) in GTP on the S2b +reference point. The PGW should support Additional PCO via S2b. +open5gs supports Additional PCO since 2.7.1. + +osmo-epdg only supports S2b over GTP. diff --git a/docs/manuals/osmoepdg-usermanual.adoc b/docs/manuals/osmoepdg-usermanual.adoc index 05eb6b0..16473bc 100644 --- a/docs/manuals/osmoepdg-usermanual.adoc +++ b/docs/manuals/osmoepdg-usermanual.adoc @@ -12,3 +12,5 @@

include::{srcdir}/chapters/strongswan.adoc[] include::{srcdir}/chapters/osmo-epdg.adoc[] + +include::{srcdir}/chapters/operating.adoc[]