From 20d6c55f2f4c763d29b0ac5630652cd0273fe873 Mon Sep 17 00:00:00 2001
From: sagar arora <sagar.arora@eurecom.fr>
Date: Mon, 30 May 2022 13:50:29 +0200
Subject: [PATCH] Updated some old values
---
charts/oai-5g-core/oai-smf/values.yaml | 6 +--
.../DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md | 14 ++---
docs/DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md | 14 ++---
docs/DEPLOY_SA5G_WITH_My5g-RANTester.md | 42 +++++++--------
docs/RETRIEVE_OFFICIAL_IMAGES.md | 52 +++++++++----------
5 files changed, 62 insertions(+), 66 deletions(-)
diff --git a/charts/oai-5g-core/oai-smf/values.yaml b/charts/oai-5g-core/oai-smf/values.yaml
index 34c778a4..ecd1ac78 100644
--- a/charts/oai-5g-core/oai-smf/values.yaml
+++ b/charts/oai-5g-core/oai-smf/values.yaml
@@ -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:
diff --git a/docs/DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md b/docs/DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md
index 2b5b16ae..947e7842 100644
--- a/docs/DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md
+++ b/docs/DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md
@@ -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**.
diff --git a/docs/DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md b/docs/DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md
index 63bc72f0..704d456e 100644
--- a/docs/DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md
+++ b/docs/DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md
@@ -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 scenario execution
+### Analysing scenario execution ###
Using wireshark, open `5gcn-mini-deployment-nrf.pcap` and use the filter `ngap || http || pfcp || gtp`
diff --git a/docs/DEPLOY_SA5G_WITH_My5g-RANTester.md b/docs/DEPLOY_SA5G_WITH_My5g-RANTester.md
index 83b0efd7..aa8ac211 100644
--- a/docs/DEPLOY_SA5G_WITH_My5g-RANTester.md
+++ b/docs/DEPLOY_SA5G_WITH_My5g-RANTester.md
@@ -33,17 +33,17 @@ Note: In case readers are interested in deploying debuggers/developers core netw
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 |
+* In this demo the image tags which were used are listed below, follow the [Building images](./BUILD_IMAGES.md) to build images with below tags. When pulling images of network functions from dockerhub pull images for `develop` tag
+
+| CNF Name | Branch Name | Ubuntu 18.04 | RHEL8 (UBI8) |
+| ----------- | ----------- | ------------ | ----------------|
+| AMF | `develop` | X | X |
+| SMF | `develop` | X | X |
+| NRF | `develop` | X | X |
+| VPP-UPF | `develop` | X | X |
+| UDR | `develop` | X | X |
+| UDM | `develop` | X | X |
+| AUSF | `develop` | X | X |
<br/>
@@ -139,7 +139,7 @@ vpp-upf /openair-upf/bin/entrypoin ... Up (healthy) 2152/udp, 8085/udp
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).
-## 6. Building a `My5g-RANTester` docker image ##
+## 6. Building a `My5g-RANTester` docker image
* Pull pre-built docker image
``` console
docker-compose-host $: docker pull rohankharade/my5grantester:latest
@@ -155,7 +155,7 @@ docker-compose-host $: cd my5G-RANTester/
docker-compose-host $: docker build -f docker/Dockerfile --target my5grantester --tag my5grantester:latest .
```
-## 7. Executing the `My5g-RANTester` Scenario
+## 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-my5grantester-vpp.yaml](../docker-compose/docker-compose-my5grantester-vpp.yaml) and one can modify it for test.
* Launch my5G-RANTester docker service
@@ -176,7 +176,7 @@ Creating my5grantester ... done
<!---
For CI purposes please ignore this line
``` shell
-docker-compose-host $: sleep 10
+docker-compose-host $: sleep 15
```
-->
@@ -266,7 +266,7 @@ my5grantester | time="2022-05-11T21:59:30Z" level=info msg="[UE][NAS] Receivi
my5grantester | time="2022-05-11T21:59:30Z" level=info msg="[UE][DATA] UE is ready for using data plane"
```
-## Traffic test
+## Traffic test
UL Test ->
``` shell
docker-compose-host $: docker exec my5grantester ping -c4 -I uetun1 192.168.73.135
@@ -292,7 +292,7 @@ PING 12.1.1.2 (12.1.1.2) 56(84) bytes of data.
3 packets transmitted, 3 received, 0% packet loss, time 2010ms
rtt min/avg/max/mdev = 0.467/0.670/1.013/0.244 ms
```
-## Multiple UEs registration test ##
+## Multiple UEs registration test
Load-test with UEs in queue*:
* Update value in the [docker-compose-my5grantester-vpp.yaml](../docker-compose/docker-compose-my5grantester-vpp.yaml)
``` console
@@ -325,7 +325,7 @@ docker-compose-host $: docker logs oai-amf
```
-## Recover the logs
+## Recover the logs
``` shell
docker-compose-host $: docker logs oai-amf > /tmp/oai/vpp-upf-my5g/amf.log 2>&1
@@ -338,7 +338,7 @@ docker-compose-host $: docker logs oai-ausf > /tmp/oai/vpp-upf-my5g/ausf.log 2>&
docker-compose-host $: docker logs my5grantester > /tmp/oai/vpp-upf-my5g/my5grantester.log 2>&1
```
-## 8. Analysing the Scenario Results
+## 8. Analysing the Scenario Results
| Pcap/log files |
|:------------------------------------------------------------------------------------------ |
@@ -347,7 +347,7 @@ docker-compose-host $: docker logs my5grantester > /tmp/oai/vpp-upf-my5g/my5gran
* For detailed analysis of messages, please refer previous tutorial of [testing with dsTester](./docs/DEPLOY_SA5G_WITH_DS_TESTER.md).
-## 9. Undeploy
+## 9. Undeploy
Last thing is to remove all services - <br/>
@@ -372,6 +372,4 @@ Stopping vpp-upf ...
Stopping oai-udr ...
Stopping mysql ...
Stopping oai-nrf ...
-```
-
-
+```
\ No newline at end of file
diff --git a/docs/RETRIEVE_OFFICIAL_IMAGES.md b/docs/RETRIEVE_OFFICIAL_IMAGES.md
index 6f09d737..f577a656 100644
--- a/docs/RETRIEVE_OFFICIAL_IMAGES.md
+++ b/docs/RETRIEVE_OFFICIAL_IMAGES.md
@@ -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 |
--
GitLab