1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
8 O-DU High Installation Guide
9 *****************************
14 This document describes how to install O-DU High, it's dependencies and required system resources.
23 +--------------------+--------------------+--------------------+--------------------+
24 | **Date** | **Ver.** | **Author** | **Comment** |
26 +--------------------+--------------------+--------------------+--------------------+
27 | 2022-01-14 | 3.0.0 | Radisys, | e-release |
28 | | | HCL Technologies | |
30 +--------------------+--------------------+--------------------+--------------------+
31 | 2021-07-07 | 2.0.0 | Radisys, | D Release |
32 | | | HCL Technologies | |
34 +--------------------+--------------------+--------------------+--------------------+
35 | 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release |
37 +--------------------+--------------------+--------------------+--------------------+
38 | 2020-12-04 | 1.0 | Radisys | Cherry Release |
40 +--------------------+--------------------+--------------------+--------------------+
46 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
48 The audience of this document is assumed to have good knowledge in RAN concepts and Linux system.
54 O-DU High images can be built using the source code or corresponding docker images can be downloaded.
60 Following minimum hardware requirements must be met for installation of O-DU High
62 +--------------------+----------------------------------------------------+
63 | **HW Aspect** | **Requirement** |
65 +--------------------+----------------------------------------------------+
66 | **# of servers** | 1 |
67 +--------------------+----------------------------------------------------+
70 +--------------------+----------------------------------------------------+
73 +--------------------+----------------------------------------------------+
76 +--------------------+----------------------------------------------------+
79 +--------------------+----------------------------------------------------+
82 Software installation and deployment
83 ==========================================
85 This section describes the installation of the O-DU High on the reference hardware.
90 Following libraries are required to compile and execute O-DU High:
93 - Ubuntu : sudo apt-get install -y build-essential
94 - CentOS : sudo yum groups mark install -y “Development Tools”
96 Ensure the version is 4.6.3 and above using
101 - Ubuntu : sudo apt-get install -y libsctp-dev
102 - CentOS : sudo yum install -y lksctp-tools-devel
105 - Ubuntu : sudo apt-get install -y libpcap-dev
106 - CentOS : sudo yum install -y libpcap-devel
113 - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
115 - Clone code into <O-DU High Directory>
117 git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
120 Setting up Netconf server (Only if O1 interface enabled)
121 --------------------------------------------------------
123 Following steps are required to compile and run ODU with O1 interface enabled.
125 - Create a new netconf user
127 Switch to root user or use sudo and run following commands
130 | cd <O-DU High Directory>/l2/build/scripts
131 | sudo ./add_netconf_user.sh
133 - Install Netconf libraries:
135 libssh, libyang, libnetconf2, sysrepo, netopeer2
137 Script is provided in the following folder to install these libraries
140 | cd <O-DU High Directory>/l2/build/scripts
141 | sudo ./install_lib_O1.sh -c
143 - Install the YANG modules and load initial configuration
145 - Navigate to config folder and update the desired initial configuration
147 | cd <O-DU High Directory>/l2/build/config
149 | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
150 | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
151 | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
152 | Open the oamVesConfig.json and edit the details of OAM VES collector.
153 | Open the smoVesConfig.json and edit the details of SMO VES collector.
154 | Open the netconfConfig.json and edit the details of Netopeer server.
155 | Install the yang modules and load initial configuration.
159 | $cd <O-DU High Directory>/l2/build/scripts
160 | $sudo ./load_yang.sh
162 - To enable Standard Defined VES format:
166 | Enable the Macro "StdDef" in file VesUtils.h
169 - Start Netopeer2-server:
172 | cd <O-DU High Directory>/l2/build/scripts
173 | sudo ./netopeer-server.sh start
181 - Navigate to Build folder
183 cd <O-DU High Directory>/l2/build/odu
185 - Clean O-DU High binary
187 make clean_odu MACHINE=BIT64 MODE=FDD
190 - Compile O-DU High binary
192 make odu MACHINE=BIT64 MODE=FDD
197 - Navigate to Build folder
199 cd <O-DU High Directory>/l2/build/odu
201 - Clean CU Stub binary
203 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
205 - Compile CU Stub binary
207 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
211 - Navigate to Build folder
213 cd <O-DU High Directory>/l2/build/odu
215 - Clean RIC Stub binary
217 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
219 - Compile RIC Stub binary
221 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
224 Compilation with O1 interface enabled
225 --------------------------------------
229 - Navigate to Build folder
231 cd <O-DU High Directory>/l2/build/odu
233 - Clean O-DU High binary
235 make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
238 - Compile O-DU High binary
240 make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
245 - Navigate to Build folder
247 cd <O-DU High Directory>/l2/build/odu
249 - Clean CU Stub binary
251 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
253 - Compile CU Stub binary
255 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
259 - Navigate to Build folder
261 cd <O-DU High Directory>/l2/build/odu
263 - Clean RIC Stub binary
265 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
267 - Compile RIC Stub binary
269 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
273 The above generated images can be found at:
275 - O-DU High - <O-DU High Directory>/l2/bin/odu
277 - CU Stub - <O-DU High Directory>/l2/bin/cu_stub
279 - RIC Stub - <O-DU High Directory>/l2/bin/ric_stub