This tutorial is intended to setup all the OpenAirInterface5G components using the S1 interface, placing the core components in a cloud based system. The connection between OAI-UE and the OAI-eNB will be carried out by using USRP B210 SDR cards connected using wires and the selected cloud system where cloud components will be deployed will be OpenStack.
The proposed deployment has been tested using the hardware showed in the following figure:
The attenuation between UE and eNB should be adjusted between 40 and 60 dB.
The core components will be deployed in a cloud based system. In this tutorial, we are going to use OpenStack as a virtual machines manager. For this deployment we need three virtual machines, one per OpenAirCN componet with the following configuration:
- Ubuntu 14.04 LTS (64-bits)
- Install git
sudo apt-get install git
- Kernel setup: Install 4.7.x kernel from pre-compiled debian package
git clone https://gitlab.eurecom.fr/oai/linux-4.7.x.gitcd linux-4.7.xsudo dpkg -i linux-headers-4.7.7-oaiepc_4.7.7-oaiepc-10.00.Custom_amd64.deb linux-image-4.7.7-oaiepc_4.7.7-oaiepc-10.00.Custom_amd64.deb
- Download the latest development branch of OpenAir-cn
git clone https://gitlab.eurecom.fr/oai/openair-cn.gitcd openair-cn/git checkout developgit fetch && git pull
Core Components Network Configuration
Once we have our virtual machines running, we have to configure all the network devices in order to allow the communication between them. We propose the following network configuration (OpenStack):
Setup communication between eNB and Cloud based Core Network
Before start configuring the core components, we have to setup a VPN between eNB, MME and SP-GW in order to allow IP level communication between them. In order to do so, we are going to setup an OpenVPN server in the eNB and generate certificates for both MME and SP-GW following this tutorial How To Set Up an OpenVPN Server on Ubuntu 14.04.
HSS Configuration and Building
Log into the HSS virtual machine and follow the instructions below:
sudo apt-get install mysql-servercd ~/openair-cn/scripts/./build_hss -i- Create folder for configuration files
sudo mkdir -p /usr/local/etc/oai/freeDiameter
- Copy Configuration files to the folder
sudo cp ~/openair-cn/etc/hss.conf /usr/local/etc/oaisudo cp ~/openair-cn/etc/acl.conf ~/openair-cn/etc/hss_fd.conf /usr/local/etc/oai/freeDiameter
- Set FQDN for the HSS by modifying
/etc/hostsfile127.0.1.1 hss.openair4G.eur hss
- Generate Certificates for HSS
./check_hss_s6a_certificate /usr/local/etc/oai/freeDiameter hss.openair4G.eur
- Modify HSS configuration file
/usr/local/etc/oai/hss.conf
HSS :
{
## MySQL mandatory options
MYSQL_server = "127.0.0.1";
MYSQL_user = "@MYSQL_user@";
MYSQL_pass = "@MYSQL_pass@";
MYSQL_db = "oai_db";
-- HSS options
OPERATOR_key = "1006020f0a478bf6b699f15c062e42b3"; # OP key for oai_db.sql
RANDOM = "true";
-- Freediameter options
FD_conf = "/usr/local/etc/oai/freeDiameter/hss_fd.conf";
};
- Modify freediameter configuration file
/usr/local/etc/oai/freeDiameter/hss_fd.conf
-- Identity and realm configured on /etc/hosts
Identity = "hss.openair4G.eur";
Realm = "openair4G.eur";
-- Certificates
TLS_Cred = "/usr/local/etc/oai/freeDiameter/hss.cert.pem", "/usr/local/etc/oai/
freeDiameter/hss.key.pem";
TLS_CA = "/usr/local/etc/oai/freeDiameter/hss.cacert.pem";
- Load example database only in the first run
sudo ./run_hss -i ~/openair-cn/src/oai_hss/db/oai_db.sql
- Change "mmehost" field from mmeidentity table of oai_db database
- Option 1: Change it using phpMyAdmin
- Edit row with "idmmeidentity" value equal to 4
- Change "yang.openair4G.eur" to "mme.openair4G.eur"
- Option 2: Change it using mysql command line
mysql -u root -puse oai_dbUPDATE mmeidentity SET mmehost = 'mme.openair4G.eur' WHERE idmmeidentity = 4;
- Option 1: Change it using phpMyAdmin
MME Configuration and Building
The hostname of this machine must be its Identity, in our case "mme". We can change this identifier by modifying "/etc/hosts" and "/etc/hostsname". Then, restart the virtual machine. Log into the MME virtual machine and follow the instructions below:
cd ~/openair-cn/scripts/sudo mkdir -p /usr/local/etc/oai/freeDiameter./build_mme -isudo cp ~/openair-cn/etc/mme.conf /usr/local/etc/oaisudo cp ~/openair-cn/etc/mme_fd.conf /usr/local/etc/oai/freeDiameter/./check_mme_s6a_certificate /usr/local/etc/oai/freeDiameter/ mme.openair4G.eurvim /usr/local/etc/oai/mme.conf
NETWORK_INTERFACES :
{
# MME binded interface for S1-C or S1-MME communication (S1AP), can be ethernet interface, virtual ethernet interface
MME_INTERFACE_NAME_FOR_S1_MME = "TUN_IFACE"; # YOUR NETWORK CONFIG HERE
MME_IPV4_ADDRESS_FOR_S1_MME = "IP_ADDR_OF_TUN_IFACE"; # YOUR NETWORK CONFIG HERE
# MME binded interface for S11 communication (GTPV2-C)
MME_INTERFACE_NAME_FOR_S11_MME = "eth2"; # YOUR NETWORK CONFIG HERE
MME_IPV4_ADDRESS_FOR_S11_MME = "192.168.30.2/24"; # YOUR NETWORK CONFIG HERE
MME_PORT_FOR_S11_MME = 2123; # YOUR NETWORK CONFIG HERE
};
S-GW :
{
# S-GW binded interface for S11 communication (GTPV2-C), if none selected the ITTI message interface is used
SGW_IPV4_ADDRESS_FOR_S11 = "192.168.30.3/24"; # YOUR NETWORK CONFIG HERE
};
- Edit the configuration
vim /usr/local/etc/oai/freeDiameter/mme_fd.conf
# Identity of MME
Identity = "mme.openair4G.eur";
Realm = "openair4G.eur";
# TLS configuration
TLS_Cred = "/usr/local/etc/oai/freeDiameter/mme.cert.pem",
"/usr/local/etc/oai/freeDiameter/mme.key.pem";
TLS_CA = "/usr/local/etc/oai/freeDiameter/mme.cacert.pem";
# HSS information
ConnectPeer= "hss.openair4G.eur" { ConnectTo = "192.168.40.3"; No_SCTP ; No_IPv6;
Prefer_TCP; No_TLS; port = 3868; realm = "openair4G.eur";};
The MME setup is finished.
Run the MME by running the script ./run_mme in ~/openair-cn/scripts/
SP-GW Configuration and Building
cd ~/openair-cn/scripts/sudo mkdir -p /usr/local/etc/oai/freeDiameter./build_spgw -isudo vim /etc/hosts
127.0.1.1 sgpw.openair4G.eur spgw
sudo cp ~/openair-cn/etc/spgw.conf /usr/local/etc/oai/sudo vim /usr/local/etc/oai/spgw.conf
S-GW :
{
NETWORK_INTERFACES :
{
# S-GW binded interface for S11 communication (GTPV2-C)
SGW_INTERFACE_NAME_FOR_S11 = "eth2"; # YOUR NETWORK CONFIG HERE
SGW_IPV4_ADDRESS_FOR_S11 = "192.168.30.3/24"; # YOUR NETWORK CONFIG HERE
# S-GW binded interface for S1-U communication (GTPV1-U) can be ethernet interface, virtual ethernet
SGW_INTERFACE_NAME_FOR_S1U_S12_S4_UP = "eth1";
SGW_IPV4_ADDRESS_FOR_S1U_S12_S4_UP = "192.168.20.10/24";
SGW_IPV4_PORT_FOR_S1U_S12_S4_UP = 2152;
# S-GW binded interface for S5 or S8 communication, not implemented, so leave it to none
SGW_INTERFACE_NAME_FOR_S5_S8_UP = "none"; # STRING, interface name, DO NOT CHANGE (NOT IMPLEMENTED YET)
SGW_IPV4_ADDRESS_FOR_S5_S8_UP = "0.0.0.0/24"; # STRING, CIDR, DO NOT CHANGE (NOT IMPLEMENTED YET)
};
P-GW =
{
NETWORK_INTERFACES :
{
# P-GW binded interface for S5 or S8 communication, not implemented, so leave it to none
PGW_INTERFACE_NAME_FOR_S5_S8 = "none"; # STRING, interface name, DO NOT CHANGE (NOT IMPLEMENTED YET)
# P-GW binded interface for SGI (egress/ingress internet traffic)
PGW_INTERFACE_NAME_FOR_SGI = "eth0"; # STRING, YOUR NETWORK CONFIG HERE
PGW_MASQUERADE_SGI = "yes"; # STRING, {"yes","no"}. YOUR NETWORK CONFIG HERE, will do NAT for you if you put "yes".
UE_TCP_MSS_CLAMPING = "no"; # STRING, {"yes","no"}.
};
Build the SPGW using the command ./build_spgw in ~/openair-cn/scripts/
- In case the build failed (NETTLE VERSION missing), run first the command
./build_mme -ias in the MME setup
After successful build, run the SPGW with the command ./run_spgw
To install the low-latency kernel 3.19 on top of Ubuntu 14.04, 64-bit architecture type
sudo apt-get install linux-image-3.19.0-61-lowlatency linux-headers-3.19.0-61-lowlatency
Remove all power management features in the BIOS (sleep states, in particular C-states) and CPU frequency scaling (Intel SpeedStep). In some cases, you can also do this with cpufreqtool. Also, disable hyperthreading in BIOS and make sure its turned off in Linux
- Disable CPU frequency scaling
- Disable p-state and c-state in linux
sudo vim /etc/default/grub
GRUB_CMDLINE_LINUX_DEFAULT="quiet intel_pstate=disable"sudo update-grub
- Append "blacklist intel_powerclamp" to the end of /etc/modprobe.d/blacklist.conf, to blacklist the intel_powerclamp" module. If the file does not exist, create one, and add the line into it.
- You also need to disable hyperthreading, CPU frequency control, C-States, P-States and any other power management from BIOS as well.
Build the eNB supporting USRP B210
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.gitcd ~/openairinterface5gsource oaienv- It sets the environment variables with the needed valuescd cmake_targets./build_oai -I -w USRP --eNB- The "-I" option is needed only once, then you can build without this option
This should starts the building process in ~/openairinterface5g/cmake_targets/lte_build_oai.
Now, we have to specify how the core components could be accessed by the eNB. Remember that we are going to use a VPN to provide IP level connectivity between the eNB and the core components located at the eNB. It is important to take into account that core components must be able to reach the eNB, because it will act as VPN server as we mentioned before.
Let's modify the configuration file that will be used when running the eNB in order to allow it to reach the core components.
- Modify the eNB's configuration file
vim ~/openairinterface5g/targets/PROJECTS/GENERIC-LTE-EPC/CONF/enb.band7.tm1.usrpb210.conf
////////// MME parameters:
mme_ip_address = ( { ipv4 = "VPN_MME_IP";
ipv6 = "192:168:30::17";
active = "yes";
preference = "ipv4";
}
);
NETWORK_INTERFACES :
{
ENB_INTERFACE_NAME_FOR_S1_MME = "TUN_IFACE";
ENB_IPV4_ADDRESS_FOR_S1_MME = "TUN_IFACE_IP/NETMASK";
ENB_INTERFACE_NAME_FOR_S1U = "TUN_IFACE";
ENB_IPV4_ADDRESS_FOR_S1U = "TUN_IFACE_IP/NETMASK";
ENB_PORT_FOR_S1U = 2152; # Spec 2152
};
This configuration file contains all the different parameters of the eNB such as number of resource blocks that will be used, band, rx/tx gain, etc. In case you want to run the eNB with other configuration, refer to this file.
Build the UE supporting USRP B210
cd ~/openairinterface5gsource oaienv- It sets the environment variables with the needed valuescd cmake_targets./build_oai -I -w USRP --UE- The "-I" option is needed only once, then you can build without this option
This should starts the building process in ~/openairinterface5g/cmake_targets/lte_build_oai.
- HSS
cd ~/openair-cn/SCRIPTS./run_hss
- MME
cd ~/openair-cn/SCRIPTS./run_mme- once started, we should see in the HSS log a "MME status changed to active" message
- SP-GW
cd ~/openair-cn/SCRIPTS./run_spgw
cd ~/openairinterface5g/source oaienvcd cmake_targetssudo -E ./lte_build_oai/build/lte-softmodem -O $OPENAIR_TARGETS/PROJECTS/GENERIC-LTE-EPC/CONF/enb.band7.tm1.usrpb210.conf
After a few seconds, we can see a "Associated MME 1" message in the eNB log and finally the eNB starts waiting for connections showing two "got sync" messages.
This is the more sensitive part because depending on the attenuation that we have in our wires, we have to adjust the rx/tx gain to get the UE connected to the eNB. In our deployment, we have 45 dB attenuation per wire. Before run the UE, we have to install the ue_ip.ko kernel module in order to bring up the OIP interface, oip0, that will be configured with the IP received from the SP-GW through the MME. In order to do so, we have to insert the ue_ip.ko module provided by OpenAirInterface5g.
cd ~/openairinterface5g/source oaienvsudo insmod $OPENAIR_TARGETS/bin/ue_ip.ko
Now, run the UE
cd ~/openairinterface5g/source oaienvcd cmake_targets/lte_build_oai/buildsudo -E ./lte-softmodem -U -C2660000000 -r25 --ue-scan-carrier --ue-txgain 85 --ue-rxgain 100
After that, check that you have an IP address in one of the oip interfaces created by the ue_ip.ko module (usually oip1).
When all the componets are well connected, we need to check the routes that we have along the path to reach internet (UE physical machine, eNB physical machine and SP-GW virtual machine) in order to allow the UE to reach the internet through the already deployed architecture.
The UE can be simulated if there is absence of hardware.
The tutorial must be executed until the OAI UE deployment part.
Re-configuration in the eNB, MME and eNB is required.
TAI parameters in the MME and eNB should be the same.
In the eNB simulation configuration file (on the eNB machine)
~/OPENAIR_DIR/target/PROJECTS/GENERIC-LTE-EPC/CONF/enb.band7.generic.oaisim.local_mme.conf
the TAI list should have these parameteres set:
tracking_area_code = "1";
mobile_country_code = "208";
mobile_network_code = "93";
In the MME configuration file (on the MME machine)
/usr/local/etc/oai/mme.conf
they are set as:
TAI_LIST = (
{MCC="208" ; MNC="93"; TAC = "1"; } # YOUR TAI CONFIG HERE
);
The IMSI, the key and mmeidentity_idmmeidentity of the UE have to be correctly recorded in the HSS database.
In the eNB (machine), the value of the key is taken from the USIM configuration header file:
vim ~/OPENAIR_DIR/openair3/NAS/UE/API/USIM/usim_api.h
at the begining:
/*
* Subscriber authentication security key
*/
#define USIM_API_K_SIZE 16
#define USIM_API_K_VALUE "fec86ba6eb707ed08905757b1bb44b8f"
The USIM_API_K_VALUE is updated in the users table of the HSS database.
This is done using phpMyAdmin or using mysql cli (command line interface).
On the HSS (machine) in the users table:
- Option 1: Change it using phpMyAdmin
- Edit row with imsi value equal to
208930100001111 - Change its key column with the USIM_API_K_VALUE as
x'fec86ba6eb707ed08905757b1bb44b8f'
- Edit row with imsi value equal to
- Option 2: Change it using mysql command line
mysql -u root -puse oai_dbUPDATE users SET users.key= x'fec86ba6eb707ed08905757b1bb44b8f' WHERE imsi = 208930100001111;
Run the simulation sequentially: SPGW ➡️ HSS ➡️ MME ➡️ (eNB + UE)
- SPGW:
cd ~/openair-cn/SCRIPTS./run_spgw
- HSS:
cd ~/openair-cn/SCRIPTS./run_hss
- MME:
cd ~/openair-cn/SCRIPTS./run_mme
- eNB + UE:
cd ~/openairinterface5g/cmake_targets/toolssudo -E ./run_enb_ue_virt_s1
Ginés García Avilés website
Carlos Donato Morales website
Kiril Antevski website