OsmoNITB Migration Guide » History » Version 9

« Previous - Version 9/24 (diff) - Next » - Current version
neels, 10/27/2017 02:36 AM

OsmoNITB Migration Guide

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.

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.

This page aims at describing the steps necessary to move from a working operation of osmo-nitb to the new split components.

Subscriber Database

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.

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:

osmo-hlr-db-tool --database /var/lib/osmocom/hlr.db --import-nitb-db /var/lib/osmocom/hlr.sqlite3

If no --database is passed, ./hlr.db is assumed.
If the target hlr.db does not exist yet, it is created.
If no --import-nitb-db is passed, a hlr.db without any subscriber data is created.

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.

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.

Note that not all information is copied to the hlr.db, just IMSI and 2G auth tokens.

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.

Configuration Files

Most of the current OsmoNITB config options still exist, but are now moved to OsmoMSC or OsmoBSC. Few are required in both.

New configuration is available to set up:
  • the GSUP connection from OsmoMSC to the OsmoHLR, and
  • the SCCP connection for the A-interface between OsmoBSC and OsmoMSC, established via OsmoSTP.

Service Files