neels has uploaded this change for review. (
https://gerrit.osmocom.org/c/osmo-upf/+/30832 )
Change subject: manual: use 'tunend' and 'tunmap'
......................................................................
manual: use 'tunend' and 'tunmap'
Change-Id: I09a2fa28465945c98b58b4093c7d5de65e184645
---
M doc/manuals/chapters/overview.adoc
M doc/manuals/chapters/running.adoc
2 files changed, 13 insertions(+), 10 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/32/30832/1
diff --git a/doc/manuals/chapters/overview.adoc
b/doc/manuals/chapters/overview.adoc
index 9cd7751..a6dc345 100644
--- a/doc/manuals/chapters/overview.adoc
+++ b/doc/manuals/chapters/overview.adoc
@@ -79,14 +79,14 @@
OsmoUPF does not support the complete PFCP feature set. It detects exactly two
use cases that will provide service of actual GTP tunnels:
-* GTP tunnel encapsulation/decapsulation:
+* `tunend`: GTP tunnel encapsulation/decapsulation:
- One Packet Detection Rule (PDR) accepts a GTP tunnel from the Access side
with an Outer Header Removal.
- This PDR uses a Forwarding Action Rule (FAR) for plain IP towards Core.
- Another PDR accepts plain IP on a specific IP address from Core.
- The second PDR uses a FAR towards Access with Outer Header Creation for
GTP.
-* GTP tunnel forwarding:
+* `tunmap`: GTP tunnel forwarding:
- One Packet Detection Rule (PDR) accepts a GTP tunnel from the Access side
with an Outer Header Removal.
- This PDR uses a Forwarding Action Rule (FAR) towards Core with an Outer
diff --git a/doc/manuals/chapters/running.adoc
b/doc/manuals/chapters/running.adoc
index 0459541..ab7ab18 100644
--- a/doc/manuals/chapters/running.adoc
+++ b/doc/manuals/chapters/running.adoc
@@ -55,7 +55,7 @@
naming of individual tunnel rulesets does not collide:
----
-nft
+tunmap
table-name osmo-upf-2
----
@@ -103,10 +103,10 @@
forwarding proxy, without encapsulation/decapsulation of GTP payloads.
[[gtp_module]]
-===== Configure Linux Kernel GTP Module
+===== Configure Linux Kernel GTP Module for `tunend`
-The Linux kernel GTP module is used for GTP encapsulation/decapsulation from/to
-"the internet".
+The Linux kernel GTP module is used for the `tunend` use case, i.e. GTP
+encapsulation/decapsulation from/to "the internet".
To use the GTP kernel module, OsmoUPF requires a GTP device, which is a
dedicated network device provided by the Linux kernel, serving as GTP tunnel
@@ -120,7 +120,7 @@
`apn23` on startup, which is also destroyed on program exit:
----
-gtp
+tunend
dev create apn23
----
@@ -131,7 +131,7 @@
called `apn42`:
----
-gtp
+tunend
dev use apn42
----
@@ -153,7 +153,7 @@
little sense to configure more than one GTP device.
[[nftables]]
-===== Configure Linux netfilter
+===== Configure Linux netfilter for `tunmap`
The Linux kernel netfilter module is used for GTP tunnel proxying, also known
as
tunnel forwarding or tunnel mapping.
@@ -165,6 +165,9 @@
can be configured in `osmo-upf.cfg` like this:
----
-nft
+tunmap
table-name my-table-name
----
+
+When running more than one osmo-upf process on a system, pick distinct table
+names to avoid name collisions in the nftables reulesets.
--
To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/30832
To unsubscribe, or for help writing mail filters, visit
https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-upf
Gerrit-Branch: master
Gerrit-Change-Id: I09a2fa28465945c98b58b4093c7d5de65e184645
Gerrit-Change-Number: 30832
Gerrit-PatchSet: 1
Gerrit-Owner: neels <[email protected]>
Gerrit-MessageType: newchange
