Update README.md

openairinterface5g/openairinterface-install-scripts/README.md

@@ -27,59 +27,164 @@ In a Linux Terminal, follow the steps below:
 
 **Step 0:** Setup your VM or Baremetal Machine, after install Useful Software:
 
-sudo su
+> sudo su 
+> 
+> apt update -y 
+> 
+> apt upgrade -y
+> 
+> apt install -y python3-pip git curl cmake tree golang vim net-tools build-essential nfs-common openssh-server
 
-apt update -y
 
-apt upgrade -y
+**Step 1:** Install dependencies
 
-apt install -y python3-pip git curl cmake tree golang vim net-tools build-essential nfs-common openssh-server
+> sudo apt-get install ca-certificates 
+> 
+> sudo apt-get install curl 
+> 
+> sudo apt-get install gnupg 
+> 
+> sudo apt-get install lsb-release 
 
-**Step 1:** Install dependencies
 
-sudo apt-get install ca-certificates 
+**Step 2:** Enable packet forwarding
 
-sudo apt-get install curl 
+> sudo sysctl net.ipv4.conf.all.forwarding=1
+> 
+> sudo iptables -P FORWARD ACCEPT
 
-sudo apt-get install gnupg 
 
-sudo apt-get install lsb-release 
+**Step 3:** Install docker and docker-compose
 
-**Step 2:** Enable packet forwarding
+> 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 -y 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
 
-sudo sysctl net.ipv4.conf.all.forwarding=1
 
-sudo iptables -P FORWARD ACCEPT
+**Step 4:** Clone OpenAirInterface 5G Core repository
 
-**Step 3:** Install docker and docker-compose
+> git clone https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed.git
+> 
+> cd oai-cn5g-fed
+> 
+> git checkout slicing-spring-of-code
+
+## 5G RAN Installation
+
+## Objectives
+- Install and configure the OAI gNB 
+- Deploy a gNB together a previous configured 5GC
+- Inspect gNB status in 5GC Core
 
-sudo rm /etc/apt/sources.list.d/docker.list*
+## gNB Installation
 
-sudo mkdir -p /etc/apt/keyrings 
+To install OAI RAN 5G, go back to /home/dco1020 and follow this tutorial.
 
-curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+**Step 0:** go back to /home/dco1020. In a Linux Terminal, type:
 
-sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu \\$(. /etc/os-release; echo "\\$UBUNTU_CODENAME") stable"
+> sudo su
+> 
+> cd /home/dco1020
 
-sudo chmod a+r /etc/apt/keyrings/docker.gpg
+## 5G RAN Installation
 
-sudo apt-get update
+**Step 1:** Install dependencies
 
-sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
+> sudo add-apt-repository ppa:ettusresearch/uhd
+> 
+> sudo apt-get install libuhd-dev uhd-host -y
+> 
+> sudo apt-get install libuhd4.6.0 -y
+> 
+> sudo apt-get install ccache -y
+> 
+> sudo apt-get install net-tools
+
+
+**Step 2:** Fix problem in the libuhd. When you run the commands below, if you get the error "cannot access archive", you can continue to the next step.
+sudo dpkg -i --force-overwrite /var/cache/apt/archives/libuhd4.6.0_4.6.0.0-0ubuntu1~focal1_amd64.deb
+
+**Step 3:** Clone OpenAirInterface 5G RAN repository
+
+git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git
+
+> cd /home/dco1020/openairinterface5g
+> 
+> git checkout slicing-spring-of-code
+> 
+> **Step 4:** Run the installation script
+> 
+> source oaienv
+> 
+> cd cmake_targets
+> 
+> sudo ./build_oai -I 
+> 
+> sudo ./build_oai -I --install-optional-packages
+> 
+> sudo ./build_oai -w USRP --ninja --gNB --eNB --UE --nrUE -C --build-lib "uescope nrscope telnetsrv" 
+
+## RIC Installation (FlexRIC)
 
-```python 
-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
-```
+## Objectives
+- Install and configure the gNB and FlexRIC 
 
-sudo chmod +x /usr/local/bin/docker-compose
+To install OAI FlexRIC, go back to /home/dco1020 and follow this tutorial.
 
-**Step 4:** Clone OpenAirInterface 5G Core repository
+**Step 0:** go back to /home/dco1020. In a Linux Terminal, type:
+
+> sudo su
+> 
+> cd /home/dco1020
+
+**Step 1:** Install dependencies:
+
+> sudo apt-get install -y autotools-dev automake g++ make libpcre2-dev byacc cmake python3-dev libsctp-dev pcre2-utils bison
+
+**Step 2:** Install swig:
+
+> git clone https://github.com/swig/swig.git
+> 
+> cd swig
+> 
+> git checkout release-4.1 
+> 
+> ./autogen.sh
+> 
+> ./configure --prefix=/usr/
+> 
+> make -j8
+> 
+> sudo make install
 
-git clone https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed.git
 
-cd oai-cn5g-fed
+**Step 3:** Clone FlexRIC repository:
 
-git checkout slicing-spring-of-code
+> git clone https://gitlab.eurecom.fr/mosaic5g/flexric flexric
+> 
+> cd flexric/
+> 
+> git checkout slicing-spring-of-code
+> 
+> **Step 4:** Build FlexRIC:
+> 
+> mkdir build && cd build && cmake .. && make -j8
+> 
+> sudo make install
 
 ## Deployment
 
@@ -87,9 +192,10 @@ For this task, open another terminal using crtl+Alt+T.
 
 **Step 1:** Core deployment
 
-cd /home/dco1020/oai-cn5g-fed/docker-compose
+> cd /home/dco1020/oai-cn5g-fed/docker-compose
+> 
+> sudo python3 core-network.py --type start-basic --scenario 1
 
-sudo python3 core-network.py --type start-basic --scenario 1
 
 Expected result: