.. 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** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
+| 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. | |
+--------------------+--------------------+--------------------+--------------------+
Introduction
-============
+------------
This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
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
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:
- Ubuntu : sudo apt-get install -y libpcap-dev
- CentOS : sudo yum install -y libpcap-devel
-Following libraries are required to compile and execute O1 module:
-
-- Netconf:
- libssh, libyang, libnetconf2, sysrepo, netopeer2
-
- Script is provided in the following folder to install these libraries
-
- - Ubuntu :
-
- | cd <O-DU High Directory>/l2/build/o1
- | sudo ./install_lib.sh
Cloning code
---------------
+============
- Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
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 <O-DU High Directory>/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 <O-DU High Directory>/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 <O-DU High Directory>/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 <O-DU High Directory>/l2/build/scripts
+ | $sudo ./load_yang.sh
+
+ - To enable Standard Defined VES format:
+
+ | cd l2/src/o1/ves
+
+ | Enable the Macro "StdDef" in file VesUtils.h
+ | #define StdDef
+
+- Start Netopeer2-server:
+
+ - Ubuntu :
+ | cd <O-DU High Directory>/l2/build/scripts
+ | sudo ./netopeer-server.sh start
+
+
Compilation
-------------
+===========
- Build O-DU High:
make clean_odu MACHINE=BIT64 MODE=FDD
- - Build O-DU High binary
+ - Compile O-DU High binary
make odu MACHINE=BIT64 MODE=FDD
- To build with O1 interface enabled:
-
- make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
- Build CU Stub :
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
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
-- Build O-DU High with O1 interface enabled:
- - Navigate to o1 Build folder
+Compilation with O1 interface enabled
+=====================================
+
+- Build O-DU High:
+
+ - Navigate to Build folder
+
+ cd <O-DU High Directory>/l2/build/odu
+
+ - Clean O-DU High binary
+
+ make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+
+
+ - Compile O-DU High binary
- cd <O-DU High Directory>/l2/build/o1
+ make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+
- - Clean O1 binary
+- Build CU Stub :
+
+ - Navigate to Build folder
+
+ cd <O-DU High Directory>/l2/build/odu
+
+ - Clean CU Stub binary
- make clean_o1 MACHINE=BIT64
+ make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
- - Build O1 binary
+ - Compile CU Stub binary
- make o1 MACHINE=BIT64
+ make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
- - Navigate to odu Build folder
+- Build RIC Stub :
+ - Navigate to Build folder
+
cd <O-DU High Directory>/l2/build/odu
- - Clean O-DU High binary
+ - Clean RIC Stub binary
+
+ make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
- make clean_odu MACHINE=BIT64 MODE=FDD
-
- - Build O-DU High binary
+ - Compile RIC Stub binary
- make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+ make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
- RIC Stub - <O-DU High Directory>/l2/bin/ric_stub
-- O1 - <O-DU High Directory>/l2/build/o1/bin/o1
Code Review / o-du / l2.git / blobdiff