X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=7841f3df4717a66ed02a6c2f71bf26deb8cbe762;hb=c1e93b027631a245fc6791ea1052da5b905b4d8c;hp=4a72ca64bda7017410a98b789564e277b352dc3f;hpb=726a82abf1f485704459e2ce3777b8bac8cc16b6;p=o-du%2Fl2.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 4a72ca64b..7841f3df4 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,30 +1,38 @@ .. 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** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 2021-12-15 | 3.0.0 | Radisys, | e-release | +| 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. | | +--------------------+--------------------+--------------------+--------------------+ @@ -41,7 +49,7 @@ Version history Introduction -============ +------------ This document describes the hardware and software requirements along with guidelines on how to install O-DU High. @@ -49,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 @@ -80,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: @@ -105,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 . @@ -118,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 @@ -152,67 +163,29 @@ Setting up Netconf server (Only if O1 interface enabled) | 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. + +- Install the yang modules and load initial configuration. - Ubuntu : | $cd /l2/build/scripts | $sudo ./load_yang.sh - - Install additional 3GPP YANG models. - - | $cd /l2/build/yang - - | Download following 3GPP REL17 YANG models - | https://forge.3gpp.org/rep/sa5/MnS/tree/Rel17-draft/yang-models - - | _3gpp-common-top.yang - | _3gpp-5g-common-yang-types.yang - | _3gpp-common-yang-types.yang - | _3gpp-common-managed-element.yang - | _3gpp-common-measurements.yang - | _3gpp-common-subscription-control.yang - | _3gpp-common-fm.yang - | _3gpp-common-trace.yang - | _3gpp-common-managed-function.yang - | _3gpp-nr-nrm-gnbdufunction.yang - | _3gpp-nr-nrm-nrcelldu.yang - | _3gpp-nr-nrm-rrmpolicy.yang - - | Note : There are some corrections required in _3gpp-common-trace.yang and _3gpp-common-trace.yang yang model. Please follow these steps. - - - Ubuntu : - - | sed -i -e 's/"IMMEDIATE_MDT"/"IMMEDIATE_MDT_ONLY"/g' _3gpp-common-trace.yang - | sed -i -e 's/"TRACE"/"TRACE_ONLY"/g' _3gpp-common-trace.yang - - - Install all the downloaded yang models. - - - Ubuntu : - - | cd /l2/build/yang - | sysrepoctl -i _3gpp-common-yang-types.yang - | sysrepoctl -i _3gpp-common-top.yang - | sysrepoctl -i _3gpp-common-measurements.yang - | sysrepoctl -i _3gpp-common-trace.yang - | sysrepoctl -i _3gpp-common-managed-function.yang - | sysrepoctl -i _3gpp-common-subscription-control.yang - | sysrepoctl -i _3gpp-common-fm.yang - | sysrepoctl -i _3gpp-common-managed-element.yang - | sysrepoctl -i _3gpp-5g-common-yang-types.yang - | sysrepoctl -i _3gpp-nr-nrm-rrmpolicy.yang - | sysrepoctl -i _3gpp-nr-nrm-gnbdufunction.yang - | sysrepoctl -i _3gpp-nr-nrm-nrcelldu.yang - - 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: @@ -260,7 +233,7 @@ Compilation Compilation with O1 interface enabled --------------------------------------- +===================================== - Build O-DU High: