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 | 2022-06-16 | 4.0.0 | Radisys, | F release |
22 | | | HCL Technologies | |
24 +--------------------+--------------------+--------------------+--------------------+
25 | 2022-01-14 | 3.0.0 | Radisys, | e-release |
26 | | | HCL Technologies | |
28 +--------------------+--------------------+--------------------+--------------------+
29 | 2021-07-07 | 2.0.0 | Radisys, | D Release |
30 | | | HCL Technologies | |
32 +--------------------+--------------------+--------------------+--------------------+
33 | 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release |
35 +--------------------+--------------------+--------------------+--------------------+
36 | 2020-12-04 | 1.0 | Radisys | Cherry Release |
38 +--------------------+--------------------+--------------------+--------------------+
44 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
46 The audience of this document is assumed to have good knowledge in RAN concepts and Linux system.
52 O-DU High images can be built using the source code or corresponding docker images can be downloaded.
58 Following minimum hardware requirements must be met for installation of O-DU High
60 +--------------------+----------------------------------------------------+
61 | **HW Aspect** | **Requirement** |
63 +--------------------+----------------------------------------------------+
64 | **# of servers** | 1 |
65 +--------------------+----------------------------------------------------+
68 +--------------------+----------------------------------------------------+
71 +--------------------+----------------------------------------------------+
74 +--------------------+----------------------------------------------------+
77 +--------------------+----------------------------------------------------+
80 Software installation and deployment
81 -------------------------------------
83 This section describes the installation of the O-DU High on the reference hardware.
88 Following libraries are required to compile and execute O-DU High:
91 - Ubuntu : sudo apt-get install -y build-essential
92 - CentOS : sudo yum groups mark install -y “Development Tools”
94 Ensure the version is 4.6.3 and above using
99 - Ubuntu : sudo apt-get install -y libsctp-dev
100 - CentOS : sudo yum install -y lksctp-tools-devel
103 - Ubuntu : sudo apt-get install -y libpcap-dev
104 - CentOS : sudo yum install -y libpcap-devel
111 - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
113 - Clone code into <O-DU High Directory>
115 git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
118 Setting up Netconf server (Only if O1 interface enabled)
119 ========================================================
121 Following steps are required to compile and run ODU with O1 interface enabled.
123 - Create a new netconf user
125 Switch to root user or use sudo and run following commands
128 | cd <O-DU High Directory>/l2/build/scripts
129 | sudo ./add_netconf_user.sh
131 - Install Netconf libraries:
133 libssh, libyang, libnetconf2, sysrepo, netopeer2
135 Script is provided in the following folder to install these libraries
138 | cd <O-DU High Directory>/l2/build/scripts
139 | sudo ./install_lib_O1.sh -c
141 - Install the YANG modules and load initial configuration
143 - Navigate to config folder and update the desired initial configuration
145 | cd <O-DU High Directory>/l2/build/config
147 | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
148 | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
149 | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
150 | Open the oamVesConfig.json and edit the details of OAM VES collector.
151 | Open the smoVesConfig.json and edit the details of SMO VES collector.
152 | Open the netconfConfig.json and edit the details of Netopeer server.
154 - Install the yang modules and load initial configuration.
158 | $cd <O-DU High Directory>/l2/build/scripts
159 | $sudo ./load_yang.sh
161 - Start Netopeer2-server:
164 | cd <O-DU High Directory>/l2/build/scripts
165 | sudo ./netopeer-server.sh start
167 - In case standard defined VES format is to be enabled (this step is optional):
171 | Enable the Macro "StdDef" in file VesUtils.h
179 - Navigate to Build folder
181 cd <O-DU High Directory>/l2/build/odu
183 - Clean O-DU High binary
185 make clean_odu MACHINE=BIT64 MODE=FDD
188 - Compile O-DU High binary
190 make odu MACHINE=BIT64 MODE=FDD
195 - Navigate to Build folder
197 cd <O-DU High Directory>/l2/build/odu
199 - Clean CU Stub binary
201 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
203 - Compile CU Stub binary
205 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
209 - Navigate to Build folder
211 cd <O-DU High Directory>/l2/build/odu
213 - Clean RIC Stub binary
215 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
217 - Compile RIC Stub binary
219 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
222 Compilation with O1 interface enabled
223 =====================================
227 - Navigate to Build folder
229 cd <O-DU High Directory>/l2/build/odu
231 - Clean O-DU High binary
233 make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
236 - Compile O-DU High binary
238 make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
243 - Navigate to Build folder
245 cd <O-DU High Directory>/l2/build/odu
247 - Clean CU Stub binary
249 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
251 - Compile CU Stub binary
253 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
257 - Navigate to Build folder
259 cd <O-DU High Directory>/l2/build/odu
261 - Clean RIC Stub binary
263 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
265 - Compile RIC Stub binary
267 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
271 The above generated images can be found at:
273 - O-DU High - <O-DU High Directory>/l2/bin/odu
275 - CU Stub - <O-DU High Directory>/l2/bin/cu_stub
277 - RIC Stub - <O-DU High Directory>/l2/bin/ric_stub