X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=fbc906013ee8b696bdcad946df272fe34cc6c379;hb=1d6200fae3b85714f8d9ddec062a01c8b9faca23;hp=ce5c3d860da08d6496c1f446ce1e776e68c033ef;hpb=8bd856d0debe02bb5cc741a00c51cefcec982a15;p=o-du%2Fl2.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index ce5c3d860..fbc906013 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -5,7 +5,9 @@ :depth: 3 :local: -======== +O-DU High Installation Guide +***************************** + Abstract ======== @@ -16,12 +18,19 @@ This document describes how to install O-DU High, it's dependencies and required :local: Version history ---------------------- + +--------------------+--------------------+--------------------+--------------------+ | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ +| 2021-07-07 | 2.0.0 | Radisys, | D Release | +| | | HCL Technologies | | +| | | Ltd. | | ++--------------------+--------------------+--------------------+--------------------+ +| 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release | +| | | Ltd. | | ++--------------------+--------------------+--------------------+--------------------+ | 2020-12-04 | 1.0 | Radisys | Cherry Release | | | | | | +--------------------+--------------------+--------------------+--------------------+ @@ -30,8 +39,7 @@ Version history Introduction ============ -This document describes the hardware and software requirements along with guidelines on how to install and configure the -O-DU High. +This document describes the hardware and software requirements along with guidelines on how to install O-DU High. The audience of this document is assumed to have good knowledge in RAN concepts and Linux system. @@ -39,7 +47,7 @@ The audience of this document is assumed to have good knowledge in RAN concepts Preface ======= -Before starting the installation of O-DU High, the source can be built or docker image can be downloaded. +O-DU High images can be built using the source code or corresponding docker images can be downloaded. Hardware requirements @@ -53,7 +61,7 @@ Following minimum hardware requirements must be met for installation of O-DU Hig +--------------------+----------------------------------------------------+ | **# of servers** | 1 | +--------------------+----------------------------------------------------+ -| **CPU** | 5 | +| **CPU** | 4 | | | | +--------------------+----------------------------------------------------+ | **RAM** | 8G | @@ -62,30 +70,199 @@ Following minimum hardware requirements must be met for installation of O-DU Hig | **Disk** | 500G | | | | +--------------------+----------------------------------------------------+ -| **NICs** | 3 | +| **NICs** | 1 | | | | +--------------------+----------------------------------------------------+ - - - Software installation and deployment ========================================== This section describes the installation of the O-DU High on the reference hardware. Libraries -^^^^^^^^^^ +---------- + +Following libraries are required to compile and execute O-DU High: -- GCC version 4.6.3 and above +- GCC + - Ubuntu : sudo apt-get install -y build-essential + - CentOS : sudo yum groups mark install -y “Development Tools” + + Ensure the version is 4.6.3 and above using + + - gcc --version - LKSCTP - Ubuntu : sudo apt-get install -y libsctp-dev - - CentOS : yum install lksctp-tools-devel + - CentOS : sudo yum install -y lksctp-tools-devel - PCAP: - Ubuntu : sudo apt-get install -y libpcap-dev - - CentOS : yum install libpcap-devel + - CentOS : sudo yum install -y libpcap-devel + + + +Cloning code +-------------- + +- Create a folder to clone the O-DU High code into. The folder is hereafter referred to as . + +- Clone code into + + git clone "https://gerrit.o-ran-sc.org/r/o-du/l2" + + +Setting up Netconf server (Only if O1 interface enabled) +-------------------------------------------------------- + + Following steps are required to compile and run ODU with O1 interface enabled. + +- Create a new netconf user + + Switch to root user or use sudo and run following commands + + - Ubuntu : + | cd /l2/build/scripts + | sudo ./add_netconf_user.sh + +- Install Netconf libraries: + + libssh, libyang, libnetconf2, sysrepo, netopeer2 + + Script is provided in the following folder to install these libraries + + - Ubuntu : + | cd /l2/build/scripts + | sudo ./install_lib_O1.sh -c + +- Install the YANG modules and load initial configuration + + - Navigate to config folder and update the desired initial configuration + + - Ubuntu : + | cd /l2/build/config + + | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC. + | Open the nacm_config.xml and edit the desired user name to provide the access to that user. + | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration. + | Open the vesConfig.json and edit the details of VES collector. + | Open the netconfConfig.json and edit the details of Netopeer server. + | Install the yang modules and load initial configuration. + + - Ubuntu : + | cd /l2/build/scripts + | sudo ./load_yang.sh + +- Start Netopeer2-server: + + - Ubuntu : + | cd /l2/build/scripts + | sudo ./netopeer-server.sh start + + +Compilation +------------ + +- Build O-DU High: + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean O-DU High binary + + make clean_odu MACHINE=BIT64 MODE=FDD + + + - Compile O-DU High binary + + make odu MACHINE=BIT64 MODE=FDD + + +- Build CU Stub : + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean CU Stub binary + + make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD + + - Compile CU Stub binary + + make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD + +- Build RIC Stub : + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean RIC Stub binary + + make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD + + - Compile RIC Stub binary + + make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD + + +Compilation with O1 interface enabled +-------------------------------------- + +- Build O-DU High: + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean O-DU High binary + + make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + + - Compile O-DU High binary + + make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + +- Build CU Stub : + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean CU Stub binary + + make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + - Compile CU Stub binary + + make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + +- Build RIC Stub : + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean RIC Stub binary + + make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + - Compile RIC Stub binary + + make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + + +The above generated images can be found at: + +- O-DU High - /l2/bin/odu + +- CU Stub - /l2/bin/cu_stub +- RIC Stub - /l2/bin/ric_stub