X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=0ac3714f4d62fdf8dca97321687df3063334e975;hb=04d3fabd57b479ad8ec2c5cb7f92924670c55546;hp=d99fcd40a47f74dd3854b556c667ecfa60a3cdbe;hpb=bd13ba3b2661a413492608b9cb16c699b3831d5e;p=o-du%2Fl2.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index d99fcd40a..0ac3714f4 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,36 +1,52 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. contents:: - :depth: 3 - :local: - O-DU High Installation Guide ***************************** -Abstract -======== - This document describes how to install O-DU High, it's dependencies and required system resources. .. contents:: :depth: 3 :local: -Version history +Version history +--------------- +--------------------+--------------------+--------------------+--------------------+ | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ +| 2023-06-13 | 6.0.1 | Radisys | H release | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2022-12-15 | 5.0.1 | Radisys, | G release | +| | | HCL Technologies | | +| | | Ltd. | | ++--------------------+--------------------+--------------------+--------------------+ +| 2022-06-16 | 4.0.0 | Radisys, | F release | +| | | HCL Technologies | | +| | | Ltd. | | ++--------------------+--------------------+--------------------+--------------------+ +| 2022-01-14 | 3.0.0 | Radisys, | e-release | +| | | HCL Technologies | | +| | | Ltd. | | ++--------------------+--------------------+--------------------+--------------------+ +| 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 | | | | | | +--------------------+--------------------+--------------------+--------------------+ Introduction -============ +------------ This document describes the hardware and software requirements along with guidelines on how to install O-DU High. @@ -38,13 +54,13 @@ The audience of this document is assumed to have good knowledge in RAN concepts Preface -======= +------- O-DU High images can be built using the source code or corresponding docker images can be downloaded. Hardware requirements -===================== +--------------------- Following minimum hardware requirements must be met for installation of O-DU High @@ -69,18 +85,18 @@ Following minimum hardware requirements must be met for installation of O-DU Hig 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 - - Ubuntu : sudo apt install build-essential - - CentOS : sudo yum group install "Development Tools" + - 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 @@ -88,26 +104,82 @@ Following libraries are required to compile and execute O-DU High: - 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" && (cd "l2" && mkdir -p .git/hooks && curl -Lo `git rev-parse - --git-dir`/hooks/commit-msg https://gerrit.o-ran-sc.org/r/tools/hooks/commit-msg; chmod +x `git rev-parse - --git-dir`/hooks/commit-msg) + 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 + + | 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 oamVesConfig.json and edit the details of OAM VES collector. + | Open the smoVesConfig.json and edit the details of SMO 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 + +- In case standard defined VES format is to be enabled (this step is optional): + + | cd l2/src/o1/ves + + | Enable the Macro "StdDef" in file VesUtils.h + | #define StdDef + Compilation ------------- +=========== - Build O-DU High: @@ -118,10 +190,12 @@ Compilation - Clean O-DU High binary make clean_odu MACHINE=BIT64 MODE=FDD + - - Build O-DU High binary + - Compile O-DU High binary make odu MACHINE=BIT64 MODE=FDD + - Build CU Stub : @@ -133,7 +207,7 @@ Compilation make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD - - Build CU Stub binary + - Compile CU Stub binary make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD @@ -147,11 +221,60 @@ Compilation make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD - - Build RIC Stub binary + - 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 @@ -159,3 +282,4 @@ The above generated images can be found at: - CU Stub - /l2/bin/cu_stub - RIC Stub - /l2/bin/ric_stub +