Project

General

Profile

OsmoNITB Migration Guide » History » Version 17

neels, 11/08/2017 02:15 PM

1 3 neels
{{>toc}}
2 3 neels
3 1 neels
h1. OsmoNITB Migration Guide
4 1 neels
5 2 neels
Historically, Osmocom offered the [[OsmoNITB:]] "Network-In-The-Box" as an actual single program. It was a useful simplification at the time, but in 2017, Osmocom have decided to split OsmoNITB into programs more closely resembling traditional network architecture. It is recommended to use the new separate components instead of the OsmoNITB, since active development focus has moved there.
6 2 neels
7 2 neels
Creating a new Network In The Box from scratch is described at [[Osmocom Network In The Box]], please refer to that page to complement the descriptions found here.
8 2 neels
9 2 neels
This page aims at describing the steps necessary to move from a working operation of osmo-nitb to the new split components.
10 2 neels
11 15 neels
h1. Components
12 15 neels
13 15 neels
The OsmoNITB combined the BSC, MSC+VLR, HLR and MGW. In the new setup, SCCP/M3UA is spoken between BSC, MSC and SGSN, and OsmoSTP is used to route messages between them. On a system where OsmoNITB is installed, to replace it, you need to install these components:
14 15 neels
15 15 neels
<pre>apt-get install osmo-bsc osmo-stp osmo-bsc-mgcp osmo-mgw osmo-hlr</pre>
16 15 neels
17 15 neels
*NOTE: at the time of writing, you need to use osmo-bsc-mgcp, but this should move to osmo-mgw in a matter of weeks.*
18 15 neels
19 2 neels
h1. Subscriber Database
20 2 neels
21 4 neels
With OsmoHLR comes *@osmo-hlr-db-tool@*, which is capable of importing the most important subscriber data from a database that was used with OsmoNITB.
22 4 neels
23 5 neels
In a standard installation, the osmo-nitb database should be found at @/var/lib/osmocom/hlr.sqlite3@, and the osmo-hlr database is expected at @/var/lib/osmocom/hlr.db@. Hence the migration command becomes:
24 5 neels
25 1 neels
<pre>
26 14 lynxis
osmo-hlr-db-tool --database /var/lib/osmocom/hlr.db import-nitb-db /var/lib/osmocom/hlr.sqlite3
27 4 neels
</pre>
28 4 neels
29 8 neels
If no @--database@ is passed, @./hlr.db@ is assumed.
30 1 neels
If the target @hlr.db@ does not exist yet, it is created.
31 8 neels
32 8 neels
You may repeat / combine imports to the same @hlr.db@; any subscribers that already exist will be skipped with an error message. It is possible to do an import while osmo-hlr is actively using the database, but that is not recommended.
33 8 neels
34 8 neels
Take care that the resulting hlr.db has the proper read and write permissions by the user that will run OsmoHLR. Probably, the same ownership and permissions that the previous OsmoNITB database had is the correct choice.
35 4 neels
36 13 neels
Note that not all information is copied to the hlr.db, so far just IMSI, MSISDN and 2G auth tokens are migrated -- check the @osmo-hlr-db-tool@ cmdline help to find out what exactly is migrated at the time you're reading this.
37 5 neels
38 5 neels
To avoid future confusion, it may be desirable to remove the legacy hlr.sqlite3 from the system (i.e. backup to somewhere else), or rename it to something like @osmo-nitb.db@, so that it is not mistaken for the OsmoHLR database.
39 2 neels
40 2 neels
h1. Configuration Files
41 2 neels
42 6 neels
Most of the current OsmoNITB config options still exist, but are now moved to OsmoMSC or OsmoBSC. Few are required in both.
43 6 neels
44 9 neels
New configuration is available to set up:
45 9 neels
* the GSUP connection from OsmoMSC to the OsmoHLR, and
46 9 neels
* the SCCP connection for the A-interface between OsmoBSC and OsmoMSC, established via OsmoSTP.
47 2 neels
48 10 neels
Let's take this standard OsmoNITB configuration and split it up in OsmoBSC and OsmoMSC parts:
49 10 neels
50 10 neels
*OsmoNITB config*:
51 10 neels
<pre>
52 11 neels
# ---------- to OsmoBSC:
53 10 neels
e1_input
54 10 neels
 e1_line 0 driver ipa
55 10 neels
 ipa bind 10.42.42.2
