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-12-15 | 5.0.1 | Radisys, | G release |
22 | | | HCL Technologies | |
24 +--------------------+--------------------+--------------------+--------------------+
25 | 2022-06-16 | 4.0.0 | Radisys, | F release |
26 | | | HCL Technologies | |
28 +--------------------+--------------------+--------------------+--------------------+
29 | 2022-01-14 | 3.0.0 | Radisys, | e-release |
30 | | | HCL Technologies | |
32 +--------------------+--------------------+--------------------+--------------------+
33 | 2021-07-07 | 2.0.0 | Radisys, | D Release |
34 | | | HCL Technologies | |
36 +--------------------+--------------------+--------------------+--------------------+
37 | 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release |
39 +--------------------+--------------------+--------------------+--------------------+
40 | 2020-12-04 | 1.0 | Radisys | Cherry Release |
42 +--------------------+--------------------+--------------------+--------------------+
48 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
50 The audience of this document is assumed to have good knowledge in RAN concepts and Linux system.
56 O-DU High images can be built using the source code or corresponding docker images can be downloaded.
62 Following minimum hardware requirements must be met for installation of O-DU High
64 +--------------------+----------------------------------------------------+
65 | **HW Aspect** | **Requirement** |
67 +--------------------+----------------------------------------------------+
68 | **# of servers** | 1 |
69 +--------------------+----------------------------------------------------+
72 +--------------------+----------------------------------------------------+
75 +--------------------+----------------------------------------------------+
78 +--------------------+----------------------------------------------------+
81 +--------------------+----------------------------------------------------+
84 Software installation and deployment
85 -------------------------------------
87 This section describes the installation of the O-DU High on the reference hardware.
92 Following libraries are required to compile and execute O-DU High:
95 - Ubuntu : sudo apt-get install -y build-essential
96 - CentOS : sudo yum groups mark install -y “Development Tools”
98 Ensure the version is 4.6.3 and above using
103 - Ubuntu : sudo apt-get install -y libsctp-dev
104 - CentOS : sudo yum install -y lksctp-tools-devel
107 - Ubuntu : sudo apt-get install -y libpcap-dev
108 - CentOS : sudo yum install -y libpcap-devel
115 - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
117 - Clone code into <O-DU High Directory>
119 git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
122 Setting up Netconf server (Only if O1 interface enabled)
123 ========================================================
125 Following steps are required to compile and run ODU with O1 interface enabled.
127 - Create a new netconf user
129 Switch to root user or use sudo and run following commands
132 | cd <O-DU High Directory>/l2/build/scripts
133 | sudo ./add_netconf_user.sh
135 - Install Netconf libraries:
137 libssh, libyang, libnetconf2, sysrepo, netopeer2
139 Script is provided in the following folder to install these libraries
142 | cd <O-DU High Directory>/l2/build/scripts
143 | sudo ./install_lib_O1.sh -c
145 - Install the YANG modules and load initial configuration
147 - Navigate to config folder and update the desired initial configuration
149 | cd <O-DU High Directory>/l2/build/config
151 | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
152 | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
153 | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
154 | Open the oamVesConfig.json and edit the details of OAM VES collector.
155 | Open the smoVesConfig.json and edit the details of SMO VES collector.
156 | Open the netconfConfig.json and edit the details of Netopeer server.
158 - Install the yang modules and load initial configuration.
162 | $cd <O-DU High Directory>/l2/build/scripts
163 | $sudo ./load_yang.sh
165 - Start Netopeer2-server:
168 | cd <O-DU High Directory>/l2/build/scripts
169 | sudo ./netopeer-server.sh start
171 - In case standard defined VES format is to be enabled (this step is optional):
175 | Enable the Macro "StdDef" in file VesUtils.h
183 - Navigate to Build folder
185 cd <O-DU High Directory>/l2/build/odu
187 - Clean O-DU High binary
189 make clean_odu MACHINE=BIT64 MODE=FDD
192 - Compile O-DU High binary
194 make odu MACHINE=BIT64 MODE=FDD
199 - Navigate to Build folder
201 cd <O-DU High Directory>/l2/build/odu
203 - Clean CU Stub binary
205 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
207 - Compile CU Stub binary
209 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
213 - Navigate to Build folder
215 cd <O-DU High Directory>/l2/build/odu
217 - Clean RIC Stub binary
219 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
221 - Compile RIC Stub binary
223 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
226 Compilation with O1 interface enabled
227 =====================================
231 - Navigate to Build folder
233 cd <O-DU High Directory>/l2/build/odu
235 - Clean O-DU High binary
237 make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
240 - Compile O-DU High binary
242 make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
247 - Navigate to Build folder
249 cd <O-DU High Directory>/l2/build/odu
251 - Clean CU Stub binary
253 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
255 - Compile CU Stub binary
257 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
261 - Navigate to Build folder
263 cd <O-DU High Directory>/l2/build/odu
265 - Clean RIC Stub binary
267 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
269 - Compile RIC Stub binary
271 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
275 The above generated images can be found at:
277 - O-DU High - <O-DU High Directory>/l2/bin/odu
279 - CU Stub - <O-DU High Directory>/l2/bin/cu_stub
281 - RIC Stub - <O-DU High Directory>/l2/bin/ric_stub