Skip to content
Snippets Groups Projects
Commit c38f5426 authored by Sagar Arora's avatar Sagar Arora :bicyclist_tone1:
Browse files

Merge branch 'my5grantester_tutorial' into 'master' 

My5grantester tutorial

See merge request !47
parents 76444a38 20d6c55f
No related branches found
No related tags found
1 merge request!47My5grantester tutorial
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 468 additions and 51 deletions
charts/oai-5g-core/oai-smf/values.yaml
+ 3
− 3
View file @ c38f5426
......@@ -56,9 +56,9 @@ start:
multus:
create: false
n1IPadd: "172.21.10.101"
n1Netmask: "22"
n1Gateway: "172.21.11.254"
n4IPadd: "172.21.10.101"
n4Netmask: "22"
n4Gateway: "172.21.11.254"
hostInterface: "ens2f0np0" # Interface of the host machine on which this pod will be scheduled
config:
......
docker-compose/docker-compose-basic-nrf.yaml
+ 2
− 2
View file @ c38f5426
......@@ -188,7 +188,7 @@ services:
- NRF_PORT=80
- EXTERNAL_NRF=yes
- NF_REGISTRATION=yes
- SMF_SELECTION=yes
- SMF_SELECTION=no
- USE_FQDN_DNS=yes
- EXTERNAL_AUSF=yes
- NRF_API_VERSION=v1
......@@ -242,7 +242,7 @@ services:
- NRF_IPV4_ADDRESS=192.168.70.130
- NRF_PORT=80
- NRF_API_VERSION=v1
- USE_LOCAL_SUBSCRIPTION_INFO=yes
- USE_LOCAL_SUBSCRIPTION_INFO=no
- NRF_FQDN=oai-nrf
- REGISTER_NRF=yes
- DISCOVER_UPF=yes
......
docker-compose/docker-compose-basic-vpp-nrf.yaml
+ 5
− 5
View file @ c38f5426
......@@ -37,7 +37,7 @@ services:
- MYSQL_PASS=test
- MYSQL_DB=oai_db
- WAIT_MYSQL=120
- USE_FQDN_DNS=yes
- USE_FQDN_DNS=no
- REGISTER_NRF=yes
- NRF_IPV4_ADDRESS=192.168.70.130
- NRF_PORT=80
......@@ -67,7 +67,7 @@ services:
- SBI_IF_NAME=eth0
- SBI_PORT=80
- UDM_VERSION_NB=v1
- USE_FQDN_DNS=yes
- USE_FQDN_DNS=no
- UDR_IP_ADDRESS=192.168.70.136
- UDR_PORT=80
- UDR_VERSION_NB=v1
......@@ -99,7 +99,7 @@ services:
- AUSF_NAME=OAI_AUSF
- SBI_IF_NAME=eth0
- SBI_PORT=80
- USE_FQDN_DNS=yes
- USE_FQDN_DNS=no
- UDM_IP_ADDRESS=192.168.70.137
- UDM_PORT=80
- UDM_VERSION_NB=v1
......@@ -189,7 +189,7 @@ services:
- EXTERNAL_NRF=yes
- NF_REGISTRATION=yes
- SMF_SELECTION=yes
- USE_FQDN_DNS=yes
- USE_FQDN_DNS=no
- EXTERNAL_AUSF=yes
- NRF_API_VERSION=v1
- NRF_FQDN=oai-nrf
......@@ -246,7 +246,7 @@ services:
- NRF_FQDN=oai-nrf
- REGISTER_NRF=yes
- DISCOVER_UPF=yes
- USE_FQDN_DNS=yes
- USE_FQDN_DNS=no
- USE_NETWORK_INSTANCE=yes
- DNN_RANGE1=12.1.1.2 - 12.1.1.128
- DNN_RANGE0=12.2.1.2 - 12.2.1.128
......
docker-compose/docker-compose-my5grantester-vpp.yaml 0 → 100644
+ 43
− 0
View file @ c38f5426
version: '3.8'
services:
my5grantester:
image: my5grantester:latest
container_name: my5grantester
privileged: true
environment:
NGAP_LOCAL_ADDR: 192.168.70.143
NGAP_REMOTE_ADDR: 192.168.70.132
GTPU_LOCAL_ADDR: 192.168.72.143
MCC: 208
MNC: 95
TAC: 00a000
GNBID: "000003"
SST_GNB: de
SST_UE: 222
SD: "00007b"
MSIN: "0000000031"
OPC: 63bfa50ee6523365ff14c1f45f88737d
KEY: 0C0A34601D4F07677303652C0462535B
AMF: 8000
SQN: 0000000
DNN: default
NUM_UE: 1
cap_add:
- NET_ADMIN
networks:
public_net:
ipv4_address: 192.168.70.143
public_net_access:
ipv4_address: 192.168.72.143
healthcheck:
test: /bin/bash -c "ip addr | grep uetun1"
interval: 10s
timeout: 5s
retries: 5
networks:
public_net:
external:
name: demo-oai-public-net
public_net_access:
external:
name: oai-public-access
docs/DEPLOY_HOME.md
+ 1
− 0
View file @ c38f5426
......@@ -27,6 +27,7 @@ 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)
- [Using Docker-Compose, when testing with Commercial UE, troubleshoot traffic issues](./TROUBLESHOOT_COTS_UE_TRAFFIC.md)
- The Developer Corner
- [How to Deploy Developers Core Network and Basic Debugging](./DEBUG_5G_CORE.md)
docs/DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md
+ 7
− 7
View file @ c38f5426
......@@ -104,13 +104,13 @@ To know how to configure the machine with the above requirements vist [pre-requi
| CNF Name | Branch Name | Tag | Ubuntu 18.04 | RHEL8 (UBI8) |
| ----------- | ----------- | -------- | ------------ | ----------------|
| AMF | `master` | `v1.2.0` | X | X |
| SMF | `master` | `v1.2.0` | X | X |
| NRF | `master` | `v1.2.0` | X | X |
| SPGW-U-TINY | `master` | `v1.1.3` | X | X |
| UDR | `master` | `v1.2.0` | X | X |
| UDM | `master` | `v1.2.0` | X | X |
| AUSF | `master` | `v1.2.0` | X | X |
| AMF | `master` | `v1.3.0` | X | X |
| SMF | `master` | `v1.3.0` | X | X |
| NRF | `master` | `v1.3.0` | X | X |
| SPGW-U-TINY | `master` | `v1.2.0` | X | X |
| UDR | `master` | `v1.3.0` | X | X |
| UDM | `master` | `v1.3.0` | X | X |
| AUSF | `master` | `v1.3.0` | X | X |
- In case readers are interested in making images using different branch then **they have to build images from scratch they can't use the docker-hub images**.
......
docs/DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md
+ 7
− 7
View file @ c38f5426
......@@ -104,9 +104,9 @@ To know how to configure the machine with the above requirements vist [pre-requi
| CNF Name | Branch Name | Tag | Ubuntu 18.04 | RHEL8 (UBI8) |
| ----------- | ----------- | -------- | ------------ | ----------------|
| AMF | `master` | `v1.2.0` | X | X |
| SMF | `master` | `v1.2.0` | X | X |
| NRF | `master` | `v1.2.0` | X | X |
| AMF | `master` | `v1.3.0` | X | X |
| SMF | `master` | `v1.3.0` | X | X |
| NRF | `master` | `v1.3.0` | X | X |
| SPGW-U-TINY | `master` | `v1.1.3` | X | X |
- In case readers are interested in making images using different branch then **they have to build images from scratch they can't use the docker-hub images**.
......@@ -122,7 +122,7 @@ There are two ways to create this bridge either manually or automatically using
**NOTE** This tutorial needs that the bridge is created manually to analyse NRF packet exchange.
### 4.1 Creating bridge manually
### 4.1 Creating bridge manually ###
Since this is not the `default` behavior, you **SHALL** edit the docker-compose file.
......@@ -165,7 +165,7 @@ Since this is not the `default` behavior, you **SHALL** edit the docker-compose
455631b3749c demo-oai-public-net bridge local
```
### 4.2 Create bridge automatically
### 4.2 Create bridge automatically ###
- Though the bridge can be automatically created using docker-compose file if there is no need to capture initial packets.
......@@ -188,7 +188,7 @@ The bottom section SHALL look like this:
com.docker.network.bridge.name: "demo-oai"
```
### 4.3 In case you forgot. True for manual or automatic network creation.
### 4.3 In case you forgot. True for manual or automatic network creation. ###
- If the `docker-compose-host` machine is not configured with packet forwarding then it can be done using below command (**important step**),
......@@ -453,7 +453,7 @@ Using wireshark, open `5gcn-mini-deployment-nrf.pcap` and use the filter `http |
![Analysing initial message exchange](./images/docker-compose/start.png)
### Analysing scenario execution
### Analysing scenario execution ###
Using wireshark, open `5gcn-mini-deployment-nrf.pcap` and use the filter `ngap || http || pfcp || gtp`
......
docs/DEPLOY_SA5G_WITH_My5g-RANTester.md 0 → 100644
+ 375
− 0
View file @ c38f5426
This diff is collapsed.
docs/RETRIEVE_OFFICIAL_IMAGES.md
+ 25
− 27
View file @ c38f5426
......@@ -16,13 +16,11 @@ This page is only valid for an `Ubuntu18` host.
If you are using any other distributions, please refer to [Build your own images](./BUILD_IMAGES.md).
If you want to the up-to-date new features, please refer to [Build your own images](./BUILD_IMAGES.md).
If you want to use a specific branch or commit, please refer to [Build your own images](./BUILD_IMAGES.md).
# Pulling the images from Docker Hub #
Currently the images are hosted under the user account `rdefosseoai`.
This may change in the future.
The images are hosted under the oai account `oaisoftwarealliance`.
Once again you may need to log on [docker-hub](https://hub.docker.com/) if your organization has reached pulling limit as `anonymous`.
......@@ -33,39 +31,39 @@ Username:
Password:
```
The OAI CI/CD team has automated more frequent pushes to Docker-Hub on `rdefosseoai` account. Two important things to be noted:
The OAI CI/CD team has automated more frequent pushes to Docker-Hub on `oaisoftwarealliance` account. Two important things to be noted:
- We will keep pushing to the `latest` tag when a milestone is reached.
- We are making pushes on the `develop` tag whenever a contribution has been accepted. These images are **EXPERIMENTAL**.
Now pull images.
Now pull images according to your requirement,
```bash
$ docker pull rdefosseoai/oai-amf:latest
$ docker pull rdefosseoai/oai-nrf:latest
$ docker pull rdefosseoai/oai-spgwu-tiny:latest
$ docker pull rdefosseoai/oai-smf:latest
$ docker pull rdefosseoai/oai-udr:latest
$ docker pull rdefosseoai/oai-udm:latest
$ docker pull rdefosseoai/oai-ausf:latest
$ docker pull rdefosseoai/oai-upf-vpp:latest
$ docker pull rdefosseoai/oai-nssf:latest
$ docker pull oaisoftwarealliance/oai-amf:latest
$ docker pull oaisoftwarealliance/oai-nrf:latest
$ docker pull oaisoftwarealliance/oai-spgwu-tiny:latest
$ docker pull oaisoftwarealliance/oai-smf:latest
$ docker pull oaisoftwarealliance/oai-udr:latest
$ docker pull oaisoftwarealliance/oai-udm:latest
$ docker pull oaisoftwarealliance/oai-ausf:latest
$ docker pull oaisoftwarealliance/oai-upf-vpp:latest
$ docker pull oaisoftwarealliance/oai-nssf:latest
# Utility image to generate traffic
$ docker pull rdefosseoai/trf-gen-cn5g:latest
$ docker pull oaisoftwarealliance/trf-gen-cn5g:latest
```
And **re-tag** them for tutorials' docker-compose file to work.
```bash
$ docker image tag rdefosseoai/oai-amf:latest oai-amf:latest
$ docker image tag rdefosseoai/oai-nrf:latest oai-nrf:latest
$ docker image tag rdefosseoai/oai-smf:latest oai-smf:latest
$ docker image tag rdefosseoai/oai-spgwu-tiny:latest oai-spgwu-tiny:latest
$ docker image tag rdefosseoai/oai-udr:latest oai-udr:latest
$ docker image tag rdefosseoai/oai-udm:latest oai-udm:latest
$ docker image tag rdefosseoai/oai-ausf:latest oai-ausf:latest
$ docker image tag rdefosseoai/oai-upf-vpp:latest oai-upf-vpp:latest
$ docker image tag rdefosseoai/oai-nssf:latest oai-nssf:latest
$ docker image tag rdefosseoai/trf-gen-cn5g:latest trf-gen-cn5g:latest
$ docker image tag oaisoftwarealliance/oai-amf:latest oai-amf:latest
$ docker image tag oaisoftwarealliance/oai-nrf:latest oai-nrf:latest
$ docker image tag oaisoftwarealliance/oai-smf:latest oai-smf:latest
$ docker image tag oaisoftwarealliance/oai-spgwu-tiny:latest oai-spgwu-tiny:latest
$ docker image tag oaisoftwarealliance/oai-udr:latest oai-udr:latest
$ docker image tag oaisoftwarealliance/oai-udm:latest oai-udm:latest
$ docker image tag oaisoftwarealliance/oai-ausf:latest oai-ausf:latest
$ docker image tag oaisoftwarealliance/oai-upf-vpp:latest oai-upf-vpp:latest
$ docker image tag oaisoftwarealliance/oai-nssf:latest oai-nssf:latest
$ docker image tag oaisoftwarealliance/trf-gen-cn5g:latest trf-gen-cn5g:latest
```
Finally you may logoff --> your token is stored in plain text..
......@@ -90,7 +88,7 @@ This repository only has tutorials and Continuous Integration scripts.
| AMF | `master` | `v1.3.0` | X | X |
| SMF | `master` | `v1.3.0` | X | X |
| NRF | `master` | `v1.3.0` | X | X |
| SPGW-U-TINY | `master` | `v1.1.5` | X | X |
| SPGW-U-TINY | `master` | `v1.2.0` | X | X |
| UDR | `master` | `v1.3.0` | X | X |
| UDM | `master` | `v1.3.0` | X | X |
| AUSF | `master` | `v1.3.0` | X | X |
......
docs/images/5gcn_vpp_upf_my5grantester.png 0 → 100644
+ 0
− 0
View file @ c38f5426
docs/images/5gcn_vpp_upf_my5grantester.png

77.4 KiB

docs/results/My5g-RANTester/5gcn-deployment-my5grantester.pcap 0 → 100755
+ 0
− 0
View file @ c38f5426
File added
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