56 11 neels
# ---------- to both OsmoBSC and OsmoMSC:
57 10 neels
network
58 10 neels
 network country code 901
59 10 neels
 mobile network code 70
60 10 neels
 short name osmo-gsm-tester-nitb
61 10 neels
 long name osmo-gsm-tester-nitb
62 10 neels
 auth policy closed
63 10 neels
 location updating reject cause 13
64 10 neels
 encryption a5 0
65 11 neels
 # ---------- to OsmoBSC:
66 10 neels
 neci 1
67 10 neels
 rrlp mode none
68 10 neels
 mm info 1
69 10 neels
 handover 0
70 10 neels
 handover window rxlev averaging 10
71 10 neels
 handover window rxqual averaging 1
72 10 neels
 handover window rxlev neighbor averaging 10
73 10 neels
 handover power budget interval 6
74 10 neels
 handover power budget hysteresis 3
75 10 neels
 handover maximum distance 9999
76 10 neels
 bts 0
77 10 neels
  type sysmobts
78 10 neels
  band GSM-1800
79 10 neels
  cell_identity 0
80 10 neels
  location_area_code 23
81 10 neels
  training_sequence_code 7
82 10 neels
  base_station_id_code 63
83 10 neels
  ms max power 33
84 10 neels
  cell reselection hysteresis 4
85 10 neels
  rxlev access min 0
86 10 neels
  channel allocator ascending
87 10 neels
  rach tx integer 9
88 10 neels
  rach max transmission 7
89 10 neels
  ip.access unit_id 1 0
90 10 neels
  oml ip.access stream_id 255 line 0
91 10 neels
  gprs mode none
92 10 neels
  trx 0
93 10 neels
   rf_locked 0
94 10 neels
   arfcn 868
95 10 neels
   nominal power 23
96 10 neels
   max_power_red 0
97 10 neels
   rsl e1 tei 0
98 10 neels
   timeslot 0
99 10 neels
    phys_chan_config CCCH+SDCCH4
100 10 neels
   timeslot 1
101 10 neels
    phys_chan_config SDCCH8
102 10 neels
   timeslot 2
103 10 neels
    phys_chan_config TCH/F
104 10 neels
   timeslot 3
105 10 neels
    phys_chan_config TCH/F
106 10 neels
   timeslot 4
107 10 neels
    phys_chan_config TCH/F
108 10 neels
   timeslot 5
109 10 neels
    phys_chan_config TCH/F
110 10 neels
   timeslot 6
111 10 neels
    phys_chan_config TCH/F
112 10 neels
   timeslot 7
113 10 neels
    phys_chan_config TCH/F
114 11 neels
# ---------- to OsmoMSC:
115 10 neels
smpp
116 10 neels
 local-tcp-ip 10.42.42.2 2775
117 10 neels
 system-id test-nitb
118 10 neels
 policy closed
119 1 neels
</pre>
120 1 neels
121 11 neels
h2. OsmoBSC config
122 11 neels
123 11 neels
To above snippets from the OsmoNITB config, you may want to add a 'cs7 instance' section to configure the SCCP point codes and connection to the OsmoSTP. Note that if omitted, default values apply.
124 11 neels
125 11 neels
You also need to add an 'msc' section to tell OsmoBSC where to reach the MSC.
126 11 neels
127 11 neels
*additions to OsmoBSC's config*:
128 11 neels
<pre>
129 11 neels
cs7 instance 0
130 11 neels
 point-code 0.0.2
131 11 neels
 sccp-address msc_remote
132 11 neels
  point-code 0.0.1
133 11 neels
msc
134 11 neels
 msc-addr msc_remote
135 11 neels
</pre>
136 11 neels
137 11 neels
This should give you an OsmoBSC config file like:
138 11 neels
139 10 neels
*OsmoBSC config*:
140 10 neels
<pre>
141 10 neels
e1_input
142 1 neels
 e1_line 0 driver ipa
143 1 neels
 ipa bind 10.42.42.5
144 1 neels
cs7 instance 1
145 10 neels
 point-code 0.0.2
146 10 neels
 sccp-address msc_remote
147 10 neels
  point-code 0.0.1
148 11 neels
msc
149 11 neels
 ! 'msc_remote' is an address book entry defined above under 'cs7'
150 11 neels
 msc-addr msc_remote
151 10 neels
network
152 10 neels
 network country code 901
153 10 neels
 mobile network code 70
154 10 neels
 short name osmo-gsm-tester-msc
