Skip to content
Snippets Groups Projects
Commit 81a0f261 authored by Raphael Defosseux's avatar Raphael Defosseux
Browse files

doc(tutorial): apply review comment from sagar 


Signed-off-by: default avatarRaphael Defosseux <raphael.defosseux@eurecom.fr>
parent a1bcbe11
No related branches found
No related tags found
1 merge request!22Updated the tutorials
Hide whitespace changes
Inline Side-by-side
docs/CONFIGURE_CONTAINERS.md
+ 8
− 8
View file @ 81a0f261
......@@ -24,13 +24,13 @@
| File Name | Repository | Location |
|:----------- |:-------------------------------------------- |:--------------- |
| amf.conf | (Gitlab) cn5g/oai-cn5g-amf | [etc/amf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf/-/blob/develop/etc/amf.conf) |
| smf.conf | (Gitlab) cn5g/oai-cn5g-smf | [etc/smf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-smf/-/blob/develop/etc/smf.conf) |
| nrf.conf | (Gitlab) cn5g/oai-cn5g-nrf | [etc/nrf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-nrf/-/blob/develop/etc/nrf.conf) |
| spgw_u.conf | (Github) OPENAIRINTERFACE/openair-spgwu-tiny | [etc/spgw_u.conf](https://github.com/OPENAIRINTERFACE/openair-spgwu-tiny/blob/develop/etc/spgw_u.conf) |
| udr.conf | (Gitlab) cn5g/oai-cn5g-udr | [etc/udr.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udr/-/blob/develop/etc/udr.conf) |
| udm.conf | (Gitlab) cn5g/oai-cn5g-udm | [etc/udm.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udm/-/blob/develop/etc/udm.conf) |
| ausf.conf | (Gitlab) cn5g/oai-cn5g-ausf | [etc/ausf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-ausf/-/blob/develop/etc/ausf.conf) |
| amf.conf | (Gitlab) cn5g/oai-cn5g-amf | [etc/amf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf/-/blob/master/etc/amf.conf) |
| smf.conf | (Gitlab) cn5g/oai-cn5g-smf | [etc/smf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-smf/-/blob/master/etc/smf.conf) |
| nrf.conf | (Gitlab) cn5g/oai-cn5g-nrf | [etc/nrf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-nrf/-/blob/master/etc/nrf.conf) |
| spgw_u.conf | (Github) OPENAIRINTERFACE/openair-spgwu-tiny | [etc/spgw_u.conf](https://github.com/OPENAIRINTERFACE/openair-spgwu-tiny/blob/master/etc/spgw_u.conf) |
| udr.conf | (Gitlab) cn5g/oai-cn5g-udr | [etc/udr.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udr/-/blob/master/etc/udr.conf) |
| udm.conf | (Gitlab) cn5g/oai-cn5g-udm | [etc/udm.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udm/-/blob/master/etc/udm.conf) |
| ausf.conf | (Gitlab) cn5g/oai-cn5g-ausf | [etc/ausf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-ausf/-/blob/master/etc/ausf.conf) |
- The PLMN, TAC, Operator Key should be properly configured in amf.conf according to gNB and UE
- In case of a **COTS UE** by default there are two PDN sessions so check the smf.conf to configure the right names for the IMS. Currently some parameters can not be configured via docker-compose.yaml. We recommend you directly configure them in the conf file and mount the file in the docker during run time.
......@@ -117,6 +117,6 @@
Please don't deploy yet!
- If you want to deploy a `mini` OAI 5GCN, checkout this [mini-deployment tutorial](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md).
- If you want to deploy a `minimalist` OAI 5GCN, checkout this [minimalist-deployment tutorial](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md).
- If you want to deploy a `basic` OAI 5GCN, checkout this [basic-deployment tutorial](./DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md).
docs/DEPLOY_HOME.md
+ 5
− 3
View file @ 81a0f261
......@@ -16,9 +16,11 @@ Welcome to the tutorial home page of OAI 5g Core project. Here you can find lot
- [Build the container images](./BUILD_IMAGES.md)
- [Configuring the Containers](./CONFIGURE_CONTAINERS.md)
- 5G Core Network Deployment
- [Using Docker-Compose, perform a mini deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md)
- [Using Docker-Compose, perform a basic deployment](./DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md)
- [Using Docker-Compose, perform a basic deployment with FQDN feature](./DEPLOY_SA5G_BASIC_FQDN_DEPLOYMENT.md)
- [Using Docker-Compose, perform a `minimalist` deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md)
- [Using Docker-Compose, perform a `basic` deployment](./DEPLOY_SA5G_BASIC_DS_TESTER_DEPLOYMENT.md)
- [Using Docker-Compose, perform a `basic` deployment with FQDN feature](./DEPLOY_SA5G_BASIC_FQDN_DEPLOYMENT.md)
- [Using Helm Chart](./DEPLOY_SA5G_HC.md)
- [Using Virtual Machine, deploy and test with a Commercial UE](./DEPLOY_SA5G_VM_COTSUE.md)
- [Using Docker-Compose, perform a `minimalist` deployment and test with `gnbsim`](./DEPLOY_SA5G_WITH_GNBSIM.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
+ 10
− 15
View file @ 81a0f261
......@@ -51,11 +51,6 @@ The Basic functional 5g core network can be deployed into 2 scenarios:
- Scenario I: AMF, SMF, UPF (SPGWU), NRF, UDM, UDR, AUSF, MYSQL
- Scenario II: AMF, SMF, UPF (SPGWU), UDM, UDR, AUSF, MYSQL
`Scenario II` is not using the `NRF` component:
* Services can no more be identified using `FQDN`
* They shall be identified using hard-coded IP addresses
## 2. Pre-requisites ##
The container images are built using `docker build` command on Ubuntu 18.04 host machine. The base image for all the containers is Ubuntu 18.04.
......@@ -121,7 +116,7 @@ To know how to configure the machine with the above requirements vist [pre-requi
## 4. Configuring Host Machines ##
This section is similar to the [Section 4 in the mini-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#4-configuring-host-machines).
This section is similar to the [Section 4 in the minimalist-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#4-configuring-host-machines).
## 5. Configuring the OAI-5G Core Network Functions ##
......@@ -131,22 +126,22 @@ The docker-compose file has configuration parameters of each core network compon
| File Name | Repository | Location |
|:----------- |:-------------------------------------------- |:--------------- |
| amf.conf | (Gitlab) cn5g/oai-cn5g-amf | [etc/amf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf/-/blob/develop/etc/amf.conf) |
| smf.conf | (Gitlab) cn5g/oai-cn5g-smf | [etc/smf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-smf/-/blob/develop/etc/smf.conf) |
| nrf.conf | (Gitlab) cn5g/oai-cn5g-nrf | [etc/nrf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-nrf/-/blob/develop/etc/nrf.conf) |
| spgw_u.conf | (Github) OPENAIRINTERFACE/openair-spgwu-tiny | [etc/spgw_u.conf](https://github.com/OPENAIRINTERFACE/openair-spgwu-tiny/blob/gtp_extension_header/etc/spgw_u.conf) |
| udr.conf | (Gitlab) cn5g/oai-cn5g-udr | [etc/udr.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udr/-/blob/develop/etc/udr.conf) |
| udm.conf | (Gitlab) cn5g/oai-cn5g-udm | [etc/udm.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udm/-/blob/develop/etc/udm.conf) |
| ausf.conf | (Gitlab) cn5g/oai-cn5g-ausf | [etc/ausf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-ausf/-/blob/develop/etc/ausf.conf) |
| amf.conf | (Gitlab) cn5g/oai-cn5g-amf | [etc/amf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf/-/blob/master/etc/amf.conf) |
| smf.conf | (Gitlab) cn5g/oai-cn5g-smf | [etc/smf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-smf/-/blob/master/etc/smf.conf) |
| nrf.conf | (Gitlab) cn5g/oai-cn5g-nrf | [etc/nrf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-nrf/-/blob/master/etc/nrf.conf) |
| spgw_u.conf | (Github) OPENAIRINTERFACE/openair-spgwu-tiny | [etc/spgw_u.conf](https://github.com/OPENAIRINTERFACE/openair-spgwu-tiny/blob/master/etc/spgw_u.conf) |
| udr.conf | (Gitlab) cn5g/oai-cn5g-udr | [etc/udr.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udr/-/blob/master/etc/udr.conf) |
| udm.conf | (Gitlab) cn5g/oai-cn5g-udm | [etc/udm.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udm/-/blob/master/etc/udm.conf) |
| ausf.conf | (Gitlab) cn5g/oai-cn5g-ausf | [etc/ausf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-ausf/-/blob/master/etc/ausf.conf) |
### 5.2. User Subscprition Profile ###
This section is similar to the [Section 5.2 in the mini-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#52-user-subscprition-profile).
This section is similar to the [Section 5.2 in the minimalist-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#52-user-subscprition-profile).
## 6. Configuring DsTester Scenario ##
This section is similar to the [Section 6 in the mini-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#6-configuring-dstester-scenario).
This section is similar to the [Section 6 in the minimalist-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#6-configuring-dstester-scenario).
## 7. Deploying OAI 5g Core Network ##
......
docs/DEPLOY_SA5G_BASIC_FQDN_DEPLOYMENT.md
+ 7
− 14
View file @ 81a0f261
......@@ -45,19 +45,12 @@ Note: In case readers are interested in deploying debuggers/developers core netw
## 1. Basic FQDN Deployment Flavours ##
In this tutorial we use FQDN (Fully Qualified Domain Name) feature:
In this tutorial we use FQDN (Fully Qualified Domain Name) feature.
- `NRF` is mandatory
- each Network Function registers itself to the `NRF` using:
- Its IP address
- But also the name of the service
- When a Network requires to communicate to another Network function
- Only the name of the 2nd service needs to be provided
- and no more the IP address
The Basic functional 5g core network supports only one scenario:
The Basic functional 5g core network supports the following scenarios:
- Scenario I: AMF, SMF, UPF (SPGWU), NRF, UDM, UDR, AUSF, MYSQL
- Scenario II: AMF, SMF, UPF (SPGWU), UDM, UDR, AUSF, MYSQL
## 2. Pre-requisites ##
......@@ -69,21 +62,21 @@ This section is similar to the [Section 3 in the basic-deployment](./DEPLOY_SA5G
## 4. Configuring Host Machines ##
This section is similar to the [Section 4 in the mini-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#4-configuring-host-machines).
This section is similar to the [Section 4 in the minimalist-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#4-configuring-host-machines).
## 5. Configuring the OAI-5G Core Network Functions ##
### 5.1. Core Network Configuration ###
This section is similar to the [Section 5.1 in the mini-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#51-core-network-configuration).
This section is similar to the [Section 5.1 in the minimalist-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#51-core-network-configuration).
### 5.2. User Subscprition Profile ###
This section is similar to the [Section 5.2 in the mini-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#52-user-subscprition-profile).
This section is similar to the [Section 5.2 in the minimalist-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#52-user-subscprition-profile).
## 6. Configuring DsTester Scenario ##
This section is similar to the [Section 6 in the mini-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#6-configuring-dstester-scenario).
This section is similar to the [Section 6 in the minimalist-deployment](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#6-configuring-dstester-scenario).
## 7. Deploying OAI 5g Core Network ##
......
docs/DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md
+ 9
− 14
View file @ 81a0f261
......@@ -7,7 +7,7 @@
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OpenAirInterface 5G Core Network Mini Deployment using Docker-Compose</font></b>
<b><font size = "5">OpenAirInterface 5G Core Network Minimalist Deployment using Docker-Compose</font></b>
</td>
</tr>
</table>
......@@ -18,7 +18,7 @@
**OVERVIEW**
This tutorial will help in understanding how to deploy a `mini` OAI core network using docker-compose.
This tutorial will help in understanding how to deploy a `minimalist` OAI core network using docker-compose.
* In this tutorial we have used [dsTest](https://www.developingsolutions.com/products/dstest-5g-core-network-testing/), a commercial paid gNB emulator.
* Though, instead of this, readers can also use `gNBsim` (an opensource gNB emulator), you can follow another tutorial for [this](./DEPLOY_SA5G_WITH_GNBSIM.md).
......@@ -32,7 +32,7 @@ Please follow the tutorial step by step to create a stable working testbed.
**TABLE OF CONTENTS**
1. [Mini Deployment Flavours](#1-mini-deployment-flavours)
1. [Minimalist Deployment Flavours](#1-minimalist-deployment-flavours)
2. [Pre-requisites](#2-pre-requisites)
3. [Network Function Container Images](#2-network-function-container-images)
4. [Configuring Host Machines](#4-configuring-host-machines)
......@@ -44,18 +44,13 @@ Please follow the tutorial step by step to create a stable working testbed.
10. [Demo Video](#10-demo-video)
11. [Notes](#11-notes)
## 1. Mini Deployment Flavours ##
## 1. Minimalist Deployment Flavours ##
The Mini functional 5g core network can be deployed into 2 scenarios:
The `Minimalist` functional 5g core network can be deployed into 2 scenarios:
- Scenario I: AMF, SMF, UPF (SPGWU), NRF, MYSQL
- Scenario II: AMF, SMF, UPF (SPGWU), MYSQL
`Scenario II` is not using the `NRF` component:
* Services can no more be identified using `FQDN`
* They shall be identified using hard-coded IP addresses
## 2. Pre-requisites ##
The container images are built using `docker build` command on Ubuntu 18.04 host machine. The base image for all the containers is Ubuntu 18.04.
......@@ -234,10 +229,10 @@ The docker-compose file has configuration parameters of each core network compon
| File Name | Repository | Location |
| ----------- | -------------------------------------------- | --------------- |
| amf.conf | (Gitlab) cn5g/oai-cn5g-amf | [etc/amf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf/-/blob/develop/etc/amf.conf) |
| smf.conf | (Gitlab) cn5g/oai-cn5g-smf | [etc/smf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-smf/-/blob/develop/etc/smf.conf) |
| nrf.conf | (Gilab) cn5g/oai-cn5g-nrf | [etc/nrf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-nrf/-/blob/develop/etc/nrf.conf) |
| spgw_u.conf | (Github) OPENAIRINTERFACE/openair-spgwu-tiny | [etc/spgw_u.conf](https://github.com/OPENAIRINTERFACE/openair-spgwu-tiny/blob/gtp_extension_header/etc/spgw_u.conf) |
| amf.conf | (Gitlab) cn5g/oai-cn5g-amf | [etc/amf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf/-/blob/master/etc/amf.conf) |
| smf.conf | (Gitlab) cn5g/oai-cn5g-smf | [etc/smf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-smf/-/blob/master/etc/smf.conf) |
| nrf.conf | (Gilab) cn5g/oai-cn5g-nrf | [etc/nrf.conf](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-nrf/-/blob/master/etc/nrf.conf) |
| spgw_u.conf | (Github) OPENAIRINTERFACE/openair-spgwu-tiny | [etc/spgw_u.conf](https://github.com/OPENAIRINTERFACE/openair-spgwu-tiny/blob/master/etc/spgw_u.conf) |
### 5.2. User Subscprition Profile ###
......
docs/DEPLOY_SA5G_WITH_GNBSIM.md
+ 10
− 38
View file @ 81a0f261
......@@ -43,9 +43,9 @@ Note: In case readers are interested in deploying debuggers/developers core netw
<br/>
This tutorial is a extension of previous tutorial of [testing with dsTester](./docs/DEPLOY_SA5G_WITH_DS_TESTER.md). In previous tutorial we have seen the advanced testing tool dsTester, which is useful for validating even more complex scenarios.
This tutorial is an extension of a previous tutorial: [testing a `minimalist` deployment with dsTester](./DEPLOY_SA5G_MINI_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 are available for SA5G test. In this tutorial we use opensource simulator tool called gnbsim. With the help of gnbsim tool, we can perform very basic SA5G test by simulating one gnb and one ue.
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 `gnbsim`. With the help of `gnbsim` tool, we can perform very basic SA5G test by simulating one gnb and one ue.
##### About gnbsim -
......@@ -59,28 +59,13 @@ 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
```bash
oai-cn5g-fed/docker-compose$ ./core-network.sh start nrf spgwu
Starting 5gcn components in the order nrf, mysql, amf, smf, spgwu...
Creating mysql ... done
Creating oai-nrf ... done
Creating oai-amf ... done
Creating oai-spgwu ... done
Creating oai-smf ... done
Creating oai-ext-dn ... done
Core network started, checking the health status of the containers...
oai-nrf : "healthy", mysql : "starting", oai-amf : "healthy", oai-smf : "healthy", oai-spgwu : "healthy"
All components are healthy...
Checking the if the containers are configured...
Checking if SMF and UPF registered with nrf core network
For example: oai-smf Registration with oai-nrf can be checked on this url /nnrf-nfm/v1/nf-instances?nf-type='SMF' {"_links":{"item":[{"href":"192.168.70.133"}],"self":""}}
SMF and UPF are registered to NRF...
Core network is configured and healthy, total time taken 43187 milli seconds
oai-cn5g-fed/docker-compose$
oai-cn5g-fed/docker-compose$ ./core-network.py --type start-mini --fqdn no --scenario 1
...
[2021-09-14 16:44:47,176] root:DEBUG: OAI 5G Core network is configured and healthy....
```
More details in [section 7 of the `minimalist` tutorial](./DEPLOY_SA5G_MINI_DS_TESTER_DEPLOYMENT.md#7-deploying-oai-5g-core-network).
```bash
oai-cn5g-fed/docker-compose$ docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
......@@ -330,21 +315,8 @@ Service gnbsim is stopped
* Undeploy the core network
```bash
/oai-cn5g-fed/docker-compose$ ./core-network.sh stop nrf spgwu
Stopping service nrf ...
Stopping oai-amf ... done
Stopping oai-ext-dn ... done
Stopping oai-smf ... done
Stopping oai-spgwu ... done
Stopping oai-nrf ... done
Stopping mysql ... done
Removing oai-amf ... done
Removing oai-ext-dn ... done
Removing oai-smf ... done
Removing oai-spgwu ... done
Removing oai-nrf ... done
Removing mysql ... done
Network demo-oai-public-net is external, skipping
Service nrf is stopped
oai-cn5g-fed/docker-compose$ ./core-network.py --type stop-mini --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