blob: 726ec41ade55b538384fbffe919d995651b83b4a [file] [log] [blame]
Daniel Willmannfcf0abb2021-01-26 18:19:48 +01001== Configuring OsmoGbProxy
Harald Weltea5ad7a42019-03-21 22:52:44 +01002
Daniel Willmann12969722021-01-27 18:24:42 +01003OsmoGbProxy requires very little configuration, most of it being the
4configuration of the NS links.
5Most config options specific to OsmoGbProxy are related to SGSN pooling and
6telling the proxy which NSE(s) it should use to talk to the SGSN(s).
Harald Welte209dc9f2020-12-12 19:02:16 +01007
Daniel Willmann12969722021-01-27 18:24:42 +01008=== Configure the Network Service (NS)
9
10A detailed description of the NS configuration can be found in <<libosmogb>>.
11The following config snippets assume the SGSN(s) (NSEI 101 and 102) are using
12IP-SNS and listen on 10.0.1.1:23000 and 10.0.1.2:23000 respectively.
13
14This would be the NS config for the SGSN(s):
15
16.Example: NS configuration example (SGSN)
17----
18ns
19 bind udp local
20 listen 10.0.0.1 23000 <1>
21 nse 101 <2>
22 ip-sns 10.0.1.1 23000 <3>
23 nse 102
24 ip-sns 10.0.1.2 23000
25----
26<1> Define the local IP/port from which to connect
27<2> Define an NSE with NSEI
28<3> Use IP-SNS to connect to the SGSN
29
30=== Configure an SGSN
31
32Configuration of a single (non-pooling) SGSN is rather simple.
33
34.Example: SGSN configuration example
35----
36sgsn 101 <1>
37 name Main SGSN <2>
38----
39<1> Each SGSN is identified by its NSEI (same as in the NS configuration)
40<2> An SGSN can optionally have a name. If none is set a default name will be used.
Harald Welte209dc9f2020-12-12 19:02:16 +010041
42=== SGSN pool support
43
44In a SGSN pool, osmo-gbproxy is facing the problem of dividing the downlink
45capacity of a cell towards the SGSN. The BSS advertises the per-BVC capacity
46by means of the BSSGP FLOW-CONTROL-BVC messages, but as there are multiple
47SGSN in a pool, they all have to share / divide that total capacity.
48
49By default, osmo-gbproxy advertises the full capacity to _each_ of the SGSN
50pool members, which results in significant over-provisioning and can lead to
51overload situations.
52
53The administrator can configure the _percentage_ of the overall BSS-advertised
54capacity that shall be reported to each pool member SGSN using the
55`pool bvc-flow-control-ratio <1-100>` configuration command.
56
57A setting of 100 means that each pool member is informed of 100% of the
58BSS side capacity.
59
60A setting of 25 means that each pool member is informed of 25% of the
61BSS side capacity. This would make most sense in a set-up with four
62SGSN of equal share.
63
64More complex capacity division schemes are so far not supported by
65osmo-gbproxy.