155 10 neels
 long name osmo-gsm-tester-msc
156 10 neels
 auth policy closed
157 10 neels
 location updating reject cause 13
158 10 neels
 encryption a5 0
159 10 neels
 authentication optional
160 10 neels
 neci 1
161 10 neels
 rrlp mode none
162 10 neels
 mm info 1
163 10 neels
 handover 0
164 10 neels
 handover window rxlev averaging 10
165 10 neels
 handover window rxqual averaging 1
166 10 neels
 handover window rxlev neighbor averaging 10
167 10 neels
 handover power budget interval 6
168 10 neels
 handover power budget hysteresis 3
169 10 neels
 handover maximum distance 9999
170 10 neels
 bts 0
171 10 neels
  type sysmobts
172 10 neels
  band GSM-1800
173 10 neels
  cell_identity 0
174 10 neels
  location_area_code 23
175 10 neels
  training_sequence_code 7
176 10 neels
  base_station_id_code 63
177 10 neels
  ms max power 33
178 10 neels
  cell reselection hysteresis 4
179 10 neels
  rxlev access min 0
180 10 neels
  channel allocator ascending
181 10 neels
  rach tx integer 9
182 10 neels
  rach max transmission 7
183 10 neels
  ip.access unit_id 1 0
184 10 neels
  oml ip.access stream_id 255 line 0
185 10 neels
  gprs mode none
186 10 neels
  trx 0
187 10 neels
   rf_locked 0
188 10 neels
   arfcn 868
189 10 neels
   nominal power 23
190 10 neels
   max_power_red 0
191 10 neels
   rsl e1 tei 0
192 10 neels
   timeslot 0
193 10 neels
    phys_chan_config CCCH+SDCCH4
194 10 neels
   timeslot 1
195 10 neels
    phys_chan_config SDCCH8
196 10 neels
   timeslot 2
197 10 neels
    phys_chan_config TCH/F
198 10 neels
   timeslot 3
199 1 neels
    phys_chan_config TCH/F
200 10 neels
   timeslot 4
201 10 neels
    phys_chan_config TCH/F
202 1 neels
   timeslot 5
203 1 neels
    phys_chan_config TCH/F
204 1 neels
   timeslot 6
205 1 neels
    phys_chan_config TCH/F
206 1 neels
   timeslot 7
207 1 neels
    phys_chan_config TCH/F
208 11 neels
</pre>
209 11 neels
210 11 neels
h2. OsmoMSC config
211 11 neels
212 11 neels
To the MSC bits copied from OsmoNITB, you may want to add:
213 11 neels
214 11 neels
* a 'cs7 instance' section to configure the SCCP point codes and connection to the OsmoSTP. Note that if omitted, default values apply.
215 11 neels
* an 'hlr' section if your OsmoHLR is not running on localhost.
216 11 neels
* an 'msc' section to indicate where to reach the MGW, if it is not on localhost.
217 11 neels
218 11 neels
<pre>
219 11 neels
cs7 instance 0
220 11 neels
 point-code 0.0.1
221 11 neels
hlr
222 11 neels
 remote-ip 10.42.42.2
223 10 neels
msc
224 11 neels
 mgcpgw remote-ip 10.42.42.3
225 10 neels
</pre>
226 10 neels
227 11 neels
This should give you an OsmoMSC config file like:
228 11 neels
229 10 neels
*OsmoMSC config*:
230 11 neels
231 10 neels
<pre>
232 12 neels
cs7 instance 0
233 12 neels
 point-code 0.0.1
234 12 neels
msc
235 12 neels
 mgcpgw remote-ip 10.42.42.3
236 12 neels
hlr
237 12 neels
 remote-ip 10.42.42.2
238 10 neels
network
239 10 neels
 network country code 901
240 10 neels
 mobile network code 70
241 10 neels
 short name osmo-gsm-tester-msc
242 10 neels
 long name osmo-gsm-tester-msc
243 10 neels
 auth policy closed
244 10 neels
 location updating reject cause 13
245 10 neels
 encryption a5 0
246 10 neels
 authentication optional
247 10 neels
smpp
248 10 neels
 local-tcp-ip 10.42.42.4 2775
249 10 neels
 system-id test-msc
250 2 neels
 policy closed
251 2 neels
</pre>
252 2 neels
253 1 neels
h1. Service Files
254 1 neels
255 1 neels
TODO
Add picture from clipboard (Maximum size: 48.8 MB)