Skip to content
Snippets Groups Projects
Commit 40d47f11 authored by Rohan's avatar Rohan Committed by Rohan
Browse files

Tutorial page added

parent a806a3c3
No related branches found
No related tags found
1 merge request!47My5grantester tutorial
Hide whitespace changes
Inline Side-by-side
docker-compose/docker-compose-my5grantester-vpp.yaml
+ 1
− 2
View file @ 40d47f11
version: '3.8'
services:
tester:
my5grantester:
image: my5grantester:latest
container_name: my5grantester
privileged: true
......@@ -9,7 +9,6 @@ services:
- ./my5grantester-vpp-config.yaml:/workspace/my5G-RANTester/config/config.yml
cap_add:
- NET_ADMIN
networks:
networks:
public_net:
ipv4_address: 192.168.70.143
......
docs/DEPLOY_HOME.md
+ 1
− 0
View file @ 40d47f11
......@@ -27,5 +27,6 @@ Welcome to the tutorial home page of OAI 5g Core project. Here you can find lot
- [Using Docker-Compose, perform a `basic` deployment and test with `OAI RF simulator`](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/ci-scripts/yaml_files/5g_rfsimulator)
- [Using Docker-Compose, perform a `basic` deployment and test with `UERANSIM`](./DEPLOY_SA5G_WITH_UERANSIM.md)
- [Using Docker-Compose, perform a `basic` deployment and test with `Network Slicing`](./DEPLOY_SA5G_SLICING.md)
- [Using Docker-Compose, perform a `basic` deployment and test with `My5g-RANTester`](./DEPLOY_SA5G_WITH_My5g-RANTester.md)
- The Developer Corner
- [How to Deploy Developers Core Network and Basic Debugging](./DEBUG_5G_CORE.md)
docs/DEPLOY_SA5G_WITH_My5g-RANTester.md 0 → 100644
+ 241
− 0
View file @ 40d47f11
<table style="border-collapse: collapse; border: none;">
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OpenAirInterface 5G Core Network Deployment and Testing with My5g-RANTester</font></b>
</td>
</tr>
</table>
![SA dsTest Demo](./images/5gcn_vpp_upf_my5G-RANTester.png)
**Reading time: ~ 30mins**
**Tutorial replication time: ~ 1h30mins**
Note: In case readers are interested in deploying debuggers/developers core network environment with more logs please follow [this tutorial](./DEBUG_5G_CORE.md)
**TABLE OF CONTENTS**
1. Pre-requisites
2. Building Container Images
3. Configuring Host Machines
4. Configuring OAI 5G Core Network Functions
5. Deploying OAI 5G Core Network
6. [Getting a `my5G-RANTester` docker image](#6-getting-a-my5G-RANTester-docker-image)
7. [Executing `my5G-RANTester` Scenario](#7-executing-the-my5G-RANTester-scenario)
8. [Analysing Scenario Results](#8-analysing-the-scenario-results)
9. [Trying some advanced stuff](#9-trying-some-advanced-stuff)
* In this demo the image tags and commits which were used are listed below, follow the [Building images](./BUILD_IMAGES.md) to build images with below tags.
| CNF Name | Branch Name | Tag | Ubuntu 18.04 | RHEL8 (UBI8) |
| ----------- | ----------- | -------- | ------------ | ----------------|
| AMF | `develop` | `v1.3.0` | X | X |
| SMF | `develop` | `v1.3.0` | X | X |
| NRF | `develop` | `v1.3.0` | X | X |
| VPP-UPF | `develop` | `v1.3.0` | X | X |
| UDR | `develop` | `v1.3.0` | X | X |
| UDM | `develop` | `v1.3.0` | X | X |
| AUSF | `develop` | `v1.3.0` | X | X |
<br/>
This tutorial is an extension of a previous tutorial: [testing a `basic` deployment with dsTester](./DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md). In previous tutorial, we have seen the advanced testing tool dsTester, which is useful for validating even more complex scenarios.
Moreover, there are various other opensource gnb/ue simulator tools that are available for SA5G test. In this tutorial, we use an opensource simulator tool called `My5g-RANTester`. With the help of `My5g-RANTester` tool, we can perform very basic SA5G test by simulating one gnb and multiple ues.
##### About My5g-RANTester -
[My5g-RANTester](https://github.com/my5G/my5G-RANTester) is the open-source state-of-the-art 5G UE and RAN (gNodeB) implementation. It can be considered as a 5G mobile phone and a base station in basic terms. The project can be used for testing 5G Core Network and studying 5G System. My5g-RANTester can simulate multiple UEs and it also aims to simulate radio. Moreover for detailed feature set, please refer its [official page.](https://github.com/my5G/my5G-RANTester/wiki/Feature-Set)
Let's begin !!
* Steps 1 to 5 are similar as previous [tutorial on vpp-upf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed/-/blob/master/docs/DEPLOY_SA5G_WITH_VPP_UPF.md#5-deploying-oai-5g-core-network). Please follow these steps to deploy OAI 5G core network components.
* We deploy my5G-RANTester docker service on same host as of core network, so there is no need to create additional route as
we did for dsTest-host.
* Before we proceed further for end-to-end SA5G test, make sure you have healthy docker services for OAI cn5g
Then we follow deployment procedure as usual.
```bash
oai-cn5g-fed/docker-compose$ docker-compose -f docker-compose-basic-vpp-nrf.yaml up -d
Creating mysql ... done
Creating oai-nrf ... done
Creating vpp-upf ... done
Creating oai-udr ... done
Creating oai-udm ... done
Creating oai-ext-dn ... done
Creating oai-ausf ... done
Creating oai-amf ... done
Creating oai-smf ... done
```
More details in [section 5 of the `basic` vpp tutorial](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed/-/blob/master/docs/DEPLOY_SA5G_WITH_VPP_UPF.md#5-deploying-oai-5g-core-network).
After deploying core network, make sure all services are healthy.
```bash
oai-cn5g-fed/docker-compose$ docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
0c0f6920aedf oai-smf:latest "/bin/bash /openair-…" About a minute ago Up About a minute (healthy) 80/tcp, 9090/tcp, 8805/udp oai-smf
1eca41c99ceb oai-amf:latest "/bin/bash /openair-…" About a minute ago Up About a minute (healthy) 80/tcp, 9090/tcp, 38412/sctp oai-amf
96956aa69cf8 oai-ausf:latest "/bin/bash /openair-…" About a minute ago Up About a minute (healthy) 80/tcp oai-ausf
7c0c07f63ad6 ubuntu:bionic "/bin/bash -c ' apt …" About a minute ago Up About a minute oai-ext-dn
daa71ea02f62 oai-udm:latest "/bin/bash /openair-…" About a minute ago Up About a minute (healthy) 80/tcp oai-udm
9afe69c737d9 oai-udr:latest "/bin/bash /openair-…" About a minute ago Up About a minute (healthy) 80/tcp oai-udr
6faa329c97f9 oai-upf-vpp:latest "/openair-upf/bin/en…" About a minute ago Up About a minute (healthy) 2152/udp, 8085/udp vpp-upf
8cf8bcb54725 mysql:5.7 "docker-entrypoint.s…" About a minute ago Up About a minute (healthy) 3306/tcp, 33060/tcp mysql
8e8037f2aadb oai-nrf:latest "/bin/bash /openair-…" About a minute ago Up About a minute (healthy) 80/tcp, 9090/tcp oai-nrf
```
## 6. Building a `My5g-RANTester` docker image ##
You have the choice:
* Build `My5g-RANTester` docker image
```bash
$ git clone https://github.com/my5G/my5G-RANTester-docker.git
$ cd my5G-RANTester-docker/nf_tester
$ docker build --tag my5grantester:latest -f Dockerfile .
```
## 7. Executing the `My5g-RANTester` Scenario ##
* The configuration parameters, are preconfigured in [docker-compose-basic-vpp-nrf.yaml](../docker-compose/docker-compose-basic-vpp-nrf.yaml) and [docker-compose.yaml OF My5g-RANTester](../docker-compose/docker-compose-my5G-RANTester-vpp.yaml) and one can modify it for test.
* Launch my5G-RANTester docker service
```bash
oai-cn5g-fed/docker-compose$ docker-compose -f docker-compose-my5grantester-vpp.yaml -d
Creating my5grantester ... done
```
* After launching My5g-RANTester, make sure all services status are healthy -
```bash
oai-cn5g-fed/docker-compose$ docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
a2b7991149db my5grantester:latest "./app ue" 30 seconds ago Up 28 seconds my5grantester
0c0f6920aedf oai-smf:latest "/bin/bash /openair-…" 2 minutes ago Up 2 minutes (healthy) 80/tcp, 9090/tcp, 8805/udp oai-smf
1eca41c99ceb oai-amf:latest "/bin/bash /openair-…" 2 minutes ago Up 2 minutes (healthy) 80/tcp, 9090/tcp, 38412/sctp oai-amf
96956aa69cf8 oai-ausf:latest "/bin/bash /openair-…" 2 minutes ago Up 2 minutes (healthy) 80/tcp oai-ausf
7c0c07f63ad6 ubuntu:bionic "/bin/bash -c ' apt …" 2 minutes ago Up 2 minutes oai-ext-dn
daa71ea02f62 oai-udm:latest "/bin/bash /openair-…" 2 minutes ago Up 2 minutes (healthy) 80/tcp oai-udm
9afe69c737d9 oai-udr:latest "/bin/bash /openair-…" 2 minutes ago Up 2 minutes (healthy) 80/tcp oai-udr
6faa329c97f9 oai-upf-vpp:latest "/openair-upf/bin/en…" 2 minutes ago Up 2 minutes (healthy) 2152/udp, 8085/udp vpp-upf
8cf8bcb54725 mysql:5.7 "docker-entrypoint.s…" 2 minutes ago Up 2 minutes (healthy) 3306/tcp, 33060/tcp mysql
8e8037f2aadb oai-nrf:latest "/bin/bash /openair-…" 2 minutes ago Up 2 minutes (healthy) 80/tcp, 9090/tcp oai-nrf
```
We can verify it using my5grantester container logs as below -
```bash
$ docker logs my5G-RANTester
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="my5G-RANTester version 0.1"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg=---------------------------------------
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[TESTER] Starting test function: Testing an ue attached with configuration"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[TESTER][UE] Number of UEs: 1"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[TESTER][GNB] Control interface IP/Port: 192.168.70.143/9487"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[TESTER][GNB] Data interface IP/Port: 192.168.72.143/2152"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[TESTER][AMF] AMF IP/Port: 192.168.70.132/38412"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg=---------------------------------------
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB] SCTP/NGAP service is running"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB] UNIX/NAS service is running"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB][SCTP] Receive message in 0 stream\n"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB][NGAP] Receive Ng Setup Response"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB][AMF] AMF Name: OAI-AMF"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB][AMF] State of AMF: Active"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB][AMF] Capacity of AMF: 30"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB][AMF] PLMNs Identities Supported by AMF -- mcc: 208 mnc:95"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB][AMF] List of AMF slices Supported by AMF -- sst:04 sd:000000"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB][AMF] List of AMF slices Supported by AMF -- sst:de sd:000000"
my5grantester | time="2022-03-08T15:09:21Z" level=info msg="[GNB][AMF] List of AMF slices Supported by AMF -- sst:01 sd:000001"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE] UNIX/NAS service is running"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][SCTP] Receive message in 0 stream\n"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP] Receive Downlink NAS Transport"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Message without security header"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Receive Authentication Request"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS][MAC] Authenticity of the authentication request message: OK"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS][SQN] SQN of the authentication request message: VALID"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Send authentication response"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][SCTP] Receive message in 0 stream\n"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP] Receive Downlink NAS Transport"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Message with security header"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Message with integrity and with NEW 5G NAS SECURITY CONTEXT"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] successful NAS MAC verification"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Receive Security Mode Command"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Type of ciphering algorithm is 5G-EA0"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Type of integrity protection algorithm is 128-5G-IA2"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][SCTP] Receive message in 0 stream\n"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP] Receive Initial Context Setup Request"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][UE] UE Context was created with successful"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][UE] UE RAN ID 1"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][UE] UE AMF ID 1"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][UE] UE Mobility Restrict --Plmn-- Mcc: not informed Mnc: not informed"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][UE] UE Masked Imeisv: "
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][UE] Allowed Nssai-- Sst: de Sd: 00007b"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NAS][UE] Send Registration Accept."
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][AMF] Send Initial Context Setup Response."
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Message with security header"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Message with integrity and ciphered"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] successful NAS MAC verification"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] successful NAS CIPHERING"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Receive Registration Accept"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] UE 5G GUTI: [0 0 0 1]"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][SCTP] Receive message in 0 stream\n"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP] Receive PDU Session Resource Setup Request"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] PDU Session was created with successful."
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] PDU Session Id: 1"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] NSSAI Selected --- sst: de sd: 00007b"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] PDU Session Type: ipv4"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] QOS Flow Identifier: 6"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] Uplink Teid: 233118799"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] Downlink Teid: 1"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] Non-Dynamic-5QI: 6"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] Priority Level ARP: 1"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[GNB][NGAP][UE] UPF Address: 192.168.72.202 :2152"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Message with security header"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Message with integrity and ciphered"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] successful NAS MAC verification"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] successful NAS CIPHERING"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Receive DL NAS Transport"
my5grantester | time="2022-03-08T15:09:22Z" level=info msg="[UE][NAS] Receiving PDU Session Establishment Accept"
my5grantester | time="2022-03-08T15:09:27Z" level=info msg="[UE][DATA] UE is ready for using data plane"
```
// ToDo: Now we are ready to perform some traffic test.
## 8. Analysing the Scenario Results ##
| Pcap/log files |
|:------------------------------------------------------------------------------------------ |
| [5gcn-deployment-my5G-RANTester.pcap](./results/My5g-RANTester/pcap/5gcn-deployment-my5G-RANTester.pcap) |
* For detailed analysis of messages, please refer previous tutorial of [testing with dsTester](./docs/DEPLOY_SA5G_WITH_DS_TESTER.md).
## 10. Undeploy ##
Last thing is to remove all services - <br/>
* Undeploy the My5g-RANTester
```bash
oai-cn5g-fed/docker-compose$ docker-compose -f docker-compose-my5G-RANTester-vpp.yaml down
Stopping my5grantester ... done
Removing my5grantester ... done
Network demo-oai-public-net is external, skipping
Network oai-public-access is external, skipping
```
* Undeploy the core network
```bash
oai-cn5g-fed/docker-compose$ python3 ./core-network.py --type stop-basic-vpp --fqdn no --scenario 1
...
[2021-09-14 16:47:44,070] root:DEBUG: OAI 5G core components are UnDeployed....
```
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment