X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=7841f3df4717a66ed02a6c2f71bf26deb8cbe762;hb=c1e93b027631a245fc6791ea1052da5b905b4d8c;hp=fbc906013ee8b696bdcad946df272fe34cc6c379;hpb=1722dfdb176680b7165d338f37383c7aebfaddb7;p=o-du%2Fl2.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index fbc906013..7841f3df4 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,29 +1,41 @@ .. 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-12-14 | 7.0.1 | Radisys | I release | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 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. | | @@ -37,7 +49,7 @@ Version history Introduction -============ +------------ This document describes the hardware and software requirements along with guidelines on how to install O-DU High. @@ -45,13 +57,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 @@ -76,12 +88,12 @@ 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: @@ -101,10 +113,13 @@ Following libraries are required to compile and execute O-DU High: - Ubuntu : sudo apt-get install -y libpcap-dev - CentOS : sudo yum install -y libpcap-devel +- libxml2 + - Ubuntu : sudo apt-get install -y libxml2-dev + - CentOS : sudo yum install -y libxml2 Cloning code --------------- +============ - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as . @@ -114,8 +129,8 @@ Cloning code 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 @@ -140,19 +155,21 @@ Setting up Netconf server (Only if O1 interface enabled) - Navigate to config folder and update the desired initial configuration - - Ubuntu : - | cd /l2/build/config + | 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 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 +- Install the yang modules and load initial configuration. + + - Ubuntu : + + | $cd /l2/build/scripts + | $sudo ./load_yang.sh - Start Netopeer2-server: @@ -160,9 +177,15 @@ Setting up Netconf server (Only if O1 interface enabled) | 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: @@ -210,7 +233,7 @@ Compilation Compilation with O1 interface enabled --------------------------------------- +===================================== - Build O-DU High: