From 134062e33520e21f7a6e83fd51b6d02000893ea0 Mon Sep 17 00:00:00 2001
From: Harald Welte <laforge@osmocom.org>
Date: Wed, 28 Apr 2021 11:28:19 +0200
Subject: manual: Include QoS chapter and add osmo-bts specific example

Change-Id: I8fcd524c550b43a851b3094effc215e5203d28be
Requires: osmo-gsm-manuals.git Id344c29eda2a9b3e36376302b425e9db1f6c0f28
Requires: libosmo-abis.git I8991dd6eb406a5b9a70498974fc1ad339452f871
---
 doc/manuals/chapters/qos-example.adoc | 50 +++++++++++++++++++++++++++++++++++
 doc/manuals/osmobts-usermanual.adoc   |  2 ++
 2 files changed, 52 insertions(+)
 create mode 100644 doc/manuals/chapters/qos-example.adoc

(limited to 'doc/manuals')

diff --git a/doc/manuals/chapters/qos-example.adoc b/doc/manuals/chapters/qos-example.adoc
new file mode 100644
index 00000000..c31e2eb5
--- /dev/null
+++ b/doc/manuals/chapters/qos-example.adoc
@@ -0,0 +1,50 @@
+==== Full example of QoS for osmo-bts uplink QoS
+
+In the below example we will show the full set of configuration required
+for both DSCP and PCP differentiation of uplink Abis traffic by osmo-bts.
+
+What we want to achieve in this example is the following configuration:
+
+.DSCP and PCP assignments for osmo-bts uplink traffic in this example
+[options="header",width="30%",cols="2,1,1"]
+|===
+|Traffic      |DSCP|PCP
+|A-bis RSL    |  56|  7
+|A-bis RTP    |  46|  6
+|A-bis OML    |  34|  5
+|===
+
+. configure the osmocom program to set the DSCP value
+. configure an egrees QoS map to map from priority to PCP
+
+.Example Step 1: add related VTY configuration to `osmo-bts.cfg`
+----
+...
+e1_input
+ ipa ip-dscp oml 34
+ ipa socket-priority oml 5
+ ipa ip-dscp rsl 56
+ ipa socket-priority rsl 7
+...
+bts 0
+ rtp ip-dscp 46
+ rtp socket-priority 6
+ ...
+----
+
+.Example Step 2: egress QoS map to map from socket priority to PCP values
+----
+$ sudo ip link set dev eth0.9<1> type vlan egress-qos-map 0:0 1:1 5:5 6:6 7:7 <2>
+----
+<1> make sure to specify your specific VLAN interface name here instead of `eth0.9`.
+<2> create a egress QoS map that maps the priority value 1:1 to the PCP. We also include the
+    mapping 1:1 from the osmo-pcu example (see <<userman-osmopcu>>) here.
+
+NOTE:: The settings of the `ip` command are volatile and only active until
+the next reboot (or the network device or VLAN is removed).  Please refer to
+the documentation of your specific Linux distribution in order to find out how
+to make such settings persistent by means of an `ifup` hook whenever the interface
+comes up.  For CentOS/RHEL 8 this can e.g. be achieved by means of an `/sbin/ifup-local
+script` (when using `network-scripts` and not NetworkManager).  For Debian or Ubuntu,
+this typically involves adding `up` lines to `/etc/network/interfaces` or a `/etc/network/if-up.d`
+script.
diff --git a/doc/manuals/osmobts-usermanual.adoc b/doc/manuals/osmobts-usermanual.adoc
index b1b0747b..9ef49604 100644
--- a/doc/manuals/osmobts-usermanual.adoc
+++ b/doc/manuals/osmobts-usermanual.adoc
@@ -30,6 +30,8 @@ include::{srcdir}/chapters/bts-models.adoc[]
 
 include::{srcdir}/chapters/architecture.adoc[]
 
+include::./common/chapters/qos-dscp-pcp.adoc[]
+
 include::./common/chapters/vty_cpu_sched.adoc[]
 
 include::./common/chapters/trx_if.adoc[]
-- 
cgit v1.2.3