Merge branch 'main' of https://projetos.imd.ufrn.br/reginalab/sdran-openairinterface into main

openairinterface5g/openairinterface-install-scripts/README.md

@@ -8,100 +8,79 @@
     2. RAM: 8 GB
     
 ## 5G Core Installation
-### The following steps can be executed by the file oai_5g_core_install.sh
-    1. First step is to download docker, docker-compose, git and network tools. 
-    2. Following you need to download wireshark
-        A. sudo add-apt-repository ppa:wireshark-dev/stable
-        B. sudo apt update
-        C. sudo apt install wireshark
-    3. Git clone the 5GC
-        A. git clone --branch v1.4.0 https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed.git
-        B. Configuration of the packet forwarding
-            - sudo sysctl net.ipv4.conf.all.forwarding=1
-            - sudo iptables -P FORWARD ACCEPT
-    4. Pulling the images from Docker Hub
-        A. docker pull oaisoftwarealliance/oai-amf:v1.4.0
-        B. docker pull oaisoftwarealliance/oai-nrf:v1.4.0
-        C. docker pull oaisoftwarealliance/oai-smf:v1.4.0 
-        D. docker pull oaisoftwarealliance/oai-spgwu-tiny:v1.4.0
-        E. docker pull oaisoftwarealliance/oai-udr:v1.4.0
-        F. docker pull oaisoftwarealliance/oai-udm:v1.4.0
-        G. docker pull oaisoftwarealliance/oai-ausf:v1.4.0
-        H. docker pull oaisoftwarealliance/oai-upf-vpp:v1.4.0
-        I. docker pull oaisoftwarealliance/oai-nssf:v1.4.0
-        J. docker pull oaisoftwarealliance/trf-gen-cn5g:latest
-    5. Tag docker images
-        A. docker image tag oaisoftwarealliance/oai-amf:v1.4.0 oai-amf:v1.4.0
-        B. docker image tag oaisoftwarealliance/oai-nrf:v1.4.0 oai-nrf:v1.4.0
-        C. docker image tag oaisoftwarealliance/oai-smf:v1.4.0 oai-smf:v1.4.0
-        D. docker image tag oaisoftwarealliance/oai-spgwu-tiny:v1.4.0 oai-spgwu-tiny:v1.4.0
-        E. docker image tag oaisoftwarealliance/oai-udr:v1.4.0 oai-udr:v1.4.0
-        F. docker image tag oaisoftwarealliance/oai-udm:v1.4.0 oai-udm:v1.4.0
-        G. docker image tag oaisoftwarealliance/oai-ausf:v1.4.0 oai-ausf:v1.4.0
-        H. docker image tag oaisoftwarealliance/oai-upf-vpp:v1.4.0 oai-upf-vpp:v1.4.0
-        I. docker image tag oaisoftwarealliance/oai-nssf:v1.4.0 oai-nssf:v1.4.0
-        J. docker image tag oaisoftwarealliance/trf-gen-cn5g:latest trf-gen-cn5g:latest
-    6. Synchronizing the tutorials
-        A. Change the directory for ~/oai-cn5g-fed/
-        B. ./scripts/syncComponents.sh
-        C. git submodule deinit --all --force
-        D. git submodule init
-        F. git submodule update        
-    7. Configure the bridge before deploying 5GC.
-        A. docker network create \ --driver=bridge \ --subnet=192.168.70.128/26 \ -o "com.docker.network.bridge.name"="demo-oai" \ demo-oai-public-net
-    8. Deploy the 5GC
-        A. Change the directory for ~/oai-cn5g-fed/docker-compose
-        B. python3 core-network.py --type start-basic --scenario 1
+### General Instruction
+    Important: The following steps can be executed by the file oai_5g_core_install.sh
+    In this task you will install and configure the core in its basic architecture according to the image below:
+    
+![ALT](/openairinterface5g/openairinterface-conf/fig/oai_core.png)  
+
+    Step 1: Install dependencies 
+        sudo apt-get install ca-certificates 
+        sudo apt-get install curl 
+        sudo apt-get install gnupg 
+        sudo apt-get install lsb-release 
+
+    Step 2: Enable packet forwarding
+        sudo sysctl net.ipv4.conf.all.forwarding=1
+        sudo iptables -P FORWARD ACCEPT
+
+    Step 3: Install docker and docker-compose
+        sudo rm /etc/apt/sources.list.d/docker.list*
+        sudo mkdir -p /etc/apt/keyrings 
+        curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+        sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(. /etc/os-release; echo "$UBUNTU_CODENAME") stable"
+        sudo chmod a+r /etc/apt/keyrings/docker.gpg
+        sudo apt-get update
+        sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin
+        sudo curl -L https://github.com/docker/compose/releases/download/1.29.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
+        sudo chmod +x /usr/local/bin/docker-compose
+    
+    Step 4: Pull the images from Docker Hub
+        sudo docker pull oaisoftwarealliance/oai-amf:v1.5.0
+        sudo docker pull oaisoftwarealliance/oai-nrf:v1.5.0
+        sudo docker pull oaisoftwarealliance/oai-smf:v1.5.0
+        sudo docker pull oaisoftwarealliance/oai-udr:v1.5.0
+        sudo docker pull oaisoftwarealliance/oai-udm:v1.5.0
+        sudo docker pull oaisoftwarealliance/oai-ausf:v1.5.0
+        sudo docker pull oaisoftwarealliance/oai-spgwu-tiny:v1.5.0
+        sudo docker pull oaisoftwarealliance/trf-gen-cn5g:latest
 
