Tutorial free5gc v3.0.6

Prerequisites

GTP5G kernel module

Due to the UPF issue, it should contain gtp5g kernel module with kernel version 5.4.90-050490-generic.

On you host OS before running containers execute:

git clone -b v0.4.0 https://github.com/free5gc/gtp5g.git
cd gtp5g
make
sudo make install

Docker engine

To install docker on your favorite OS, you can follow instruction here: https://docs.docker.com/engine/install

Docker compose

You also need to install docker compose as detailed here: https://docs.docker.com/compose/install/

1- First builds the images of free5gcore v3.0.6:

https://github.com/my5G/free5gc-docker-v3.0.6.git
cd free5gc-docker-v3.0.6/
make base
docker-compose build

2- To execute the free5GC v3.0.6 in docker, use the docker-compose and command below:

free5gc-docker-v3.0.6$ docker-compose up -d

4- Check if all containers are healthy using the command below:

docker ps -a

5- Register a UE information in http://<host_IP>:5000 (WEB UI) using the parameters set in tester.yaml. Credentials for acessing WEB UI is shown below:

Username: admin
Password: free5gc

6- Building the my5G-RANTester image:

git clone https://github.com/my5G/free5gc-my5G-RANTester-docker
cd free5gc-my5G-RANTester-docker
docker build -f nf_tester/Dockerfile --tag my5grantester:latest .

7- Change the configuration in tester.yaml file to select the given test. For more information about the tests available here

8- Start Wireshark to capture any traffic with ngap || sctp || nas and visualize procedures for registration of UE

9- Execute the my5G-RANTester with robustness and conformance tests in the same directory of the item 6 (to connect with free5GC):

free5gc-my5G-RANTester-docker$ docker-compose up -d