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

Updated readme for helm-chart

parent 36d9bcab
No related branches found
No related tags found
1 merge request!144chore(ci): Updating helm-charts for release 2
Hide whitespace changes
Inline Side-by-side
Showing
with 719 additions and 882 deletions
charts/oai-5g-ran/oai-cu-cp/values.yaml
+ 2
− 2
View file @ 06487119
......@@ -65,8 +65,8 @@ config:
timeZone: "Europe/Paris"
useAdditionalOptions: "--sa --log_config.global_log_options level,nocolor,time"
cucpName: "oai-cu-cp"
mcc: "001" # check the information with AMF, SMF, UPF/SPGWU
mnc: "01" # check the information with AMF, SMF, UPF/SPGWU
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
amfhost: "oai-amf" # amf ip-address or service-name oai-amf-svc or 172.21.6.94
......
charts/oai-5g-ran/oai-cu-up/values.yaml
+ 2
− 2
View file @ 06487119
......@@ -64,8 +64,8 @@ config:
timeZone: "Europe/Paris"
useAdditionalOptions: "--sa"
cuupName: "oai-cuup"
mcc: "001" # check the information with AMF, SMF, UPF/SPGWU
mnc: "01" # check the information with AMF, SMF, UPF/SPGWU
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
cuCpHost: "oai-cu" #
......
charts/oai-5g-ran/oai-cu/values.yaml
+ 2
− 2
View file @ 06487119
......@@ -69,8 +69,8 @@ config:
useAdditionalOptions: "--sa --log_config.global_log_options level,nocolor,time"
# If mounting the configuration file then below parameters are not used
cuName: "oai-cu"
mcc: "001" # check the information with AMF, SMF, UPF/SPGWU
mnc: "01" # check the information with AMF, SMF, UPF/SPGWU
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
amfhost: "oai-amf" # amf ip-address or service-name oai-amf-svc or 172.21.6.94
......
charts/oai-5g-ran/oai-du/templates/service.yaml
+ 1
− 1
View file @ 06487119
apiVersion: v1
kind: Service
metadata:
name: {{ .Chart.Name }}
name: oai-ran
labels:
{{- include "oai-du.labels" . | nindent 4 }}
spec:
......
charts/oai-5g-ran/oai-du/values.yaml
+ 2
− 2
View file @ 06487119
......@@ -59,8 +59,8 @@ config:
timeZone: "Europe/Paris"
useAdditionalOptions: "--sa --rfsim --log_config.global_log_options level,nocolor,time"
duName: "oai-du-rfsim"
mcc: "001" # check the information with AMF, SMF, UPF/SPGWU
mnc: "01" # check the information with AMF, SMF, UPF/SPGWU
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
usrp: rfsim #allowed values rfsim, b2xx, n3xx or x3xx
......
charts/oai-5g-ran/oai-gnb/templates/configmap.yaml
+ 115
− 115
View file @ 06487119
......@@ -27,133 +27,133 @@ data:
min_rxtxtime = 6;
servingCellConfigCommon = (
{
#spCellConfigCommon
physCellId = 0;
servingCellConfigCommon = (
{
#spCellConfigCommon
# downlinkConfigCommon
#frequencyInfoDL
# this is 3300.60 MHz + 53*12*30e-3 MHz = 3319.68
absoluteFrequencySSB = 621312;
# this is 3300.60 MHz
dl_absoluteFrequencyPointA = 620040;
#scs-SpecificCarrierList
dl_offstToCarrier = 0;
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
dl_subcarrierSpacing = 1;
dl_carrierBandwidth = 106;
#initialDownlinkBWP
#genericParameters
# this is RBstart=0,L=106 (275*(L-1))+RBstart
initialDLBWPlocationAndBandwidth = 28875;
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
initialDLBWPsubcarrierSpacing = 1;
#pdcch-ConfigCommon
initialDLBWPcontrolResourceSetZero = 11;
initialDLBWPsearchSpaceZero = 0;
physCellId = 0;
#uplinkConfigCommon
#frequencyInfoUL
ul_frequencyBand = 78;
#scs-SpecificCarrierList
ul_offstToCarrier = 0;
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
ul_subcarrierSpacing = 1;
ul_carrierBandwidth = 106;
pMax = 20;
#initialUplinkBWP
#genericParameters
initialULBWPlocationAndBandwidth = 28875;
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
initialULBWPsubcarrierSpacing = 1;
#rach-ConfigCommon
#rach-ConfigGeneric
prach_ConfigurationIndex = 98;
#prach_msg1_FDM
#0 = one, 1=two, 2=four, 3=eight
prach_msg1_FDM = 0;
prach_msg1_FrequencyStart = 0;
zeroCorrelationZoneConfig = 12;
preambleReceivedTargetPower = -104;
#preamblTransMax (0...10) = (3,4,5,6,7,8,10,20,50,100,200)
preambleTransMax = 6;
#powerRampingStep
# 0=dB0,1=dB2,2=dB4,3=dB6
powerRampingStep = 1;
#ra_ReponseWindow
#1,2,4,8,10,20,40,80
ra_ResponseWindow = 4;
#ssb_perRACH_OccasionAndCB_PreamblesPerSSB_PR
#1=oneeighth,2=onefourth,3=half,4=one,5=two,6=four,7=eight,8=sixteen
ssb_perRACH_OccasionAndCB_PreamblesPerSSB_PR = 3;
#oneHalf (0..15) 4,8,12,16,...60,64
ssb_perRACH_OccasionAndCB_PreamblesPerSSB = 15;
#ra_ContentionResolutionTimer
#(0..7) 8,16,24,32,40,48,56,64
ra_ContentionResolutionTimer = 7;
rsrp_ThresholdSSB = 19;
#prach-RootSequenceIndex_PR
#1 = 839, 2 = 139
prach_RootSequenceIndex_PR = 2;
prach_RootSequenceIndex = 1;
# SCS for msg1, can only be 15 for 30 kHz < 6 GHz, takes precendence over the one derived from prach-ConfigIndex
#
msg1_SubcarrierSpacing = 1,
# restrictedSetConfig
# 0=unrestricted, 1=restricted type A, 2=restricted type B
restrictedSetConfig = 0,
# downlinkConfigCommon
#frequencyInfoDL
# this is 3600 MHz + 43 PRBs@30kHz SCS (same as initial BWP)
absoluteFrequencySSB = 641280;
dl_frequencyBand = 78;
# this is 3600 MHz
dl_absoluteFrequencyPointA = 640008;
#scs-SpecificCarrierList
dl_offstToCarrier = 0;
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
dl_subcarrierSpacing = 1;
dl_carrierBandwidth = 106;
#initialDownlinkBWP
#genericParameters
# this is RBstart=27,L=48 (275*(L-1))+RBstart
initialDLBWPlocationAndBandwidth = 28875; # 6366 12925 12956 28875 12952
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
initialDLBWPsubcarrierSpacing = 1;
#pdcch-ConfigCommon
initialDLBWPcontrolResourceSetZero = 12;
initialDLBWPsearchSpaceZero = 0;
msg3_DeltaPreamble = 1;
p0_NominalWithGrant =-90;
#uplinkConfigCommon
#frequencyInfoUL
ul_frequencyBand = 78;
#scs-SpecificCarrierList
ul_offstToCarrier = 0;
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
ul_subcarrierSpacing = 1;
ul_carrierBandwidth = 106;
pMax = 20;
#initialUplinkBWP
#genericParameters
initialULBWPlocationAndBandwidth = 28875;
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
initialULBWPsubcarrierSpacing = 1;
#rach-ConfigCommon
#rach-ConfigGeneric
prach_ConfigurationIndex = 98;
#prach_msg1_FDM
#0 = one, 1=two, 2=four, 3=eight
prach_msg1_FDM = 0;
prach_msg1_FrequencyStart = 0;
zeroCorrelationZoneConfig = 13;
preambleReceivedTargetPower = -96;
#preamblTransMax (0...10) = (3,4,5,6,7,8,10,20,50,100,200)
preambleTransMax = 6;
#powerRampingStep
# 0=dB0,1=dB2,2=dB4,3=dB6
powerRampingStep = 1;
#ra_ReponseWindow
#1,2,4,8,10,20,40,80
ra_ResponseWindow = 4;
#ssb_perRACH_OccasionAndCB_PreamblesPerSSB_PR
#1=oneeighth,2=onefourth,3=half,4=one,5=two,6=four,7=eight,8=sixteen
ssb_perRACH_OccasionAndCB_PreamblesPerSSB_PR = 4;
#oneHalf (0..15) 4,8,12,16,...60,64
ssb_perRACH_OccasionAndCB_PreamblesPerSSB = 14;
#ra_ContentionResolutionTimer
#(0..7) 8,16,24,32,40,48,56,64
ra_ContentionResolutionTimer = 7;
rsrp_ThresholdSSB = 19;
#prach-RootSequenceIndex_PR
#1 = 839, 2 = 139
prach_RootSequenceIndex_PR = 2;
prach_RootSequenceIndex = 1;
# SCS for msg1, can only be 15 for 30 kHz < 6 GHz, takes precendence over the one derived from prach-ConfigIndex
#
msg1_SubcarrierSpacing = 1,
# restrictedSetConfig
# 0=unrestricted, 1=restricted type A, 2=restricted type B
restrictedSetConfig = 0,
# pucch-ConfigCommon setup :
# pucchGroupHopping
# 0 = neither, 1= group hopping, 2=sequence hopping
pucchGroupHopping = 0;
hoppingId = 40;
p0_nominal = -90;
# ssb_PositionsInBurs_BitmapPR
# 1=short, 2=medium, 3=long
ssb_PositionsInBurst_PR = 2;
ssb_PositionsInBurst_Bitmap = 1;
msg3_DeltaPreamble = 1;
p0_NominalWithGrant =-90;
# ssb_periodicityServingCell
# 0 = ms5, 1=ms10, 2=ms20, 3=ms40, 4=ms80, 5=ms160, 6=spare2, 7=spare1
ssb_periodicityServingCell = 2;
# pucch-ConfigCommon setup :
# pucchGroupHopping
# 0 = neither, 1= group hopping, 2=sequence hopping
pucchGroupHopping = 0;
hoppingId = 40;
p0_nominal = -90;
# ssb_PositionsInBurs_BitmapPR
# 1=short, 2=medium, 3=long
ssb_PositionsInBurst_PR = 2;
ssb_PositionsInBurst_Bitmap = 1;
# dmrs_TypeA_position
# 0 = pos2, 1 = pos3
dmrs_TypeA_Position = 0;
# ssb_periodicityServingCell
# 0 = ms5, 1=ms10, 2=ms20, 3=ms40, 4=ms80, 5=ms160, 6=spare2, 7=spare1
ssb_periodicityServingCell = 2;
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
subcarrierSpacing = 1;
# dmrs_TypeA_position
# 0 = pos2, 1 = pos3
dmrs_TypeA_Position = 0;
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
subcarrierSpacing = 1;
#tdd-UL-DL-ConfigurationCommon
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
referenceSubcarrierSpacing = 1;
# pattern1
# dl_UL_TransmissionPeriodicity
# 0=ms0p5, 1=ms0p625, 2=ms1, 3=ms1p25, 4=ms2, 5=ms2p5, 6=ms5, 7=ms10
dl_UL_TransmissionPeriodicity = 6;
nrofDownlinkSlots = 7;
nrofDownlinkSymbols = 6;
nrofUplinkSlots = 2;
nrofUplinkSymbols = 4;
ssPBCH_BlockPower = -25;
}
#tdd-UL-DL-ConfigurationCommon
# subcarrierSpacing
# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
referenceSubcarrierSpacing = 1;
# pattern1
# dl_UL_TransmissionPeriodicity
# 0=ms0p5, 1=ms0p625, 2=ms1, 3=ms1p25, 4=ms2, 5=ms2p5, 6=ms5, 7=ms10
dl_UL_TransmissionPeriodicity = 6;
nrofDownlinkSlots = 7;
nrofDownlinkSymbols = 6;
nrofUplinkSlots = 2;
nrofUplinkSymbols = 4;
);
ssPBCH_BlockPower = -25;
}
);
# ------- SCTP definitions
SCTP :
......
charts/oai-5g-ran/oai-gnb/templates/service.yaml
+ 1
− 1
View file @ 06487119
apiVersion: v1
kind: Service
metadata:
name: {{ .Chart.Name }}
name: oai-ran
labels:
{{- include "oai-gnb.labels" . | nindent 4 }}
spec:
......
charts/oai-5g-ran/oai-gnb/values.yaml
+ 3
− 3
View file @ 06487119
......@@ -73,10 +73,10 @@ multus:
# Example config files --> https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/targets/PROJECTS/GENERIC-NR-5GC/CONF
config:
timeZone: "Europe/Paris"
useAdditionalOptions: "--sa -E --rfsim --log_config.global_log_options level,nocolor,time"
useAdditionalOptions: "--sa --rfsim --log_config.global_log_options level,nocolor,time"
gnbName: "oai-gnb-rfsim"
mcc: "001" # check the information with AMF, SMF, UPF/SPGWU
mnc: "01" # check the information with AMF, SMF, UPF/SPGWU
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
usrp: rfsim #allowed values rfsim, b2xx, n3xx or x3xx
......
charts/oai-5g-ran/oai-nr-ue/values.yaml
+ 1
− 4
View file @ 06487119
......@@ -32,7 +32,7 @@ multus:
config:
timeZone: "Europe/Paris"
rfSimServer: "oai-du" # ip-address of rfsim or service name oai-gnb in case of du change it with oai-du if multus is true then provide ip-address of oai-gnb
rfSimServer: "oai-ran" # ip-address of rfsim or service name oai-gnb or oai-du
fullImsi: "001010000000100" # make sure all the below entries are present in the subscriber database
fullKey: "fec86ba6eb707ed08905757b1bb44b8f"
opc: "C42449363BBAD02B66D16BC975D77CC1"
......@@ -42,9 +42,6 @@ config:
usrp: "rfsim" # allowed rfsim, b2xx, n3xx, x3xx
useAdditionalOptions: "--sa --rfsim -r 106 --numerology 1 -C 3619200000 --nokrnmod --log_config.global_log_options level,nocolor,time"
#for monolythic -E --sa --rfsim -r 106 --numerology 1 -C 3619200000 --log_config.global_log_options level,nocolor,time
#for du --sa --rfsim -r 106 --numerology 1 -C 3619200000 --nokrnmod --log_config.global_log_options level,nocolor,time
podSecurityContext:
runAsUser: 0
runAsGroup: 0
......
docs/DEPLOY_SA5G_HC.md
+ 590
− 246
View file @ 06487119
......@@ -7,15 +7,14 @@
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OpenAirInterface 5G Core Network Deployment using Helm Charts</font></b>
<b><font size = "5">OpenAirInterface 5G Core and RAN Network Function Deployment using Helm Charts</font></b>
</td>
</tr>
</table>
OAI 5G core network have different network functions which can be used invidiually or deployed all together in different combination on a production grade Kubernetes cluster like Openshift or a vanilla kubernetes cluster.
OAI 5G core network have different network functions which can be used invidiually or deployed all together in different combination on a production grade Kubernetes cluster like Openshift or a Vanilla Kubernetes cluster.
![Helm Chart Deployment](./images/helm-chart-basic.png)
![Helm Chart Deployment](./images/helm-chart.png)
**Reading time**: ~30 mins
......@@ -24,17 +23,13 @@ OAI 5G core network have different network functions which can be used invidiual
**TABLE OF CONTENTS**
1. [Description](#1-description)
2. [Fetching Network Function Images](#2-fetching-network-function-images)
3. [Configuring Helm Charts](#3-configuring-helm-charts)
4. [Deploying 5g Core Helm Charts](#4-deploying-helm-charts)
5. [Optional: Testing with OAI gNB RFsimulator and NR-UE](#5-testing-with-oai-gnb-rfsimulator-and-nr-ue)
6. [Extra](#6-extra)
[[_TOC_]]
### Pre-requisite
The cluster on which these helm charts will be deployed should have RBAC and [Multus CNI](https://github.com/k8snetworkplumbingwg/multus-cni). Multus is necessary to provide multiple interfaces to AMF and UPF/SPGWU. In case you don't have multus CNI for seconary network interface inside the pod you can still use the ethernet interface provided by the primary CNI. This type of setting is only recommended for playing with rfsimulator. In case you are using minikube or any other Kubernetes deployer make sure you have minimum 4 CPU and 16 GBi of ram.
1. Minimum 4 CPU (Threaded), 16GBi RAM and 50G storage
2. (Optional) Multus CNI if using multiple interfaces for NFs
Clone the git repository
......@@ -48,50 +43,44 @@ The helm charts can be used on any production grade kubernetes cluster or even v
| Software | Version |
|:--------------------------------|:----------------------------------------|
| Openshift Client Version | 4.10.X |
| Kubernetes Version | Kubernetes Version: v1.23.12+8a6bfe4 |
| helm | v3.6.2+5.el8 |
| helm-spray (plugin) | v4.0.10 |
| Base images of Network functions| Ubuntu 18.04/20.04/22.04/UBI 8.X(RHEL8) |
We are deploying the helm charts using `helm spray` plugin of `helm` as the network functions have dependency and they are required to be deployed in a certain order. To get more information on helm spray you can follow this [link](https://github.com/ThalesGroup/helm-spray).
| Openshift Client Version | 4.13.X |
| Kubernetes Version | Kubernetes Version: v1.27.4 |
| helm | v3.11.2 |
| Base images of Network functions| Ubuntu 20.04/22.04/UBI 8/9(RHEL 8/9) |
For the moment we provide helm chart of inidividual network functions, udr, udm, ausf, amf, nrf, smf, upf and nssf. To make the deployment of the network function easier we provide three different setting in which they can be deployed
Each NF has its independent helm-chart and apart from that there are parent helm-charts for below scenarions:
1. Minimalist deployment: Mysql (Subscriber Database), AMF, SMF, UPF, NRF
2. Basic deployment: Mysql (Subscriber Database), UDR, UDM, AUSF, AMF, SMF, UPF, NRF
3. Slicing support: Mysql (Subscriber Database), NSSF, UDR, UDM, AUSF, AMF, SMF, UPF, NRF
1. Minimalist deployment: MYSQL (Subscriber Database), AMF, SMF, UPF, NRF
2. Basic deployment: MYSQL (Subscriber Database), UDR, UDM, AUSF, AMF, SMF, UPF, NRF
3. Advance deployment: MYSQL (Subscriber Database), NSSF, UDR, UDM, AUSF, AMF, SMF, UPF, NRF
In this tutorial we will deploy a basic setting of OAI 5g core network and will deploy oai-gNB and oai-nr-ue in rf-simulator mode to perform some traffic testing. You can also deploy the core network in other two settings, it all depends on your use case and testbed. The configuration parameters of helm charts are the same as `docker-compose` so if you know how to configure `docker-compose` yaml file you can configure the helm charts `value.yaml`.
In this tutorial we will deploy a basic setting of OAI 5g core network and will deploy oai-gNB and oai-nr-ue in rf-simulator mode to perform some traffic testing. You can also deploy the core network in other two settings, it all depends on your use case and testbed.
## 2. Fetching Network Function Images
Ubuntu base images can be pulled from [docker-hub](https://hub.docker.com/u/oaisoftwarealliance) but if you want to make some changes in the code then you should build your own images. If you will use Ubuntu images then skip this part and in section `3.1` there is a detailed procedure. In case of RHEL based worker node you have to build your own images, to download packages from RHEL repository you need a developer or enterprise account. To learn how to build UBI 8.6 images follow this [tutorial](./openshift/README.md)
Ubuntu base images can be pulled from [docker-hub](https://hub.docker.com/u/oaisoftwarealliance) but if you want to make some changes in the code then you should build your own images. If you will use Ubuntu images then skip this part and in section `3.1` there is a detailed procedure. In case of RHEL based worker node you have to build your own images, to download packages from RHEL repository you need a developer or enterprise account.
OAI network functions can be build on ubuntu 18.04/20.04/22.04 or UBI 8.6 base images. Follow the tutorial on [how to build images](./BUILD_IMAGES.md) depending on the cluster/worker-node operating system.
1. To learn how to build UBI 9.X images follow this [tutorial](./openshift/README.md)
2. To learn how to build Ubuntu images follow this [tutorial](./BUILD_IMAGES.md)
## 3. Configuring Helm Charts
```console
$: cd oai-cn5g-fed
$: ls charts/
oai-5g-core oai-5g-ran simulators testing
$: ls charts/oai-5g-core/
mysql oai-5g-basic oai-5g-mini oai-5g-slicing oai-amf oai-ausf oai-nrf oai-nssf oai-smf oai-spgwu-tiny oai-udm oai-udr
$: ls charts/oai-5g-ran/
oai-gnb oai-gnb-cu oai-gnb-du oai-nr-ue
$: ls charts/simulators/
gnbsim
$: ls charts/testing/
testing-pod.yaml
cd oai-cn5g-fed
ls charts/
oai-5g-core oai-5g-ran
ls charts/oai-5g-core/
mysql oai-5g-advance oai-5g-basic oai-5g-mini oai-amf oai-ausf oai-nrf oai-nssf oai-smf oai-traffic-server oai-udm oai-udr oai-upf
ls charts/oai-5g-ran/
oai-cu oai-cu-cp oai-cu-up oai-du oai-gnb oai-nr-ue
```
All the OAI core network charts are present in `oai-5g-core` folder, there you can find charts of individual network functions and for the above described three different deployment settings.
1. Folder `oai-5g-mini` is for [minimilist deployment](../charts/oai-5g-core/oai-5g-mini)
2. Folder `oai-5g-basic` is for [basic deployment](../charts/oai-5g-core/oai-5g-basic)
3. Folder `oai-5g-slicing` is for [slicing deployment](../charts/oai-5g-core/oai-5g-slicing)
1. Folder `oai-5g-mini` is for [minimilist deployment](../charts/oai-5g-core/oai-5g-mini/README.md)
2. Folder `oai-5g-basic` is for [basic deployment](../charts/oai-5g-core/oai-5g-basic/README.md)
3. Folder `oai-5g-advance` is for [advance deployment](../charts/oai-5g-core/oai-5g-advance/README.md)
These charts are configured keeping in mind 5G service based architecture, if you want to deploy using reference based architecture then you need to make certain changes.
......@@ -100,55 +89,61 @@ The structure of all these folders is similar,
```
oai-5g-basic/
├── Chart.yaml
├── config.yaml
├── README.md
├── templates
│ └── configmap.yaml
└── values.yaml
0 directories, 2 files
1 directory, 5 files
```
In the `values.yaml` file we have put only those configuration parameters which we think are really necessary and they should be changed based on PLMN, DNN and sim card information. In case you want to change some other parameters we suggest you go in the helm charts of the network function and do the change there.
Starting version `2.0.0` of OAI 5G Core network functions their configuration will be in `config.yaml` and all infrastructure related information including image definition will be in `values.yaml`.
Helm chart of every network function looks similar and has the below structure. Only the chart of mysql database and NRF is different.
```
Network_function/
├── Chart.yaml
├── config.yaml
├── README.md
├── templates
│ ├── configmap.yaml
│ ├── deployment.yaml
│ ├── _helpers.tpl
│ ├── multus.yaml
│ ├── NOTES.txt
│ ├── rbac.yaml
│ ├── serviceaccount.yaml
| └── service.yaml
└── values.yaml
│ ├── configmap.yaml
│ ├── deployment.yaml
│ ├── _helpers.tpl
│ ├── multus.yaml
│ ├── NOTES.txt
│ ├── rbac.yaml
│ ├── serviceaccount.yaml
│ └── service.yaml
└── values.yaml
1 directory, 10 files
```
1 directory, 12 files
All the configurable parameters for a particular commit/release are mentioned in the `values.yaml` file. These parameters will keep on changing in the future depending on the nature of development and features.
```
**NOTE**: If there is a need to edit a specific configuration parameter that is not configurable via the helm-chart `values.yaml` file then it has to be changed at the time of building images.
All the configurable parameters for a particular commit/release are mentioned in the `config.yaml` file. These parameters will keep on changing in the future depending on the nature of development and features.
All the network function related configurable parameters are in the sections `config` of the `values.yaml`. To understand the usage and description of each network function configuration parameter refer their [wiki page](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-amf/-/wikis/home).
**NOTE**: If there is a need to edit a specific configuration parameter that is not configurable via the helm-chart `config.yaml` file then it has to be changed at the time of building images.
Create a namespace where the helm-charts will be deployed, in our environment we deploy them in `oai-tutorial` namespace. To create a namespace use the below command on your cluster,
```console
# needs a user which has the right to create namespaces
$: kubectl create ns oai-tutorial
or
$: oc new-project oai-tutorial
kubectl create ns oai-tutorial
#or
oc new-project oai-tutorial
```
**NOTE**: Any changes done in the parent chart (Mini, basic, slicing scenario helm charts) will overwrite the sub charts.
**NOTE**: Any changes done in the parent chart (Mini, basic, advance scenario helm charts) will overwrite the sub charts.
### 3.1 Networking related information
Network function discovers each-other using NRF and instead of using the ip-address of network functions we rely on using their FQDN, **kubernetes service concept**. To communicate with each other whether we deploy them in reference point architecture or service based architecture.
Network function discovers each-other using NRF and instead of using the ip-address of network functions we rely on using their FQDN, **Kubernetes service concept**. To communicate with each other whether we deploy them in reference point architecture or service based architecture.
*For example: AMF registers with NRF using NRF FQDN (`oai-nrf-svc.oai.svc.cluster.local`). This way we can get rid of any static ip-address configuration. Though we are still keeping the fields where we are mentioning ip-addresses for example `nrfIpv4Addr` in amf values.yaml but that is not being used if `USE_FQDN_DNS` is set to `true`*
*For example: AMF registers with NRF using NRF FQDN (`oai-nrf.oai-tutorial.svc.cluster.local`). This way we can get rid of any static ip-address configuration.*
#### 3.1.1 Configure Multiple Interfaces
......@@ -182,45 +177,48 @@ multus:
```
## Example from oai-amf/values.yaml
multus:
create: false (change only this)
n2Interface:
create: false
```
#### 3.1.3 Capturing Packets (Optional)
Every network function has an extra TCP dump container to take the TCP dump. But by default this container start in sleep mode and does not capture the dumps on any interface. If enabled it will capture dumps on `all interfaces` and will store inside the container locally or in a persistant volume if enabled.
Every network function has an extra TCP dump container to take the TCP dump. But by default this container is not used. If enabled it will capture dumps on `all interfaces` and will store inside the container locally or in a persistant volume if enabled.
To enable the persistant volume in the `values.yaml` of every network function make the below change,
```
## in case of nrf but it same for every network function
## amf
start:
nrf: start
tcpdump: start #start tcpdump collection to analyse but beware it will take a lot of space in the container/persistent volume
amf: true #If false the network function container will run in sleep mode for manually testing
tcpdump: false
includeTcpDumpContainer: false #If true it will add a tcpdump container inside network function pod for debugging
persistence:
sharedvolume: true
volumneName: <configure-your-storage-name>
size: <configure-the-size> #example 1Gi
#To store PCAP of NF in a sharedVolume so it can be easily fetched (PVC is created with NRF charts so make sure in NRF it is true)
persistent:
sharedvolume: false
```
### 3.2 Network function Images
To pull images from docker-hub, it will be good to configure an image pull secrete because of the recent limit of 100 pulls in docker-hub from an anonymous account. If you provide a personal/company account the limit is different.
To pull images from docker-hub, it will be good to configure an image pull secrete because of the anonymous pull limit of 100 in docker-hub. If you provide a personal/company account the limit will be different.
```bash
#kubernetes
$: kubectl create secret docker-registry regcred --docker-server=https://index.docker.io/v1/ --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
kubectl create secret docker-registry regcred --docker-server=https://index.docker.io/v1/ --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
#openshift
$: oc create secret docker-registry regcred --docker-server=https://index.docker.io/v1/ --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
oc create secret docker-registry regcred --docker-server=https://index.docker.io/v1/ --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
```
There are more ways to make docker secrete you can follow this [link](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). After this mention this in the `values.yaml` of each network function
```
## good to use when pulling images from docker-hub
## good to use when pulling images from docker-hub mention
imagePullSecrets:
- name: regcred
- name: "regcred"
```
When pulling images from docker hub you have several choices either to use images with develop tag (based on latest develop branch somtimes might not be stable), latest (built from current master branch) and release tags.
......@@ -228,16 +226,16 @@ When pulling images from docker hub you have several choices either to use image
### 3.3 Configuring Helm Chart Parameters
In the [values.yaml](../charts/oai-5g-core/oai-5g-basic) of oai-5g-basic helm charts you will see the configurable parameters for all the network functions check, the PLMN, DNN and subscriber information in mysql database
In the [config.yaml](../charts/oai-5g-core/oai-5g-basic/config.yaml) of oai-5g-basic helm charts you will see the configurable parameters for all the network functions check, the PLMN, DNN and subscriber information in mysql database
For basic and slicing deployment check the database [oai_db-basic.sql](../charts/oai-5g-core/mysql/initialization/oai_db-basic.sql)
For basic and advance deployment check the database [oai_db-basic.sql](../charts/oai-5g-core/mysql/initialization/oai_db-basic.sql)
A new subscriber entry can be added directly in the sql file or it can be added once the core network is already deployed.
To add the entry before deploying the core network, make sure you have all the required subscriber information IMSI(ueid/supi), Key(encPermanentKey), OPC(encOpcKey), PLMN, NSSAI(SST, SD), DNN
```sql
$: vim/vi/nano charts/oai-5g-core/mysql/initialization/oai_db-basic.sql
vim/vi/nano charts/oai-5g-core/mysql/initialization/oai_db-basic.sql
# Add a new or edit existing entries after AuthenticationSubscription table
INSERT INTO `AuthenticationSubscription` (`ueid`, `authenticationMethod`, `encPermanentKey`, `protectionParameterId`, `sequenceNumber`, `authenticationManagementField`, `algorithmId`, `encOpcKey`, `encTopcKey`, `vectorGenerationInHss`, `n5gcAuthMethod`, `rgAuthenticationInd`, `supi`) VALUES
('208990100001124', '5G_AKA', 'fec86ba6eb707ed08905757b1bb44b8f', 'fec86ba6eb707ed08905757b1bb44b8f', '{\"sqn\": \"000000000020\", \"sqnScheme\": \"NON_TIME_BASED\", \"lastIndexes\": {\"ausf\": 0}}', '8000', 'milenage', 'c42449363bbad02b66d16bc975d77cc1', NULL, NULL, NULL, NULL, '208990100001124');
......@@ -249,25 +247,13 @@ INSERT INTO `SessionManagementSubscriptionData` (`ueid`, `servingPlmnid`, `singl
('208990100001125', '20899', '{\"sst\": 1, \"sd\": \"10203\"}','{\"oai\":{\"pduSessionTypes\":{ \"defaultSessionType\": \"IPV4\"},\"sscModes\": {\"defaultSscMode\": \"SSC_MODE_1\"},\"5gQosProfile\": {\"5qi\": 6,\"arp\":{\"priorityLevel\": 1,\"preemptCap\": \"NOT_PREEMPT\",\"preemptVuln\":\"NOT_PREEMPTABLE\"},\"priorityLevel\":1},\"sessionAmbr\":{\"uplink\":\"100Mbps\", \"downlink\":\"100Mbps\"}}}');
```
In the smf the config value `useLocalSubscriptionInfo` make sures that the subscriber DNN, NSSAI, ip-address mapping is taken via UDM. In case you want to use the local subscription information describe in the smf you can set this parameter to `no`. In minimalist deployment this parameter is always `no`.
In case you are looking for some other paramter which isn't available in the values.yaml file of the oai-5g-basic chart then check in the invidual chart of the network function.
In the config file `smf.use_local_subscription_info` should be `yes` to use the user DNN subscription information from the database. Else it will be used as defined in the configuration file.
Once the charts are configured perform helm dependency update inside the chart repository
<!---
For CI purposes please ignore this line (configure the charts for openshift, image registry)
``` shell
$: cp values.yaml values.yml.tmp
$: sed -i 's/docker.io\/oaisoftwarealliance\///g' oai-5g-basic/values.yaml
$: sed -i 's/- name: "regcred"//g' oai-5g-basic/values.yaml
$: oc project oai-tutorial
```
-->
``` shell
$: cd charts/oai-5g-core/oai-5g-basic
$: helm dependency update
cd charts/oai-5g-core/oai-5g-basic
helm dependency update
```
**NOTE**: Whenever you will make any change in the network function helm-chart or mysql helm chart you need to perform a dependency update to inform parent chart about the sub-charts update.
......@@ -276,90 +262,57 @@ $: helm dependency update
Helm charts have an order of deployment for the proper configuration of core network.
`mysql --> nrf --> udr --> udm --> ausf --> amf --> upf(spgwu) --> smf`
Once the configuration is finished the charts can be deployed with a user who has the rights to
1. Create RBAC (Optional only if Openshift is used)
2. Run pod with privileged and anyuid scc (optional only required if you have scc configure in your cluster)
2. Run pod (only UPF needs that) with privileged and anyuid scc (optional only required if you have scc configure in your cluster)
3. Create multus binds (optional only if multus is used)
``` shell
$: helm spray --namespace oai-tutorial .
[spray] processing chart from local file or directory "."...
[spray] deploying solution chart "." in namespace "oai-tutorial"
[spray] processing sub-charts of weight 0
[spray] > upgrading release "mysql": deploying first revision (appVersion 8.0.31)...
[spray] o release: "mysql" upgraded
[spray] > upgrading release "oai-nrf": deploying first revision (appVersion master-v1.5.0)...
[spray] o release: "oai-nrf" upgraded
[spray] > waiting for liveness and readiness...
[spray] processing sub-charts of weight 1
[spray] > upgrading release "oai-udr": deploying first revision (appVersion master-v1.5.0)...
[spray] o release: "oai-udr" upgraded
[spray] > waiting for liveness and readiness...
[spray] processing sub-charts of weight 2
[spray] > upgrading release "oai-udm": deploying first revision (appVersion v1.5.0)...
[spray] o release: "oai-udm" upgraded
[spray] > waiting for liveness and readiness...
[spray] processing sub-charts of weight 3
[spray] > upgrading release "oai-ausf": deploying first revision (appVersion master-v1.5.0)...
[spray] o release: "oai-ausf" upgraded
[spray] > waiting for liveness and readiness...
[spray] processing sub-charts of weight 4
[spray] > upgrading release "oai-amf": deploying first revision (appVersion master-v1.5.0)...
[spray] o release: "oai-amf" upgraded
[spray] > waiting for liveness and readiness...
[spray] processing sub-charts of weight 5
[spray] > upgrading release "oai-spgwu-tiny": deploying first revision (appVersion v1.5.0)...
[spray] o release: "oai-spgwu-tiny" upgraded
[spray] > waiting for liveness and readiness...
[spray] processing sub-charts of weight 6
[spray] > upgrading release "oai-smf": deploying first revision (appVersion master-v1.5.0)...
[spray] o release: "oai-smf" upgraded
[spray] > waiting for liveness and readiness...
[spray] upgrade of solution chart "." completed in 1m9s
$: export AMF_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-amf" -o jsonpath="{.items[0].metadata.name}")
$: export SMF_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-smf" -o jsonpath="{.items[0].metadata.name}")
$: export SPGWU_TINY_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-spgwu-tiny" -o jsonpath="{.items[0].metadata.name}")
$: export AMF_eth0_POD_IP=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-amf" -o jsonpath="{.items[0].status.podIP}")
```
This command can take around 5-7 mins depending on your network speed and cluster configuration (computational capacity)
helm install basic oai-5g-basic/
```
## 4.1 How to check if the Core network is properly configured?
<details>
<summary>The output is similar to:</summary>
Check the logs `smf` and `upf` to see that the PFCP session is properly configured,
```console
NAME: basic
LAST DEPLOYED: Tue Dec 12 10:04:40 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
```
</details>
<!---
For CI purposes please ignore this line (checking PFCP association)
``` shell
$: export SPGWU_log1=$(oc logs $SPGWU_TINY_POD_NAME spgwu | grep 'Received SX HEARTBEAT REQUEST')
$: export SPGWU_log2=$(oc logs $SPGWU_POD spgwu | grep 'handle_receive(16 bytes)')
$: [[ $SPGWU_log ]] && [[ $SPGWU_log2 ]]
This command can take around 3-5 mins depending on your network speed and cluster configuration (computational capacity). You can use the wait command to see if the core network functions are running or not
```shell
kubectl wait --for=condition=ready pod -l app.kubernetes.io/instance=basic --timeout=3m
```
-->
## 4.1 How to check if the Core network is properly configured?
Check the logs `smf` and `upf` to see that the PFCP session is properly configured,
```console
$: kubectl logs -c spgwu $SPGWU_TINY_POD_NAME -n oai-tutorial | grep 'Received SX HEARTBEAT REQUEST' | wc -l
$: kubectl logs -c smf $SMF_POD_NAME -n oai-tutorial | grep 'handle_receive(16 bytes)' | wc -l
kubectl logs -l app.kubernetes.io/name=oai-smf -n oai-tutorial | grep 'handle_receive(16 bytes)' | wc -l
kubectl logs -l app.kubernetes.io/name=oai-upf -n oai-tutorial | grep 'handle_receive(16 bytes)' | wc -l
```
If the value is more than 1 for both then it will verify that `smf` and `upf` have successfully registered to `nrf` and there is a PFCP session.
## 5 Testing with OAI gNB RFsimulator and NR-UE
## 5 Use Case 1: Testing with Monolithic RAN
The images which are used in the tutorial are already present in docker-hub like the other images of OAI 5g core network functions. The charts of all the network functions are preconfigured to work with OAI-gnB and OAI-NR-UE end to end installation.
### 5.1 Images OAI-gNB RFSimulator and OAI-NR-UE
### 5.1 Images OAI-gNB and OAI-NR-UE
For ubuntu based worker nodes the images can be pulled directly from docker-hub. To build images manually follow this [link](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/docker). In case you have an Openshift cluster then follow this [link](../openshift/README.)
For ubuntu based worker nodes the images can be pulled directly from docker-hub. To build images manually follow this [link](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/docker). In case you have an Openshift cluster then follow this [link](../openshift/README.md)
### 5.2 Configuring OAI-gNB RFSimulator and OAI-NR-UE
**Very Important** To access internet in NR-UE the N6/SGI interface of UPF/SPGWU should be able access the internet.
**Very Important** To access internet in NR-UE the N6/SGI interface of UPF should be able access the internet.
GNB requires the ip-address or service name of AMF. In case in AMF multus is used and N1/N2 interface is bind to multus interface, then please provide AMF ip-address.
......@@ -367,28 +320,18 @@ For this tutorial we are not using multus here for similicity, generally there s
```
## oai-gNB configuration from values.yaml
config:
mountConfig: false #If config file is mounted then please edit mount.conf in configmap.yaml properly
useSATddMono: true
timeZone: "Europe/Paris"
rfSimulator: "server"
useSATddMono: "yes"
gnbName: "gnb-rfsim"
mcc: "001" # check the information with AMF, SMF, UPF/SPGWU
mnc: "01" # check the information with AMF, SMF, UPF/SPGWU
mncLength: "2" # check the information with AMF, SMF, UPF/SPGWU
tac: "1" # check the information with AMF
nssaiSst: "1" #currently only 4 standard values are allowed 1,2,3,4
nssaiSd0: "ffffff" #values in hexa-decimal format
amfIpAddress: "oai-amf-svc" # amf ip-address or service-name oai-amf-svc
gnbNgaIfName: "eth0" # net1 in case multus create is true that means another interface is created for ngap interface, n2 to communicate with amf
gnbNgaIpAddress: "status.podIP" # n2n3IPadd in case multus create is true
gnbNguIfName: "eth0" #net1 in case multus create is true gtu interface for upf/spgwu
gnbNguIpAddress: "status.podIP" # n2n3IPadd in case multus create is true
useAdditionalOptions: "--sa -E --rfsim --log_config.global_log_options level,nocolor,time"
threadParallelConfig: "PARALLEL_SINGLE_THREAD"
sdrAddrs: "serial=XXXXXXX"
gnbName: "oai-gnb-rfsim"
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
usrp: rfsim #allowed values rfsim, b2xx, n3xx or x3xx
amfhost: "oai-amf" # amf ip-address or service-name oai-amf-svc or 172.21.6.94
n2IfName: "eth0" # if multus.n2Interface.create is true then use n2
n3IfName: "eth0"
```
### 5.3 Deploy OAI-gNB RFSimulator
......@@ -396,53 +339,68 @@ config:
To deploy the oai-gnb in rf simulator mode follow the below steps
``` shell
$: cd ../../oai-5g-ran/
$: helm install gnb oai-gnb --namespace oai-tutorial
helm install gnb oai-gnb
cd ../../oai-5g-ran/
helm install gnb oai-gnb --namespace oai-tutorial
```
<details>
<summary>The output is similar to:</summary>
```console
NAME: gnb
LAST DEPLOYED: Sun Jan 15 22:36:37 2023
LAST DEPLOYED: Tue Dec 12 10:46:53 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Get the application name by running these commands:
$: export GNB_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-gnb,app.kubernetes.io/instance=gnb" -o jsonpath="{.items[0].metadata.name}")
$: export GNB_eth0_IP=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-gnb,app.kubernetes.io/instance=gnb" -o jsonpath="{.items[*].status.podIP}")
2. Note: This helm chart of OAI-gNB is only tested in RF-simulator mode not tested with hardware on Openshift/Kubernetes Cluster
export GNB_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-gnb,app.kubernetes.io/instance=gnb" -o jsonpath="{.items[0].metadata.name}")
export GNB_eth0_IP=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-gnb,app.kubernetes.io/instance=gnb" -o jsonpath="{.items[*].status.podIP}")
2. Dockerhub images of OpenAirInterface requires avx2 capabilities in the cpu and they are built for x86 architecture, tested on UBUNTU OS only.
3. Note: This helm chart of OAI-gNB is only tested in RF-simulator mode and is not tested with USRPs/RUs on Openshift/Kubernetes Cluster
4. In case you want to test these charts with USRP/RU then make sure your underlying kernel is realtime and CPU sleep states are off.
Also for good performance it is better to use MTU 9000 for Fronthaul interface.
5. If you want to configure for a particular band then copy the configuration file in templates/configmap.yaml from here https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/targets/PROJECTS/GENERIC-NR-5GC/CONF
```
</details>
To check if gnB is connected, read the logs of amf and check N2 setup procedure was correct or not,
Wait for the gNB to start
<!---
For CI purposes please ignore this line (checking NG_SETUP_RESPONSE)
``` shell
$: export AMF_LOG=$(kubectl logs -c amf $AMF_POD_NAME | grep 'Sending NG_SETUP_RESPONSE Ok')
$: [[ $AMF_LOG ]]
```shell
kubectl wait --for=condition=ready pod -l app.kubernetes.io/name=oai-gnb --timeout=3m --namespace oai-tutorial
```
-->
To check if gnB is connected, read the logs of amf and check N2 setup procedure was correct or not,
```console
$: kubectl logs -c amf $AMF_POD_NAME -n oai-tutorial | grep 'Sending NG_SETUP_RESPONSE Ok'
[2022-04-22T15:42:45.370382] [AMF] [amf_n2 ] [debug] Sending NG_SETUP_RESPONSE Ok
kubectl logs --namespace oai-tutorial $(kubectl get pods --namespace oai-tutorial | grep oai-amf| awk '{print $1}') | grep 'Connected'
```
### 5.4 Configure OAI-NR-UE RFSimulator
<details>
<summary>The output is similar to:</summary>
```console
Defaulted container "amf" out of: amf, init (init)
[2023-12-12 09:47:54.854] [amf_app] [info] | 1 | Connected | 0xe000 | oai-gnb-rfsim | 001, 01 |
[2023-12-12 09:48:14.854] [amf_app] [info] | 1 | Connected | 0xe000 | oai-gnb-rfsim | 001, 01 |
```
</details>
NR-UE requires the ip-address of the gNB which you have acquired earlier, use that ip-address and configure it in `config.rfSimulator`. We are not using multus here just for similicity, generally there should be two interfaces.
### 5.4 Configure OAI-NR-UE RFSimulator
```
config:
timeZone: "Europe/Paris"
rfSimulator: "oai-gnb" # ip-address of gnb rf-sim or service name oai-gnb
rfSimServer: "oai-du" # ip-address of rfsim or service name oai-gnb in case of du change it with oai-du if multus is true then provide ip-address of oai-gnb
fullImsi: "001010000000100" # make sure all the below entries are present in the subscriber database
fullKey: "fec86ba6eb707ed08905757b1bb44b8f"
opc: "C42449363BBAD02B66D16BC975D77CC1"
dnn: "oai"
nssaiSst: "1" # configure according to gnb and amf, smf and upf
nssaiSd: "16777215" # This value means noSD as defined by 3GPP
useAdditionalOptions: "-E --sa --rfsim -r 106 --numerology 1 -C 3619200000 --nokrnmod"
dnn: "oai"
sst: "1" # configure according to gnb and amf, smf and upf
sd: "16777215"
usrp: "rfsim" # allowed rfsim, b2xx, n3xx, x3xx
useAdditionalOptions: "--sa --rfsim -r 106 --numerology 1 -C 3619200000 --nokrnmod --log_config.global_log_options level,nocolor,time"
```
### 5.5 Deploy OAI-NR-UE RFSimulator
......@@ -450,35 +408,49 @@ config:
To deploy the oai-nr-ue in rf simulator mode follow the below steps
``` shell
$: helm install nrue oai-nr-ue/ --namespace oai-tutorial
helm install nrue oai-nr-ue/
helm install nrue oai-nr-ue/ --namespace oai-tutorial
```
<details>
<summary>The output is similar to:</summary>
```console
NAME: nrue
LAST DEPLOYED: Sun Jan 15 22:40:10 2023
LAST DEPLOYED: Tue Dec 12 10:56:16 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Get the application name by running these commands:
$: export NR_UE_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-nr-ue,app.kubernetes.io/instance=nrue" -o jsonpath="{.items[0].metadata.name}")
2. Note: This helm chart of OAI-NR-UE is only tested in RF-simulator mode not tested with hardware on Openshift/Kubernetes Cluster
export NR_UE_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-nr-ue,app.kubernetes.io/instance=nrue" -o jsonpath="{.items[0].metadata.name}")
2. Dockerhub images of OpenAirInterface requires avx2 capabilities in the cpu and they are built for x86 architecture, tested on UBUNTU OS only.
3. Note: This helm chart of OAI-NR-UE is only tested in RF-simulator mode not tested with hardware on Openshift/Kubernetes Cluster
4. In case you want to test these charts with USRP then make sure your CPU sleep states are off```
</details>
```
Wait for the NR-UE to start
```shell
kubectl wait --for=condition=ready pod -l app.kubernetes.io/name=oai-nr-ue --timeout=3m --namespace oai-tutorial
```
Now you are start reading the logs of amf, smf and other network function to understand the message flow. Once the pdu session establishment procedure is finished you will receive an ip-address. You can start performing some testing.
check if the UE received an ip-address
<!---
For CI purposes please ignore this line (checking ue ip-address)
``` shell
$: export UE_IP_ADD=$(kubectl exec -it -c nr-ue $NR_UE_POD_NAME -- /bin/bash ifconfig net1 |grep -E '(^|\s)inet($|\s)' | awk {'print $2'})
$: [[ $UE_IP_ADD ]]
```console
kubectl exec -it -n oai-tutorial -c nr-ue $(kubectl get pods | grep oai-nr-ue | awk '{print $1}') -- ifconfig oaitun_ue1 |grep -E '(^|\s)inet($|\s)' | awk {'print $2'}
```
-->
<details>
<summary>The output is similar to:</summary>
```console
$: kubectl exec -it -n oai-tutorial -c nr-ue $NR_UE_POD_NAME -- ifconfig oaitun_ue1 |grep -E '(^|\s)inet($|\s)' | awk {'print $2'}
12.1.1.100
```
</details>
### 5.6 Performing some traffic testing
......@@ -486,7 +458,7 @@ $: kubectl exec -it -n oai-tutorial -c nr-ue $NR_UE_POD_NAME -- ifconfig oaitun_
Inside the nr-ue pod there is an extra tcdump container which can be use to perform traffic testing via iperf3 or
``` shell
$: kubectl exec -it -n oai-tutorial -c nr-ue $NR_UE_POD_NAME -- ping -I oaitun_ue1 -c4 google.fr
kubectl exec -it -n oai-tutorial -c nr-ue $(kubectl get pods | grep oai-nr-ue | awk '{print $1}') -- ping -I oaitun_ue1 -c4 google.fr
PING google.fr (216.58.213.67) from 12.1.1.100 oaitun_ue1: 56(84) bytes of data.
64 bytes from par21s18-in-f3.1e100.net (216.58.213.67): icmp_seq=1 ttl=117 time=27.0 ms
64 bytes from par21s18-in-f3.1e100.net (216.58.213.67): icmp_seq=2 ttl=117 time=22.3 ms
......@@ -498,66 +470,438 @@ PING google.fr (216.58.213.67) from 12.1.1.100 oaitun_ue1: 56(84) bytes of data.
rtt min/avg/max/mdev = 22.375/24.072/27.031/1.833 ms
## incase above doesn't work try with 8.8.8.8 instead of dns. If that works then probably you have't configure dns properly in SMF.
```
## 6 Use Case 2: Testing with F1 Split RAN
The images used for OAI-CU and OAI-DU are the same images used for OAI-gNB.
## 6.1 Configuration of OAI-CU and OAI-DU
**Very Important** To access internet in NR-UE the N6/SGI interface of UPF should be able access the internet.
OAI-CU requires the ip-address or service name of AMF. In case in AMF multus is used and N1/N2 interface is bind to multus interface, then please provide AMF ip-address.
For this tutorial we are not using multus here for similicity, generally there should be three interfaces of CU(for F1,N2, and N3).
```
## oai-cu configuration from values.yaml
config:
mountConfig: false #If config file is mounted then please edit mount.conf in configmap.yaml properly
timeZone: "Europe/Paris"
useAdditionalOptions: "--sa --log_config.global_log_options level,nocolor,time"
# If mounting the configuration file then below parameters are not used
cuName: "oai-cu"
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
amfhost: "oai-amf" # amf ip-address or service-name oai-amf-svc or 172.21.6.94
n2IfName: "eth0" # if multus.n2Interface.create is true then use n2
n3IfName: "eth0" #if multus.n3Interface.create is true then use n3 or you can only use 1 interface n2 or eth0
f1IfName: "eth0" #if multus.f1Interface.create is true then use multus.f1Interface.Ipadd
f1cuPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
f1duPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
```
### 5.7 Uninstall the helm charts
```
## oai-du configuration from values.yaml
config:
mountConfig: false #If config file is mounted then please edit mount.conf in templates/configmap.yaml properly
timeZone: "Europe/Paris"
useAdditionalOptions: "--sa --rfsim --log_config.global_log_options level,nocolor,time"
duName: "oai-du-rfsim"
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
usrp: rfsim #allowed values rfsim, b2xx, n3xx or x3xx
f1IfName: "eth0" #if multus.f1Interface.create is true then use f1
cuHost: "oai-cu" ## Ip-address or hostname
f1cuPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
f1duPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
```
You can remove them one by one or you can use this command
### 6.2 Deploy OAI-CU and OAI-DU (RFSimulator)
``` shell
$: helm uninstall -n oai-tutorial $(helm list -aq -n oai-tutorial)
helm install cu oai-cu --namespace oai-tutorial
```
<details>
<summary>The output is similar to:</summary>
```console
NAME: cu
LAST DEPLOYED: Tue Dec 12 11:49:40 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Get the application name by running these commands:
export GNB__CU_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-cu,app.kubernetes.io/instance=cu" -o jsonpath="{.items[0].metadata.name}")
export GNB_CU_eth0_IP=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-cu,app.kubernetes.io/instance=cu" -o jsonpath="{.items[*].status.podIP}")
2. Dockerhub images of OpenAirInterface requires avx2 capabilities in the cpu and they are built for x86 architecture, tested on UBUNTU OS only.
3. If you want to configure for a particular band then copy the configuration file in templates/configmap.yaml from here https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/targets/PROJECTS/GENERIC-NR-5GC/CONF
```
</details>
Wait for the oai-cu to start
```shell
kubectl wait --for=condition=ready pod -l app.kubernetes.io/name=oai-cu --namespace oai-tutorial --timeout=3m
```
<!---
For CI purposes please ignore this line (putting everything back)
Deploy oai-du
``` shell
$: cd ../oai-5g-core/
$: sed -i 's/amfIpAddress: '"$AMF_eth0_POD_IP"'/amfIpAddress: "0.0.0.0"/g' oai-gnb/values.yaml
$: sed -i 's/rfSimulator: '"$GNB_eth0_IP"'/rfSimulator: "0.0.0.0"/g' oai-nr-ue/values.yaml
$: mv oai-5g-basic/values.yaml.tmp oai-5g-basic/values.yaml
helm install du oai-du --namespace oai-tutorial
```
-->
<details>
<summary>The output is similar to:</summary>
```console
NAME: du
LAST DEPLOYED: Tue Dec 12 11:53:20 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Get the application name by running these commands:
export GNB_DU_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-du,app.kubernetes.io/instance=du" -o jsonpath="{.items[0].metadata.name}")
export GNB_DU_eth0_IP=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-du,app.kubernetes.io/instance=du" -o jsonpath="{.items[*].status.podIP}")
2. Dockerhub images of OpenAirInterface requires avx2 capabilities in the cpu and they are built for x86 architecture, tested on UBUNTU OS only.
3. Note: This helm chart of oai-du is only tested in RF-simulator mode and is not tested with USRPs/RUs on Openshift/Kubernetes Cluster
4. In case you want to test these charts with USRP/RU then make sure your underlying kernel is realtime and CPU sleep states are off
5. If you want to configure for a particular band then copy the configuration file in templates/configmap.yaml from here https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/targets/PROJECTS/GENERIC-NR-5GC/CONF
```
</details>
Wait for the oai-du to start
## 6. Extra
```shell
kubectl wait --for=condition=ready pod -l app.kubernetes.io/name=oai-du --namespace oai-tutorials --timeout=3m
```
### 6.1 How to install helm spray plugin?
To check if oai-du is connected to oai-cu, read the logs of cu and check F1 setup procedure was correct or not,
``` console
$: helm plugin install https://github.com/ThalesGroup/helm-spray
Downloading and installing spray v4.0.0...
Installed plugin: spray
-bash-4.2$ helm plugin list
NAME VERSION DESCRIPTION
spray 4.0.0 Helm plugin for upgrading sub-charts from umbrella chart with dependency orders
```console
kubectl logs --namespace oai-tutorial $(kubectl get pods --namespace oai-tutorial | grep oai-cu| awk '{print $1}') | grep 'Received F1 Setup Request'
```
<details>
<summary>The output is similar to:</summary>
```console
838801.974035 [NR_RRC] I Received F1 Setup Request from gNB_DU 3584 (oai-du-rfsim) on assoc_id 189
```
</details>
To check if oai-cu is connected to amf, read the logs of amf and check N2 setup procedure was correct or not,
```console
kubectl logs --namespace oai-tutorial $(kubectl get pods --namespace oai-tutorial | grep oai-amf| awk '{print $1}') | grep 'Connected'
```
<details>
<summary>The output is similar to:</summary>
```console
Defaulted container "amf" out of: amf, init (init)
[2023-12-12 10:49:54.879] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
[2023-12-12 10:50:14.880] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
[2023-12-12 10:50:34.880] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
[2023-12-12 10:50:54.880] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
[2023-12-12 10:51:14.880] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
```
</details>
### 6.2 How to capture pcaps inside a network function?
After this follow the same procedure to start oai-nr-ue and ping to see if the UE is connected.
## 7 Use Case 3: Testing with E1 and F1 Split RAN
The images used for OAI-CU-CP and OAI-DU are the same images used for OAI-gNB. OAI-CU-UP uses a different image which is present in [docker-hub](https://hub.docker.com/r/oaisoftwarealliance/oai-nr-cuup).
## 6.1 Configuration of OAI-CU and OAI-DU
**Very Important** To access internet in NR-UE the N6/SGI interface of UPF should be able access the internet.
OAI-CU-CP requires the ip-address or service name of AMF. In case in AMF multus is used and N1/N2 interface is bind to multus interface, then please provide AMF ip-address.
For this tutorial we are not using multus here for similicity, generally there should be three interfaces of CU-CP(for F1,N2 and E1).
```
## oai-cu-cp configuration from values.yaml
config:
timeZone: "Europe/Paris"
useAdditionalOptions: "--sa --log_config.global_log_options level,nocolor,time"
cucpName: "oai-cu-cp"
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
amfhost: "oai-amf" # amf ip-address or service-name oai-amf-svc or 172.21.6.94
n2IfName: "eth0" # if multus.n2Interface.create is true then use n2
n3IfName: "eth0" #if multus.n3Interface.create is true then use n3 or you can only use 1 interface n2 or eth0
f1IfName: "eth0" #if multus.f1Interface.create is true then use multus.f1Interface.Ipadd
e1IfName: "eth0" #if multus.f1Interface.create is true then use multus.f1Interface.Ipadd
f1cuPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
f1duPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
```
```
## oai-cu-up configuration from values.yaml
config:
timeZone: "Europe/Paris"
useAdditionalOptions: "--sa"
cuupName: "oai-cuup"
mcc: "001" # check the information with AMF, SMF, UPF/SPGWU
mnc: "01" # check the information with AMF, SMF, UPF/SPGWU
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
cuCpHost: "oai-cu" #
n2IfName: "eth0" # if multus.n2Interface.create is true then use n2
n3IfName: "eth0" #if multus.n3Interface.create is true then use n3 or you can only use 1 interface n2 or eth0
f1IfName: "eth0" #if multus.f1uInterface.create is true then use multus.f1uInterface.Ipadd
e1IfName: "eth0" #if multus.e1Interface.create is true then use multus.e1Interface.Ipadd
f1cuPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
f1duPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
```
```
## oai-du configuration from values.yaml
config:
mountConfig: false #If config file is mounted then please edit mount.conf in templates/configmap.yaml properly
timeZone: "Europe/Paris"
useAdditionalOptions: "--sa --rfsim --log_config.global_log_options level,nocolor,time"
duName: "oai-du-rfsim"
mcc: "001" # check the information with AMF, SMF, UPF
mnc: "01" # check the information with AMF, SMF, UPF
tac: "1" # check the information with AMF
sst: "1" #currently only 4 standard values are allowed 1,2,3,4
usrp: rfsim #allowed values rfsim, b2xx, n3xx or x3xx
f1IfName: "eth0" #if multus.f1Interface.create is true then use f1
cuHost: "oai-cu" ## Ip-address or hostname
f1cuPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
f1duPort: "2153" #2153 if using same interface for f1 and n3 else standard port 2152 should be use if f1 and n3 interface are different
```
## 7.1 Deploy OAI-CU-CP, OAI-CU-UP and OAI-DU
``` shell
helm install cucp oai-cu-cp --namespace oai-tutorial
```
<details>
<summary>The output is similar to:</summary>
```console
NAME: cu
LAST DEPLOYED: Tue Dec 12 11:49:40 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Get the application name by running these commands:
export GNB__CU_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-cu,app.kubernetes.io/instance=cu" -o jsonpath="{.items[0].metadata.name}")
export GNB_CU_eth0_IP=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-cu,app.kubernetes.io/instance=cu" -o jsonpath="{.items[*].status.podIP}")
2. Dockerhub images of OpenAirInterface requires avx2 capabilities in the cpu and they are built for x86 architecture, tested on UBUNTU OS only.
3. If you want to configure for a particular band then copy the configuration file in templates/configmap.yaml from here https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/targets/PROJECTS/GENERIC-NR-5GC/CONF
```
</details>
Wait for the oai-cu-cp to start
```shell
kubectl wait --for=condition=ready pod -l app.kubernetes.io/name=oai-cu-cp --timeout=3m
```
Deploy oai-cu-up
``` shell
helm install cuup oai-cu-up --namespace oai-tutorial
```
<details>
<summary>The output is similar to:</summary>
```console
NAME: cuup
LAST DEPLOYED: Tue Dec 12 12:13:43 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Get the application name by running these commands:
export GNB__CU_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-cu-up,app.kubernetes.io/instance=cuup" -o jsonpath="{.items[0].metadata.name}")
2. Dockerhub images of OpenAirInterface requires avx2 capabilities in the cpu and they are built for x86 architecture, tested on UBUNTU OS only.
3. If you want to configure for a particular band then copy the configuration file in templates/configmap.yaml from here https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/targets/PROJECTS/GENERIC-NR-5GC/CONF
4. For good performance make sure your underlying kernel is realtime and CPU sleep states are off
```
</details>
Wait for the oai-cu-cp to start
```shell
kubectl wait --for=condition=ready pod -l app.kubernetes.io/name=oai-cu-up --namespace oai-tutorial --timeout=3m
```
To check if oai-cu-up is connected to oai-cu-up, read the logs of cu-cp and check E1 setup procedure was correct or not,
```console
kubectl logs --namespace oai-tutorial $(kubectl get pods --namespace oai-tutorial | grep oai-cu-cp| awk '{print $1}') | grep 'Accepting new CU-UP ID'
```
<details>
<summary>The output is similar to:</summary>
```console
840052.554668 [RRC] I Accepting new CU-UP ID 3584 name oai-cuup (assoc_id 193)
```
</details>
Deploy oai-du
``` shell
helm install du oai-du --namespace oai-tutorial
```
<details>
<summary>The output is similar to:</summary>
```console
NAME: du
LAST DEPLOYED: Tue Dec 12 11:53:20 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Get the application name by running these commands:
export GNB_DU_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-du,app.kubernetes.io/instance=du" -o jsonpath="{.items[0].metadata.name}")
export GNB_DU_eth0_IP=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-du,app.kubernetes.io/instance=du" -o jsonpath="{.items[*].status.podIP}")
2. Dockerhub images of OpenAirInterface requires avx2 capabilities in the cpu and they are built for x86 architecture, tested on UBUNTU OS only.
3. Note: This helm chart of oai-du is only tested in RF-simulator mode and is not tested with USRPs/RUs on Openshift/Kubernetes Cluster
4. In case you want to test these charts with USRP/RU then make sure your underlying kernel is realtime and CPU sleep states are off
5. If you want to configure for a particular band then copy the configuration file in templates/configmap.yaml from here https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/targets/PROJECTS/GENERIC-NR-5GC/CONF
```
</details>
Wait for the oai-du to start
```shell
kubectl wait --for=condition=ready pod -l app.kubernetes.io/name=oai-du --timeout=3m --namespace oai-tutorial
```
To check if oai-du is connected to oai-cu, read the logs of cu and check F1 setup procedure was correct or not,
```console
kubectl logs --namespace oai-tutorial $(kubectl get pods --namespace oai-tutorial | grep oai-cu-cp| awk '{print $1}') | grep 'Received F1 Setup Request'
```
<details>
<summary>The output is similar to:</summary>
```console
838801.974035 [NR_RRC] I Received F1 Setup Request from gNB_DU 3584 (oai-du-rfsim) on assoc_id 189
```
</details>
To check if oai-cu-cp is connected to amf, read the logs of amf and check N2 setup procedure was correct or not,
```console
kubectl logs --namespace oai-tutorial $(kubectl get pods --namespace oai-tutorial | grep oai-amf| awk '{print $1}') | grep 'Connected'
```
<details>
<summary>The output is similar to:</summary>
```console
Defaulted container "amf" out of: amf, init (init)
[2023-12-12 10:49:54.879] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
[2023-12-12 10:50:14.880] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
[2023-12-12 10:50:34.880] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
[2023-12-12 10:50:54.880] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
[2023-12-12 10:51:14.880] [amf_app] [info] | 1 | Connected | 0xe000 | oai-cu | 001, 01 |
```
</details>
After this follow the same procedure to start oai-nr-ue and ping to see if the UE is connected.
### 8 Uninstall the helm charts
You can remove them one by one or you can use this command
``` shell
helm uninstall -n oai-tutorial $(helm list -aq -n oai-tutorial)
```
## 9. Extra
### 9.1 How to capture pcaps inside a network function?
We have specially provided a sperate container to capture pcap for each network function you can get inside this container and use tcpdump command
```console
$: kubectl exec -it -c tcpdump $AMF_POD_NAME -- /bin/sh
$: tcpdump -i any -n
kubectl exec -it -c tcpdump $AMF_POD_NAME -- /bin/sh
tcpdump -i any -n
```
## 6.3 Resource Consumption of Network Functions
## 9.2 Resource Consumption of Network Functions
Below resource consumption is observered using Kubernetes metrics server while NR-UE was pinging to `google.fr`
**Use case 1**
```console
kubectl top pods -n oai-tutorial
NAME CPU(cores) MEMORY(bytes)
basic-mysql-7c87d8cfbf-c6psl 3m 336Mi
oai-amf-757f8dfb64-59k76 14m 5Mi
oai-ausf-6dcc8cc79d-vlxmb 29m 2Mi
oai-gnb-6d48896787-vl5sr 2253m 1348Mi
oai-nr-ue-85b79b968f-x85px 1242m 622Mi
oai-nrf-6ddd875c45-dt7hz 31m 3Mi
oai-smf-5bf8b96d74-cg7s4 13m 5Mi
oai-udm-5994fc6847-tpzgw 30m 3Mi
oai-udr-754d6cd48-f6n7n 29m 4Mi
oai-upf-6576bc8496-jnpxl 11m 97Mi
```
**Use case 2**
```console
$: kubectl top pods -n oai-tutorial
NAME CPU(cores) MEMORY(bytes)
mysql-6d95f95fb5-pf94d 6m 469Mi
oai-amf-597cdbd99f-hbsbk 8m 4Mi
oai-ausf-59d6784cfd-bx5p7 16m 2Mi
oai-gnb-7bf557fb94-z4znz 1566m 1030Mi
oai-nr-ue-7b45d698bb-ghhhq 1104m 537Mi
oai-nrf-59f5c8cff5-wqnsx 17m 3Mi
oai-smf-5597cf5887-s6vpw 6m 4Mi
oai-spgwu-tiny-58587dfc58-rsn2b 13m 3Mi
oai-udm-57567fd4c8-vkvw4 16m 2Mi
oai-udr-68466f688-hc5b6 16m 3Mi
```
\ No newline at end of file
kubectl top pods
NAME CPU(cores) MEMORY(bytes)
basic-mysql-7c87d8cfbf-c6psl 3m 336Mi
oai-amf-757f8dfb64-59k76 13m 5Mi
oai-ausf-6dcc8cc79d-vlxmb 32m 2Mi
oai-cu-76fb9cbb4f-8pg7l 7m 116Mi
oai-du-7d7b665f6f-sb55f 803m 1338Mi
oai-nrf-6ddd875c45-dt7hz 32m 3Mi
oai-smf-5bf8b96d74-cg7s4 12m 6Mi
oai-udm-5994fc6847-tpzgw 32m 3Mi
oai-udr-754d6cd48-f6n7n 32m 4Mi
oai-upf-6576bc8496-jnpxl 11m 132Mi
```
**Use case 3**
```console
kubectl top pods
NAME CPU(cores) MEMORY(bytes)
basic-mysql-7c87d8cfbf-c6psl 3m 336Mi
oai-amf-757f8dfb64-59k76 13m 5Mi
oai-ausf-6dcc8cc79d-vlxmb 28m 2Mi
oai-cu-cp-86bf5df746-sf5jl 2m 116Mi
oai-cu-up-54c8d9b97f-tfvmz 1m 55Mi
oai-du-7d7b665f6f-9x7zq 1777m 1338Mi
oai-nr-ue-85b79b968f-w499m 1182m 532Mi
oai-nrf-6ddd875c45-dt7hz 29m 3Mi
oai-smf-5bf8b96d74-cg7s4 12m 6Mi
oai-udm-5994fc6847-tpzgw 29m 3Mi
oai-udr-754d6cd48-f6n7n 28m 4Mi
oai-upf-6576bc8496-jnpxl 11m 130Mi
```
docs/DEPLOY_SA5G_HC_mini.md deleted 100644 → 0
+ 0
− 504
View file @ 36d9bcab
<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 using Helm Charts</font></b>
</td>
</tr>
</table>
OAI 5G core network have different network functions which can be used invidiually or deployed all together in different combination on a production grade Kubernetes cluster like Openshift or a vanilla kubernetes cluster.
![Helm Chart Deployment](./images/helm-chart-mini.png)
**Reading time**: ~30
**Tutorial replication time**: ~40 mins
**TABLE OF CONTENTS**
1. [Description](#1-description)
2. [Fetching Network Function Images](#2-fetching-network-function-images)
3. [Configuring Helm Charts](#3-configuring-helm-charts)
4. [Deploying 5g Core Helm Charts](#4-deploying-helm-charts)
5. [Optional: Testing with OAI gNB RFsimulator and NR-UE](#5-testing-with-oai-gnb-rfsimulator-and-nr-ue)
6. [Extra](#6-extra)
### Pre-requisite
The cluster on which these helm charts will be deployed should have RBAC and [Multus CNI](https://github.com/k8snetworkplumbingwg/multus-cni). Multus is necessary to provide multiple interfaces to AMF and UPF/SPGWU. In case you don't have multus CNI for seconary network interface inside the pod you can still use the ethernet interface provided by the primary CNI. This type of setting is only recommended for playing with rfsimulator. In case you are using minikube or any other Kubernetes deployer make sure you have minimum 4 CPU and 16 GBi of ram.
Clone the git repository
```console
$: git clone -b <Branch> https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed
```
## 1. Description
The helm charts can be used on any production grade kubernetes cluster or even vanilla kubernetes. We have also tested on a single node 4 CPU and 16GB ram minikube cluster with docker virtualization environment. In our testing environment we deploy these charts on our inhouse Openshift clusters the cluster information can be found below.
| Software | Version |
|:--------------------------------|:---------------------------------------|
| Openshift Client Version | 4.9.X |
| Kubernetes Version | Kubernetes Version: v1.22.5+5c84e52 |
| helm | v3.6.2+5.el8 |
| helm-spray (plugin) | v4.0.10 |
| Base images of Network functions| Ubuntu 18.04/20.04/22.04/UBI 8.X(RHEL8)|
**NOTE**: For gNB the host machines should have `avx2` to find out you can use `lscpu | grep avx2`
We are deploying the helm charts using `helm spray` plugin of `helm` as the network functions have dependency and they are required to be deployed in a certain order. To get more information on helm spray you can follow this [link](https://github.com/ThalesGroup/helm-spray).
For the moment we provide helm charts of inidividual network functions, udr, udm, ausf, amf, nrf, smf, upf and nssf. To make the deployment of the network function easier we provide three different settings in which they can be deployed
1. Minimalist deployment: Mysql (Subscriber Database), AMF, SMF, UPF, NRF
2. Basic deployment: Mysql (Subscriber Database), UDR, UDM, AUSF, AMF, SMF, UPF, NRF
3. Slicing support: Mysql (Subscriber Database), NSSF, UDR, UDM, AUSF, AMF, SMF, UPF, NRF
In this tutorial we will deploy a minimalist setting of OAI 5g core network and will deploy oai-gNB and oai-nr-ue in rf-simulator mode to perform some traffic testing. You can also deploy the core network in other two settings. It all depends on your use case and testbed. The configuration parameters of helm charts are the same as `docker-compose` so if you know how to configure `docker-compose` yaml file you can configure the helm charts `value.yaml`.
## 2. Fetching Network Function Images
Ubuntu base images can be pulled from [docker-hub](https://hub.docker.com/u/oaisoftwarealliance) but if you want to make some changes in the code then you should build your own images. If you will use Ubuntu images then skip this part and in section `3.1` there is a detailed procedure. In case of RHEL based worker node you have to build your own images, to download packages from RHEL repository you need a developer or enterprise account. To learn how to build UBI 8.6 images follow this [tutorial](./openshift/README.md)
OAI network functions can be build on ubuntu 18.04/20.04/22.04 or UBI 8.6 base images. Follow the tutorial on [how to build images](./BUILD_IMAGES.md) depending on the cluster/worker-node operating system.
## 3. Configuring Helm Charts
```console
$: cd oai-cn5g-fed
$: ls charts/
oai-5g-core oai-5g-ran simulators testing
$: ls charts/oai-5g-core/
mysql oai-5g-basic oai-5g-mini oai-5g-slicing oai-amf oai-ausf oai-nrf oai-nssf oai-smf oai-spgwu-tiny oai-udm oai-udr
$: ls charts/oai-5g-ran/
oai-gnb oai-gnb-cu oai-gnb-du oai-nr-ue
$: ls charts/simulators/
gnbsim
$: ls charts/testing/
testing-pod.yaml
```
All the OAI core network charts are present in `oai-5g-core` folder. There you can find charts of individual network functions and for the above described three different deployment settings.
1. Folder `oai-5g-mini` is for [minimilist deployment](../charts/oai-5g-core/oai-5g-mini)
2. Folder `oai-5g-basic` is for [basic deployment](../charts/oai-5g-core/oai-5g-basic)
3. Folder `oai-5g-slicing` is for [slicing deployment](../charts/oai-5g-core/oai-5g-slicing)
These charts are configured keeping in mind 5G service based architecture. If you want to deploy using reference based architecture then you need to make sure each network functions can connect to each other using IP-Address or service name.
The structure of all these folders is similar,
```
oai-5g-mini/
├── Chart.yaml
└── values.yaml
0 directories, 2 files
```
In the `values.yaml` file we have put only those configuration parameters which we think are really necessary and they should be changed based on PLMN, DNN and sim card information. In case you want to change some other parameters we suggest you go in the helm charts of the respective network function and do the changes there.
Helm chart of every network function looks similar and has the below structure. Only the chart of mysql database and NRF is different.
```
Network_function/
├── Chart.yaml
├── templates
│ ├── configmap.yaml
│ ├── deployment.yaml
│ ├── _helpers.tpl
│ ├── multus.yaml
│ ├── NOTES.txt
│ ├── rbac.yaml
│ ├── serviceaccount.yaml
| └── service.yaml
└── values.yaml
1 directory, 10 files
```
All the configurable parameters for a particular commit/release are mentioned in the `values.yaml` file. These parameters will keep on changing in the future depending on the nature of development and features.
All the network function related configurable parameters are in the sections `config` of the `values.yaml`.
Create a namespace where the helm-charts will be deployed, in our environment we deploy them in `oai-tutorial` namespace. To create a namespace use the below command on your cluster,
```console
# needs a user which has the right to create namespaces
$: kubectl create ns oai-tutorial
or
$: oc new-project oai-tutorial
```
**NOTE**: Any changes done in the parent chart (Mini, basic, slicing scenario helm charts) will overwrite the sub charts.
### 3.1 Pulling Images
To pull images from docker-hub, it will be good to configure an image pull secrete because of the recent limit of 100 pulls in docker-hub from an anonymous account. If you provide a personal/company account the limit is different.
```bash
#kubernetes
$: kubectl create secret docker-registry regcred --docker-server=https://index.docker.io/v1/ --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
#openshift
$: oc create secret docker-registry regcred --docker-server=https://index.docker.io/v1/ --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
```
There are more ways to make docker secrete you can follow this [link](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). After this mention this in the `values.yaml` of each network function
```
## good to use when pulling images from docker-hub
imagePullSecrets:
- name: regcred
```
When pulling images from docker hub you have several choices either to use images with develop tag (based on latest develop branch somtimes might not be stable), latest (built from current master branch) and release tags.
### 3.2 Networking Related Information
Network functions communicate based on **kubernetes service concept**, the network functions are using service name/FQDN of other network functions to use their service.
*For example: AMF registers with NRF using NRF FQDN (`oai-nrf-svc.oai.svc.cluster.local`). This way we can get rid of any static ip-address configuration. Though we are still keeping the fields where we are mentioning ip-addresses for example `nrfIpv4Addr` in amf values.yaml but that is not being used if `USE_FQDN_DNS` is set to `true`*
#### 3.2.1 Configure Multiple Interfaces
- Here the network functions will use different virtual ethernet interfaces to bind their different logical interface. Example AMF communicates with gNB using N2 and with SMF and NRF using Namf, the Service Base Interface (SBI).
- This type of configuration is also used when gNB is outside of the cluster or UPF is outside of the cluster.
- To make the above seperation we are using multus to provide multiple ethernet interfaces to network functions which have multiple communication interfaces.
- Only AMF, SMF and UPF have the possiblity to use multus. Other network functions can also use multus but then it needs to be configured.
- To configure multus for AMF, SMF or UPF, in `values.yaml` of each network function edit the multus section.
```
## Example from oai-amf/values.yaml
multus:
create: true
n2IPadd: "<provide-an-ip-address>"
n2Netmask: "<provide-a-netmask>"
n2Gateway: "<Gateway>"
```
#### 3.2.2 Use Single Interface
- No need to configure multus for any network function. For different communication interfaces network functions will use same ethernet interface. Example AMF will use `eth0` interface to communicate with gNB, SMF and NRF.
- In `values.yaml` of AMF, SMF and UPF in multus section do multus.create `false` like below,
```
## Example from oai-amf/values.yaml
multus:
create: false (change only this)
```
#### 3.2.3 Capturing Packets (Optional)
Every network function has an extra TCP dump container to take the TCP dump. But by default this container start in sleep mode and does not capture the dumps on any interface. If enabled it will capture dumps on `all interfaces` and will store inside the container locally or in a persistant volume if enabled.
To enable the persistant volume in the `values.yaml` of every network function make the below change,
```
## in case of nrf but it same for every network function
start:
nrf: start
tcpdump: start #start tcpdump collection to analyse but beware it will take a lot of space in the container/persistent volume
persistence:
sharedvolume: true
volumneName: <configure-your-storage-name>
size: <configure-the-size> #example 1Gi
```
## 3.3 Configuring Helm Chart Parameters
In the [values.yaml](../charts/oai-5g-core/oai-5g-mini) of oai-5g-mini helm charts you will see the configurable parameters for all the network functions check, the PLMN, DNN and subscriber information in mysql database
For minimalist deployment check the database [oai_db-mini.sql](../charts/oai-5g-core/mysql/initialization/oai_db-mini.sql)
A new subscriber entry can be added directly in the sql file or it can be added once the core network is already deployed.
```sql
$: vim/vi/nano charts/oai-5g-core/mysql/initialization/oai_db-mini.sql
# Add a new or edit existing entries after users table
INSERT INTO `users` VALUES ('IMSI','41','55000000000012',NULL,'PURGED',50,40000000,100000000,47,0000000000,1,0x'key',0,0,0x40,'ebd07771ace8677a',0x'opc');
```
In case you are looking for some other paramter which are not available in the `values.yaml` file of the oai-5g-mini chart then check in the invidual chart of the network function.
Once the charts are configured perform helm dependency update inside the chart repository
``` shell
$: cd charts/oai-5g-core/oai-5g-mini
$: helm dependency update
```
**NOTE**: Whenever you will make any change in the network function helm-chart or mysql helm chart you need to perform a dependency update to inform parent chart about the sub-charts update.
## 4. Deploying Helm Charts
The network functions need to be deployed in an order, we are working towards removing this order from network function.
`mysql --> nrf --> amf --> upf(spgwu) --> smf`
Once the configuration is finished the charts can be deployed with a user who has the rights to
1. Create RBAC (Only needed in Openshift)
2. Run pod with privileged and anyuid scc (optional only required if you have scc configure in your cluster)
3. Create multus binds (optional only if you use multus)
``` shell
# Expecting current directory to be oai-5g-mini
$: helm spray --namespace oai-tutorial .
[spray] processing chart from local file or directory "."...
[spray] deploying solution chart "." in namespace "default"
[spray] processing sub-charts of weight 0
[spray] > upgrading release "mysql": deploying first revision (appVersion 8.0.31)...
[spray] o release: "mysql" upgraded
[spray] > upgrading release "oai-nrf": deploying first revision (appVersion master-v1.5.0)...
[spray] o release: "oai-nrf" upgraded
[spray] > waiting for liveness and readiness...
[spray] processing sub-charts of weight 2
[spray] > upgrading release "oai-amf": deploying first revision (appVersion master-v1.5.0)...
[spray] o release: "oai-amf" upgraded
[spray] > waiting for liveness and readiness...
[spray] processing sub-charts of weight 3
[spray] > upgrading release "oai-spgwu-tiny": deploying first revision (appVersion v1.5.0)...
[spray] o release: "oai-spgwu-tiny" upgraded
[spray] > waiting for liveness and readiness...
[spray] processing sub-charts of weight 4
[spray] > upgrading release "oai-smf": deploying first revision (appVersion master-v1.5.0)...
[spray] o release: "oai-smf" upgraded
[spray] > waiting for liveness and readiness...
[spray] upgrade of solution chart "." completed in 47s
$: export AMF_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-amf" -o jsonpath="{.items[0].metadata.name}")
$: export SMF_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-smf" -o jsonpath="{.items[0].metadata.name}")
$: export SPGWU_TINY_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-spgwu-tiny" -o jsonpath="{.items[0].metadata.name}")
$: export AMF_eth0_POD_IP=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-amf" -o jsonpath="{.items[0].status.podIP}")
```
```console
$: kubectl get pods --namespace oai-tutorial
NAME READY STATUS RESTARTS AGE
mysql-6d95f95fb5-stl4j 1/1 Running 0 11m
oai-amf-597cdbd99f-6kmrr 2/2 Running 0 10m
oai-nrf-59f5c8cff5-w7596 2/2 Running 0 11m
oai-smf-5597cf5887-h5tpq 2/2 Running 0 10m
oai-spgwu-tiny-58587dfc58-mw8m9 2/2 Running 0 10m
```
## 4.1 How to check if the Core network is properly configured?
Check the logs `smf` and `upf` to see that the PFCP session is properly configured,
```console
$: kubectl logs -c spgwu $SPGWU_TINY_POD_NAME -n oai-tutorial | grep 'Received SX HEARTBEAT REQUEST' | wc -l
$: kubectl logs -c smf $SMF_POD_NAME -n oai-tutorial | grep 'handle_receive(16 bytes)' | wc -l
```
If the value is more than 1 for both then it will verify that `smf` and `upf` have successfully registered to `nrf` and there is a PFCP session.
Now go ahead and use OAI-gNB/gNBSIM or any other gNB or emulator to test the deployed core network.
## 5 Testing with OAI gNB RFsimulator and NR-UE
The images which are used in the tutorial are already present in docker-hub like the other images of OAI 5g core network functions. The charts of all the network functions are preconfigured to work with OAI-gnB and OAI-NR-UE end to end installation.
### 5.1 Images OAI-gNB RFSimulator and OAI-NR-UE
For ubuntu based worker nodes the images can be pulled directly from docker-hub. To build images manually follow this [link](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/docker). In case you have an Openshift cluster then follow this [link](../openshift/README.)
### 5.2 Configuring OAI-gNB RFSimulator and OAI-NR-UE
**Very Important** To access internet in NR-UE the N6/SGI interface of UPF/SPGWU should be able access the internet.
GNB requires the ip-address or service name of AMF. In case in AMF multus is used and N1/N2 interface is bind to multus interface, then please provide AMF ip-address.
For this tutorial we are not using multus here for similicity, generally there should be two interfaces of gNB(for N2 and N3).
```
## oai-gNB configuration from values.yaml
config:
mountConfig: false #If config file is mounted then please edit mount.conf in configmap.yaml properly
useSATddMono: true
timeZone: "Europe/Paris"
rfSimulator: "server"
useSATddMono: "yes"
gnbName: "gnb-rfsim"
mcc: "001" # check the information with AMF, SMF, UPF/SPGWU
mnc: "01" # check the information with AMF, SMF, UPF/SPGWU
mncLength: "2" # check the information with AMF, SMF, UPF/SPGWU
tac: "1" # check the information with AMF
nssaiSst: "1" #currently only 4 standard values are allowed 1,2,3,4
nssaiSd0: "ffffff" #This value means noSD as defined by 3GPP
amfIpAddress: "oai-amf-svc" # amf ip-address or service-name oai-amf-svc
gnbNgaIfName: "eth0" # net1 in case multus create is true that means another interface is created for ngap interface, n2 to communicate with amf
gnbNgaIpAddress: "status.podIP" # n2n3IPadd in case multus create is true
gnbNguIfName: "eth0" #net1 in case multus create is true gtu interface for upf/spgwu
gnbNguIpAddress: "status.podIP" # n2n3IPadd in case multus create is true
useAdditionalOptions: "--sa -E --rfsim --log_config.global_log_options level,nocolor,time"
threadParallelConfig: "PARALLEL_SINGLE_THREAD"
sdrAddrs: "serial=XXXXXXX"
```
### 5.3 Deploy OAI-gNB RFSimulator
To deploy the oai-gnb in rf simulator mode follow the below steps
``` shell
$: cd ../../oai-5g-ran/
$: helm install gnb oai-gnb --namespace oai-tutorial
helm install gnb oai-gnb
NAME: gnb
LAST DEPLOYED: Sun Jan 15 22:36:37 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Get the application name by running these commands:
$: export GNB_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-gnb,app.kubernetes.io/instance=gnb" -o jsonpath="{.items[0].metadata.name}")
$: export GNB_eth0_IP=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-gnb,app.kubernetes.io/instance=gnb" -o jsonpath="{.items[*].status.podIP}")
2. Note: This helm chart of OAI-gNB is only tested in RF-simulator mode not tested with hardware on Openshift/Kubernetes Cluster
```
To check if gnB is connected, read the logs of amf and check N2 setup procedure was correct or not,
```console
$: kubectl logs -c amf $AMF_POD_NAME | grep 'Sending NG_SETUP_RESPONSE Ok'
[2022-04-22T15:42:45.370382] [AMF] [amf_n2 ] [debug] Sending NG_SETUP_RESPONSE Ok
```
**NOTE** In case you get an error like below then please check `echo $AMF_POD_NAME` gives the name of the AMF pod. In case not then export AMF name to `AMF_POD_NAME` variable.
``` console
$: kubectl logs -c amf $AMF_POD_NAME | grep 'Sending NG_SETUP_RESPONSE Ok'
error: expected 'logs [-f] [-p] (POD | TYPE/NAME) [-c CONTAINER]'.
POD or TYPE/NAME is a required argument for the logs command
See 'kubectl logs -h' for help and examples
```
### 5.4 Configure OAI-NR-UE RFSimulator
NR-UE requires the ip-address or service name of the gNB. Configure the service name or ip-address in `config.rfSimulator`. The charts are already configured.
We are not using multus here just for similicity, generally there should be two interfaces.
```
config:
timeZone: "Europe/Paris"
rfSimulator: "oai-gnb" # ip-address of gnb rf-sim or service name oai-gnb
fullImsi: "001010000000100" # make sure all the below entries are present in the subscriber database
fullKey: "fec86ba6eb707ed08905757b1bb44b8f"
opc: "C42449363BBAD02B66D16BC975D77CC1"
dnn: "oai"
nssaiSst: "1" # configure according to gnb and amf, smf and upf
nssaiSd: "16777215" # This value means noSD as defined by 3GPP
useAdditionalOptions: "-E --sa --rfsim -r 106 --numerology 1 -C 3619200000 --nokrnmod"
```
### 5.5 Deploy OAI-NR-UE RFSimulator
To deploy the oai-nr-ue in rf simulator mode follow the below steps
``` shell
$: helm install nrue oai-nr-ue/ --namespace oai-tutorial
helm install nrue oai-nr-ue/
NAME: nrue
LAST DEPLOYED: Sun Jan 15 22:40:10 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Get the application name by running these commands:
$: export NR_UE_POD_NAME=$(kubectl get pods --namespace oai-tutorial -l "app.kubernetes.io/name=oai-nr-ue,app.kubernetes.io/instance=nrue" -o jsonpath="{.items[0].metadata.name}")
2. Note: This helm chart of OAI-NR-UE is only tested in RF-simulator mode not tested with hardware on Openshift/Kubernetes Cluster
```
Now you are start reading the logs of amf, smf and other network function to understand the message flow. Once the pdu session establishment procedure is finished you will receive an ip-address. You can start performing some testing.
check if the UE received an ip-address
```console
$: kubectl exec -it -n oai-tutorial -c nr-ue $NR_UE_POD_NAME -- ifconfig oaitun_ue1 |grep -E '(^|\s)inet($|\s)' | awk {'print $2'}
```
### 5.6 Performing some traffic testing
Inside the nr-ue pod there is an extra tcdump container which can be use to perform traffic testing via iperf3 or
``` shell
$: kubectl exec -it -n oai-tutorial -c nr-ue $NR_UE_POD_NAME -- ping -I oaitun_ue1 -c4 google.fr
PING google.fr (142.250.178.131) from 12.1.1.2 oaitun_ue1: 56(84) bytes of data.
64 bytes from par21s22-in-f3.1e100.net (142.250.178.131): icmp_seq=1 ttl=117 time=25.0 ms
64 bytes from par21s22-in-f3.1e100.net (142.250.178.131): icmp_seq=2 ttl=117 time=28.0 ms
64 bytes from par21s22-in-f3.1e100.net (142.250.178.131): icmp_seq=3 ttl=117 time=27.0 ms
64 bytes from par21s22-in-f3.1e100.net (142.250.178.131): icmp_seq=4 ttl=117 time=24.7 ms
--- google.fr ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 3002ms
rtt min/avg/max/mdev = 24.780/26.253/28.067/1.378 ms
## incase above doesn't work try with 8.8.8.8 instead of dns. If that works then probably you have't configure dns properly in SMF.
```
If you ping via `eth0`, default CNI interface you will see different ping results than `oaitun_ue1` interface. Observe the difference in two pings one goes directly towards internet via host networking and second travels through OAI stack.
### 5.7 Uninstall the helm charts
You can remove them one by one or you can use this command
``` shell
$: helm uninstall -n oai-tutorial $(helm list -aq -n oai-tutorial)
```
## 6. Extra
### 6.1 How to install helm spray plugin?
``` console
$: helm plugin install https://github.com/ThalesGroup/helm-spray
Downloading and installing spray v4.0.0...
Installed plugin: spray
-bash-4.2$ helm plugin list
NAME VERSION DESCRIPTION
spray 4.0.0 Helm plugin for upgrading sub-charts from umbrella chart with dependency orders
```
### 6.2 How to capture pcaps inside a network function?
We have specially provided a sperate container to capture pcap for each network function you can get inside this container and use tcpdump command
```console
$: kubectl exec -it -c tcpdump $AMF_POD_NAME -- /bin/sh
$: tcpdump -i any -n
```
## 6.3 Resource Consumption of Network Functions
Below resource consumption is observered using Kubernetes metrics server while NR-UE was pinging to `google.fr`.
```console
$: kubectl top pods -n oai-tutorial
NAME CPU(cores) MEMORY(bytes)
mysql-6d95f95fb5-pml82 6m 466Mi
oai-amf-597cdbd99f-nnr7m 7m 4Mi
oai-gnb-7bf557fb94-ljk5p 1129m 1030Mi
oai-nr-ue-7b45d698bb-8vqh7 1048m 536Mi
oai-nrf-59f5c8cff5-jkmp8 16m 3Mi
oai-smf-5597cf5887-l99sr 5m 4Mi
oai-spgwu-tiny-58587dfc58-n28r7 10m 3Mi
```
\ No newline at end of file
docs/images/helm-chart-basic.png deleted 100644 → 0
+ 0
− 0
View file @ 36d9bcab
docs/images/helm-chart-basic.png

78.8 KiB

docs/images/helm-chart-current.png deleted 100644 → 0
+ 0
− 0
View file @ 36d9bcab
docs/images/helm-chart-current.png

71.6 KiB

docs/images/helm-chart-mini.png deleted 100644 → 0
+ 0
− 0
View file @ 36d9bcab
docs/images/helm-chart-mini.png

68.8 KiB

docs/images/helm-chart.png 0 → 100644
+ 0
− 0
View file @ 06487119
docs/images/helm-chart.png

145 KiB

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