-## FlexRIC, gNB and UE Installation
-### The following steps can be executed by the file flexRIC_oai_gNB_install.sh
-    1. Install the following dependencies
-        A. sudo apt-get install autotools-dev
-        B. sudo apt-get install automake
-        C. sudo apt-get install libpcre2-dev
-        D. sudo apt-get install pcre2-utils
-        E. sudo apt-get install bison
-        F. sudo apt-get install byacc
-        G. sudo apt install g++
-        H. sudo apt install libsctp-dev python3.8 cmake-curses-gui libpcre2-dev python3-dev    
-    2. Configure swig
-        A. git clone https://github.com/swig/swig.git 
-        B. cd path_to_swig
-        C. ./autogen.sh
-        D. ./configure --prefix=/usr/
-        E. sudo make
-        F. sudo make install
-    3. Install FlexRIC
-        A. git clone https://gitlab.eurecom.fr/mosaic5g/flexric.git ~/flexric
-        B. cd path_to_flexric
-        C. git checkout v1.0.0
-        D. mkdir build
-        E. cd build
-        F. sudo cmake ..
-        G. sudo make
-        H. sudo make install
-    4. Install dependencies for OpenAirInterface 5G
-        A. sudo add-apt-repository ppa:ettusresearch/uhd -y
-        B. sudo apt-get update -y
-        C. sudo apt-get install libuhd-dev uhd-host -y
-        D. sudo apt-get install libuhd4.2.0 -y
-        E. sudo dpkg -i --force-overwrite /var/cache/apt/archives/libuhd4.2.0_4.2.0.1-0ubuntu1~focal1_amd64.deb
-    5. Download the OpenAirInterface 5G repository 
-        A. git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git oai
-    6. Change the openairinterface 5G branch for 2022.41
-        A. cd oai/
-        B. git checkout 2022.41
-    7. Apply FlexRIC patch
-        A. git am <pathtoflexricsrc>/flexric/multiRAT/oai/oai.patch --whitespace=nowarn
-    8. Download the OAI configuration files (CU/DU, OAI UE, and gNB configuration)
-        A. sudo wget -O ~/oai/executables/nr-softmodem.c https://projetos.imd.ufrn.br/reginalab/sdran-openairinterface/-/raw/main/OpenAirInterface/OpenAirInterface-Conf/nr-softmodem.c?inline=false
-        B. sudo wget -O ~/oai/ci-scripts/conf_files/gNB_SA_CU.conf https://projetos.imd.ufrn.br/reginalab/sdran-openairinterface/-/raw/main/OpenAirInterface/OpenAirInterface-Conf/gNB_SA_CU.conf?inline=false
-        C. sudo wget -O ~/oai/ci-scripts/conf_files/gNB_SA_DU.conf https://projetos.imd.ufrn.br/reginalab/sdran-openairinterface/-/raw/main/OpenAirInterface/OpenAirInterface-Conf/gNB_SA_DU.conf?inline=false
-        D. sudo wget -O ~/oai/targets/PROJECTS/GENERIC-NR-5GC/CONF/ue.conf https://projetos.imd.ufrn.br/reginalab/sdran-openairinterface/-/raw/main/OpenAirInterface/OpenAirInterface-Conf/ue.conf?inline=false
+    Step 5: Tag Docker Images
+        sudo docker image tag oaisoftwarealliance/trf-gen-cn5g:latest trf-gen-cn5g:latest
+        sudo docker image tag oaisoftwarealliance/oai-amf:v1.5.0 oai-amf:v1.5.0
+        sudo docker image tag oaisoftwarealliance/oai-nrf:v1.5.0 oai-nrf:v1.5.0
+        sudo docker image tag oaisoftwarealliance/oai-smf:v1.5.0 oai-smf:v1.5.0
+        sudo docker image tag oaisoftwarealliance/oai-udr:v1.5.0 oai-udr:v1.5.0
+        sudo docker image tag oaisoftwarealliance/oai-udm:v1.5.0 oai-udm:v1.5.0
+        sudo docker image tag oaisoftwarealliance/oai-ausf:v1.5.0 oai-ausf:v1.5.0
+        sudo docker image tag oaisoftwarealliance/oai-spgwu-tiny:v1.5.0 oai-spgwu-tiny:v1.5.0
 
-    9. Install the gNB and UE
-        A. source oaienv
-        B. cd cmake_targets
-        C. ./build_oai -I -w USRP -i  #For OAI first time installation. it will install some dependencies
-        D. ./build_oai --gNB --nrUE -c -C -w USRP --ninja --build-lib all
+    Step 6: Clone OpenAirInterface 5G Core repository
+        git clone https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed.git
+        cd oai-cn5g-fed
+        git checkout -f v1.5.0
 
+## RAN and UE installation (Split and Monolithic mode)
+### General Instruction
+    In this task you will install and configure the gNB of the OAI.
+
+    Step 1: Install dependencies
+        sudo add-apt-repository ppa:ettusresearch/uhd
+        sudo apt-get install libuhd-dev uhd-host -y
+        sudo apt-get install libuhd4.2.0 -y
+        sudo apt-get install libuhd4.4.0 -y
+
+    Step 2: Fix problem in the libuhd
+        sudo dpkg -i --force-overwrite /var/cache/apt/archives/libuhd4.2.0_4.2.0.1-0ubuntu1~focal1_amd64.deb
+        sudo dpkg -i --force-overwrite /var/cache/apt/archives/libuhd4.4.0_4.4.0.0-0ubuntu1~focal1_amd64.deb
+
+    Step 3: Clone OpenAirInterface 5G RAN and UE repository
+        git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git
+        cd PATH_TO/openairinterface5g
+        git checkout develop
+    
+    Step 4: Run the installation script
+        source oaienv
+        cd cmake_targets
+        sudo ./build_oai -I -w USRP -i
+        sudo ./build_oai --gNB --nrUE -w USRP
\ No newline at end of file