X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=7841f3df4717a66ed02a6c2f71bf26deb8cbe762;hb=c1e93b027631a245fc6791ea1052da5b905b4d8c;hp=78d620bfa5d5e12f79ec552a0ddcc7ce0673c28e;hpb=bfd03f1e56692fc661435811b185d907f79808b2;p=o-du%2Fl2.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 78d620bfa..7841f3df4 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,29 +1,45 @@ .. 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. | | ++--------------------+--------------------+--------------------+--------------------+ | 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release | | | | Ltd. | | +--------------------+--------------------+--------------------+--------------------+ @@ -33,7 +49,7 @@ Version history Introduction -============ +------------ This document describes the hardware and software requirements along with guidelines on how to install O-DU High. @@ -41,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 @@ -72,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: @@ -97,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 . @@ -109,63 +128,64 @@ Cloning code git clone "https://gerrit.o-ran-sc.org/r/o-du/l2" -Setting up Netconf server -------------------------- - - Following steps are required to compile ODU with O1 interface enabled: +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 : - + - Ubuntu : | cd /l2/build/scripts | sudo ./install_lib_O1.sh -c -- Start Netopeer2-server: - - - Ubuntu : - | cd /l2/build/scripts - | sudo ./netopeer-server.sh start +- Install the YANG modules and load initial configuration -- Create a new netconf user - - Switch to root user and run following commands - - - Ubuntu : - - | adduser --system netconf && \\ - | echo "netconf:netconf!" | chpasswd + - Navigate to config folder and update the desired initial configuration - | mkdir -p /home/netconf/.ssh && \\ - | ssh-keygen -A && \\ - | ssh-keygen -t dsa -P '' -f /home/netconf/.ssh/id_dsa && \\ - | cat /home/netconf/.ssh/id_dsa.pub > /home/netconf/.ssh/authorized_keys + | cd /l2/build/config -- Install the YANG modules + | 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. - - Ubuntu : - - | cd /l2/build/yang - | sysrepoctl -i ./yang/o-ran-sc-odu-alarm-v1.yang - | sysrepoctl -i ./yang/o-ran-sc-odu-interface-v1.yang +- Install the yang modules and load initial configuration. -- Configure the startup IP and Port configurations for DU, CU and RIC + - Ubuntu : + + | $cd /l2/build/scripts + | $sudo ./load_yang.sh - - Ubuntu : - - | cd /l2/build/config - | - | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC. - | Then load the configuration in the sysrepo running datastore using the command below - | - | sysrepocfg --import=startup_config.xml --datastore running --module o-ran-sc-odu-interface-v1 +- 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: @@ -213,7 +233,7 @@ Compilation Compilation with O1 interface enabled --------------------------------------- +===================================== - Build O-DU High: