1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
4 O-DU High Installation Guide
5 *****************************
7 This document describes how to install O-DU High, it's dependencies and required system resources.
17 +--------------------+--------------------+--------------------+--------------------+
18 | **Date** | **Ver.** | **Author** | **Comment** |
20 +--------------------+--------------------+--------------------+--------------------+
21 | 2023-06-13 | 6.0.1 | Radisys | H release |
23 +--------------------+--------------------+--------------------+--------------------+
24 | 2022-12-15 | 5.0.1 | Radisys, | G release |
25 | | | HCL Technologies | |
27 +--------------------+--------------------+--------------------+--------------------+
28 | 2022-06-16 | 4.0.0 | Radisys, | F release |
29 | | | HCL Technologies | |
31 +--------------------+--------------------+--------------------+--------------------+
32 | 2022-01-14 | 3.0.0 | Radisys, | e-release |
33 | | | HCL Technologies | |
35 +--------------------+--------------------+--------------------+--------------------+
36 | 2021-07-07 | 2.0.0 | Radisys, | D Release |
37 | | | HCL Technologies | |
39 +--------------------+--------------------+--------------------+--------------------+
40 | 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release |
42 +--------------------+--------------------+--------------------+--------------------+
43 | 2020-12-04 | 1.0 | Radisys | Cherry Release |
45 +--------------------+--------------------+--------------------+--------------------+
51 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
53 The audience of this document is assumed to have good knowledge in RAN concepts and Linux system.
59 O-DU High images can be built using the source code or corresponding docker images can be downloaded.
65 Following minimum hardware requirements must be met for installation of O-DU High
67 +--------------------+----------------------------------------------------+
68 | **HW Aspect** | **Requirement** |
70 +--------------------+----------------------------------------------------+
71 | **# of servers** | 1 |
72 +--------------------+----------------------------------------------------+
75 +--------------------+----------------------------------------------------+
78 +--------------------+----------------------------------------------------+
81 +--------------------+----------------------------------------------------+
84 +--------------------+----------------------------------------------------+
87 Software installation and deployment
88 -------------------------------------
90 This section describes the installation of the O-DU High on the reference hardware.
95 Following libraries are required to compile and execute O-DU High:
98 - Ubuntu : sudo apt-get install -y build-essential
99 - CentOS : sudo yum groups mark install -y “Development Tools”
101 Ensure the version is 4.6.3 and above using
106 - Ubuntu : sudo apt-get install -y libsctp-dev
107 - CentOS : sudo yum install -y lksctp-tools-devel
110 - Ubuntu : sudo apt-get install -y libpcap-dev
111 - CentOS : sudo yum install -y libpcap-devel
118 - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
120 - Clone code into <O-DU High Directory>
122 git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
125 Setting up Netconf server (Only if O1 interface enabled)
126 ========================================================
128 Following steps are required to compile and run ODU with O1 interface enabled.
130 - Create a new netconf user
132 Switch to root user or use sudo and run following commands
135 | cd <O-DU High Directory>/l2/build/scripts
136 | sudo ./add_netconf_user.sh
138 - Install Netconf libraries:
140 libssh, libyang, libnetconf2, sysrepo, netopeer2
142 Script is provided in the following folder to install these libraries
145 | cd <O-DU High Directory>/l2/build/scripts
146 | sudo ./install_lib_O1.sh -c
148 - Install the YANG modules and load initial configuration
150 - Navigate to config folder and update the desired initial configuration
152 | cd <O-DU High Directory>/l2/build/config
154 | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
155 | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
156 | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
157 | Open the oamVesConfig.json and edit the details of OAM VES collector.
158 | Open the smoVesConfig.json and edit the details of SMO VES collector.
159 | Open the netconfConfig.json and edit the details of Netopeer server.
161 - Install the yang modules and load initial configuration.
165 | $cd <O-DU High Directory>/l2/build/scripts
166 | $sudo ./load_yang.sh
168 - Start Netopeer2-server:
171 | cd <O-DU High Directory>/l2/build/scripts
172 | sudo ./netopeer-server.sh start
174 - In case standard defined VES format is to be enabled (this step is optional):
178 | Enable the Macro "StdDef" in file VesUtils.h
186 - Navigate to Build folder
188 cd <O-DU High Directory>/l2/build/odu
190 - Clean O-DU High binary
192 make clean_odu MACHINE=BIT64 MODE=FDD
195 - Compile O-DU High binary
197 make odu MACHINE=BIT64 MODE=FDD
202 - Navigate to Build folder
204 cd <O-DU High Directory>/l2/build/odu
206 - Clean CU Stub binary
208 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
210 - Compile CU Stub binary
212 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
216 - Navigate to Build folder
218 cd <O-DU High Directory>/l2/build/odu
220 - Clean RIC Stub binary
222 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
224 - Compile RIC Stub binary
226 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
229 Compilation with O1 interface enabled
230 =====================================
234 - Navigate to Build folder
236 cd <O-DU High Directory>/l2/build/odu
238 - Clean O-DU High binary
240 make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
243 - Compile O-DU High binary
245 make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
250 - Navigate to Build folder
252 cd <O-DU High Directory>/l2/build/odu
254 - Clean CU Stub binary
256 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
258 - Compile CU Stub binary
260 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
264 - Navigate to Build folder
266 cd <O-DU High Directory>/l2/build/odu
268 - Clean RIC Stub binary
270 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
272 - Compile RIC Stub binary
274 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
278 The above generated images can be found at:
280 - O-DU High - <O-DU High Directory>/l2/bin/odu
282 - CU Stub - <O-DU High Directory>/l2/bin/cu_stub
284 - RIC Stub - <O-DU High Directory>/l2/bin/ric_stub