<p>daniel has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-gbproxy/+/23868">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">examples/manuals: Improve/update ns-related documentation<br><br>* example config files with current libosmogb options<br>* Unify IPs used in config and manual<br>* Include NS2-related configuration chapters in manual<br><br>Closes: SYS#5115<br>Change-Id: I57cf5dc4ee686352252086917f5f63d5a69dddd7<br>---<br>M doc/examples/osmo-gbproxy/osmo-gbproxy-pool.cfg<br>M doc/examples/osmo-gbproxy/osmo-gbproxy.cfg<br>M doc/manuals/chapters/gbproxy-configuration.adoc<br>M doc/manuals/chapters/gbproxy-sgsnpool.adoc<br>M doc/manuals/osmogbproxy-usermanual.adoc<br>5 files changed, 69 insertions(+), 46 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-gbproxy refs/changes/68/23868/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/examples/osmo-gbproxy/osmo-gbproxy-pool.cfg b/doc/examples/osmo-gbproxy/osmo-gbproxy-pool.cfg</span><br><span>index bbc8a1b..c724a3c 100644</span><br><span>--- a/doc/examples/osmo-gbproxy/osmo-gbproxy-pool.cfg</span><br><span>+++ b/doc/examples/osmo-gbproxy/osmo-gbproxy-pool.cfg</span><br><span>@@ -7,22 +7,25 @@</span><br><span> !</span><br><span> gbproxy</span><br><span>   nri bitlen 4</span><br><span style="color: hsl(0, 100%, 40%);">-  nri null add 0 4</span><br><span style="color: hsl(120, 100%, 40%);">+  nri null add 15</span><br><span> sgsn nsei 101</span><br><span>  name main</span><br><span>  nri add 1</span><br><span style="color: hsl(0, 100%, 40%);">- nri add 11</span><br><span> sgsn nsei 102</span><br><span>  nri add 2</span><br><span style="color: hsl(0, 100%, 40%);">- nri add 12</span><br><span> ns</span><br><span style="color: hsl(0, 100%, 40%);">- bind udp local</span><br><span style="color: hsl(0, 100%, 40%);">-  listen 127.0.0.100 23000</span><br><span style="color: hsl(0, 100%, 40%);">-  accept-ipaccess</span><br><span style="color: hsl(120, 100%, 40%);">+ bind udp sgsn-side</span><br><span style="color: hsl(120, 100%, 40%);">+  listen 10.0.0.1 23000</span><br><span>  nse 101</span><br><span style="color: hsl(0, 100%, 40%);">-  nsvc ipa local 192.168.100.239 7777 nsvci 101</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-bind sgsn-side</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-remote 10.0.1.1 23000</span><br><span>  nse 102</span><br><span style="color: hsl(0, 100%, 40%);">-  nsvc ipa local 192.168.100.239 7778 nsvci 102</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-bind sgsn-side</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-remote 10.0.1.2 23000</span><br><span style="color: hsl(120, 100%, 40%);">+ bind udp bss-side</span><br><span style="color: hsl(120, 100%, 40%);">+  listen 10.0.0.100 23000</span><br><span style="color: hsl(120, 100%, 40%);">+  accept-dynamic-ip-sns</span><br><span style="color: hsl(120, 100%, 40%);">+ ip-sns-default bind bss-side</span><br><span>  timer tns-block 3</span><br><span>  timer tns-block-retries 3</span><br><span>  timer tns-reset 3</span><br><span>diff --git a/doc/examples/osmo-gbproxy/osmo-gbproxy.cfg b/doc/examples/osmo-gbproxy/osmo-gbproxy.cfg</span><br><span>index 777d0b0..cbabb2d 100644</span><br><span>--- a/doc/examples/osmo-gbproxy/osmo-gbproxy.cfg</span><br><span>+++ b/doc/examples/osmo-gbproxy/osmo-gbproxy.cfg</span><br><span>@@ -9,11 +9,15 @@</span><br><span> sgsn nsei 101</span><br><span>  name main</span><br><span> ns</span><br><span style="color: hsl(0, 100%, 40%);">- bind udp local</span><br><span style="color: hsl(0, 100%, 40%);">-  listen 127.0.0.100 23000</span><br><span style="color: hsl(0, 100%, 40%);">-  accept-ipaccess</span><br><span style="color: hsl(120, 100%, 40%);">+ bind udp sgsn-side</span><br><span style="color: hsl(120, 100%, 40%);">+  listen 10.0.0.1 23000</span><br><span>  nse 101</span><br><span style="color: hsl(0, 100%, 40%);">-  nsvc ipa local 192.168.100.239 7777 nsvci 101</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-bind sgsn-side</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-remote 10.0.1.1 23000</span><br><span style="color: hsl(120, 100%, 40%);">+ bind udp bss-side</span><br><span style="color: hsl(120, 100%, 40%);">+  listen 10.0.0.100 23000</span><br><span style="color: hsl(120, 100%, 40%);">+  accept-dynamic-ip-sns</span><br><span style="color: hsl(120, 100%, 40%);">+ ip-sns-default bind bss-side</span><br><span>  timer tns-block 3</span><br><span>  timer tns-block-retries 3</span><br><span>  timer tns-reset 3</span><br><span>diff --git a/doc/manuals/chapters/gbproxy-configuration.adoc b/doc/manuals/chapters/gbproxy-configuration.adoc</span><br><span>index 87da471..79a508b 100644</span><br><span>--- a/doc/manuals/chapters/gbproxy-configuration.adoc</span><br><span>+++ b/doc/manuals/chapters/gbproxy-configuration.adoc</span><br><span>@@ -5,29 +5,10 @@</span><br><span> Most config options specific to OsmoGbProxy are related to SGSN pooling and</span><br><span> telling the proxy which NSE(s) it should use to talk to the SGSN(s).</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-=== Configure the Network Service (NS)</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-A detailed description of the NS configuration can be found in <<libosmogb>>.</span><br><span> The following config snippets assume the SGSN(s) (NSEI 101 and 102) are using</span><br><span> IP-SNS and listen on 10.0.1.1:23000 and 10.0.1.2:23000 respectively.</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-This would be the NS config for the SGSN(s):</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-.Example: NS configuration example (SGSN)</span><br><span>-----</span><br><span style="color: hsl(0, 100%, 40%);">-ns</span><br><span style="color: hsl(0, 100%, 40%);">- bind udp local</span><br><span style="color: hsl(0, 100%, 40%);">-  listen 10.0.0.1 23000 <1></span><br><span style="color: hsl(0, 100%, 40%);">- nse 101 <2></span><br><span style="color: hsl(0, 100%, 40%);">-  ip-sns 10.0.1.1 23000 <3></span><br><span style="color: hsl(0, 100%, 40%);">- nse 102</span><br><span style="color: hsl(0, 100%, 40%);">-  ip-sns 10.0.1.2 23000</span><br><span>-----</span><br><span style="color: hsl(0, 100%, 40%);">-<1> Define the local IP/port from which to connect</span><br><span style="color: hsl(0, 100%, 40%);">-<2> Define an NSE with NSEI</span><br><span style="color: hsl(0, 100%, 40%);">-<3> Use IP-SNS to connect to the SGSN</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-=== Configure an SGSN</span><br><span style="color: hsl(120, 100%, 40%);">+=== Configure SGSN(s)</span><br><span> </span><br><span> Configuration of a single (non-pooling) SGSN is rather simple.</span><br><span> </span><br><span>@@ -35,7 +16,36 @@</span><br><span> ----</span><br><span> sgsn 101 <1></span><br><span>  name Main SGSN <2></span><br><span style="color: hsl(120, 100%, 40%);">+sgsn 102</span><br><span style="color: hsl(120, 100%, 40%);">+ns</span><br><span style="color: hsl(120, 100%, 40%);">+ bind udp sgsn-side</span><br><span style="color: hsl(120, 100%, 40%);">+  listen 10.0.0.1 23000 <3></span><br><span style="color: hsl(120, 100%, 40%);">+ nse 101 <4></span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-bind sgsn-side <5></span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-remote 10.0.1.1 23000 <6></span><br><span style="color: hsl(120, 100%, 40%);">+ nse 102</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-bind sgsn-side</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-remote 10.0.1.2 23000</span><br><span> ----</span><br><span> <1> Each SGSN is identified by its NSEI (same as in the NS configuration)</span><br><span> <2> An SGSN can optionally have a name. If none is set a default name will be used.</span><br><span style="color: hsl(120, 100%, 40%);">+<3> Define IP/port from which to connect</span><br><span style="color: hsl(120, 100%, 40%);">+<4> Define an NSE with NSEI</span><br><span style="color: hsl(120, 100%, 40%);">+<5> Use this bind to connect from</span><br><span style="color: hsl(120, 100%, 40%);">+<6> Use IP-SNS to connect to the SGSN</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+=== Configure a socket for BSS</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The following configuration shows how to accept arbitrary BSS-NSE</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+.Example: NS configuration example (NS)</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+ns</span><br><span style="color: hsl(120, 100%, 40%);">+ bind udp bss-side <1></span><br><span style="color: hsl(120, 100%, 40%);">+  listen 10.0.0.100 23000</span><br><span style="color: hsl(120, 100%, 40%);">+  accept-dynamic-ip-sns <2></span><br><span style="color: hsl(120, 100%, 40%);">+ ip-sns-default bind bss-side <3></span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+<1> Define bind with IP/port for the BSS</span><br><span style="color: hsl(120, 100%, 40%);">+<2> Allow BSS with dynamic NSE to connect to this bind</span><br><span style="color: hsl(120, 100%, 40%);">+<3> Use this bind as default for dynamic NSE</span><br><span>\ No newline at end of file</span><br><span>diff --git a/doc/manuals/chapters/gbproxy-sgsnpool.adoc b/doc/manuals/chapters/gbproxy-sgsnpool.adoc</span><br><span>index 61806af..cc30515 100644</span><br><span>--- a/doc/manuals/chapters/gbproxy-sgsnpool.adoc</span><br><span>+++ b/doc/manuals/chapters/gbproxy-sgsnpool.adoc</span><br><span>@@ -48,26 +48,32 @@</span><br><span> ==== Connecting Multiple SGSNs</span><br><span> </span><br><span> ----</span><br><span style="color: hsl(0, 100%, 40%);">-# Configure the Network Service</span><br><span style="color: hsl(120, 100%, 40%);">+! Configure the Network Service</span><br><span> ns</span><br><span>  bind udp sgsn</span><br><span>   listen 10.0.0.1 23000</span><br><span>  nse 1</span><br><span style="color: hsl(0, 100%, 40%);">-  ip-sns 10.0.1.1 23000</span><br><span style="color: hsl(0, 100%, 40%);">-  ip-sns 10.0.1.1 23001</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-bind sgsn</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-remote 10.0.1.1 23000</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-remote 10.0.1.1 23001</span><br><span>  nse 2</span><br><span style="color: hsl(0, 100%, 40%);">-  ip-sns 10.0.1.2 23000</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-bind sgsn</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-remote 10.0.1.2 23000</span><br><span>  nse 3</span><br><span style="color: hsl(0, 100%, 40%);">-  ip-sns 10.0.1.3 23000</span><br><span style="color: hsl(0, 100%, 40%);">-# configure NRI value ranges</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-bind sgsn</span><br><span style="color: hsl(120, 100%, 40%);">+  ip-sns-remote 10.0.1.3 23000</span><br><span style="color: hsl(120, 100%, 40%);">+! configure NRI value ranges</span><br><span> gbproxy</span><br><span>  nri bitlen 10</span><br><span>  nri null add 0</span><br><span style="color: hsl(0, 100%, 40%);">-sgsn 1</span><br><span style="color: hsl(120, 100%, 40%);">+sgsn nsei 1</span><br><span style="color: hsl(120, 100%, 40%);">+ name SGSN01</span><br><span>  nri add 1 341</span><br><span style="color: hsl(0, 100%, 40%);">-sgsn 2</span><br><span style="color: hsl(120, 100%, 40%);">+sgsn nsei 2</span><br><span style="color: hsl(120, 100%, 40%);">+ name SGSN02</span><br><span>  nri add 342 682</span><br><span style="color: hsl(0, 100%, 40%);">-sgsn 3</span><br><span style="color: hsl(120, 100%, 40%);">+sgsn nsei 3</span><br><span style="color: hsl(120, 100%, 40%);">+ name SGSN03</span><br><span>  nri add 683 1023</span><br><span> ----</span><br><span> </span><br><span>@@ -184,8 +190,6 @@</span><br><span> that are being paged by this SGSN. But OsmoGbProxy will no longer direct new</span><br><span> subscribers to this SGSN.</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-TODO: Is paging response relevant for SGSN?</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> To re-enable an SGSN for attaching new subscribers:</span><br><span> </span><br><span> ----</span><br><span>diff --git a/doc/manuals/osmogbproxy-usermanual.adoc b/doc/manuals/osmogbproxy-usermanual.adoc</span><br><span>index 454cf69..4c3e419 100644</span><br><span>--- a/doc/manuals/osmogbproxy-usermanual.adoc</span><br><span>+++ b/doc/manuals/osmogbproxy-usermanual.adoc</span><br><span>@@ -21,13 +21,15 @@</span><br><span> </span><br><span> include::{srcdir}/chapters/gbproxy-configuration.adoc[]</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/gb-ns2-configuration.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/gb-ns2-configuration-timer.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> include::{srcdir}/chapters/gbproxy-sgsnpool.adoc[]</span><br><span> </span><br><span> include::./common/chapters/gb-ns2.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::./common/chapters/gb.adoc[]</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-include::./common/chapters/control_if.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+asdfadsfdsfainclude::./common/chapters/control_if.adoc[]</span><br><span> </span><br><span> include::{srcdir}/chapters/counters_generated.adoc[]</span><br><span> </span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-gbproxy/+/23868">change 23868</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-gbproxy/+/23868"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-gbproxy </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I57cf5dc4ee686352252086917f5f63d5a69dddd7 </div>
<div style="display:none"> Gerrit-Change-Number: 23868 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: daniel <dwillmann@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>