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-06-16 | 4.0.0 | Radisys, | F release |
28 | | | HCL Technologies | |
30 +--------------------+--------------------+--------------------+--------------------+
31 | 2022-01-14 | 3.0.0 | Radisys, | e-release |
32 | | | HCL Technologies | |
34 +--------------------+--------------------+--------------------+--------------------+
35 | 2021-07-07 | 2.0.0 | Radisys, | D Release |
36 | | | HCL Technologies | |
38 +--------------------+--------------------+--------------------+--------------------+
39 | 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release |
41 +--------------------+--------------------+--------------------+--------------------+
42 | 2020-12-04 | 1.0 | Radisys | Cherry Release |
44 +--------------------+--------------------+--------------------+--------------------+
50 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
52 The audience of this document is assumed to have good knowledge in RAN concepts and Linux system.
58 O-DU High images can be built using the source code or corresponding docker images can be downloaded.
64 Following minimum hardware requirements must be met for installation of O-DU High
66 +--------------------+----------------------------------------------------+
67 | **HW Aspect** | **Requirement** |
69 +--------------------+----------------------------------------------------+
70 | **# of servers** | 1 |
71 +--------------------+----------------------------------------------------+
74 +--------------------+----------------------------------------------------+
77 +--------------------+----------------------------------------------------+
80 +--------------------+----------------------------------------------------+
83 +--------------------+----------------------------------------------------+
86 Software installation and deployment
87 ==========================================
89 This section describes the installation of the O-DU High on the reference hardware.
94 Following libraries are required to compile and execute O-DU High:
97 - Ubuntu : sudo apt-get install -y build-essential
98 - CentOS : sudo yum groups mark install -y “Development Tools”
100 Ensure the version is 4.6.3 and above using
105 - Ubuntu : sudo apt-get install -y libsctp-dev
106 - CentOS : sudo yum install -y lksctp-tools-devel
109 - Ubuntu : sudo apt-get install -y libpcap-dev
110 - CentOS : sudo yum install -y libpcap-devel
117 - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
119 - Clone code into <O-DU High Directory>
121 git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
124 Setting up Netconf server (Only if O1 interface enabled)
125 --------------------------------------------------------
127 Following steps are required to compile and run ODU with O1 interface enabled.
129 - Create a new netconf user
131 Switch to root user or use sudo and run following commands
134 | cd <O-DU High Directory>/l2/build/scripts
135 | sudo ./add_netconf_user.sh
137 - Install Netconf libraries:
139 libssh, libyang, libnetconf2, sysrepo, netopeer2
141 Script is provided in the following folder to install these libraries
144 | cd <O-DU High Directory>/l2/build/scripts
145 | sudo ./install_lib_O1.sh -c
147 - Install the YANG modules and load initial configuration
149 - Navigate to config folder and update the desired initial configuration
151 | cd <O-DU High Directory>/l2/build/config
153 | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
154 | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
155 | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
156 | Open the oamVesConfig.json and edit the details of OAM VES collector.
157 | Open the smoVesConfig.json and edit the details of SMO VES collector.
158 | Open the netconfConfig.json and edit the details of Netopeer server.
159 | Install the yang modules and load initial configuration.
163 | $cd <O-DU High Directory>/l2/build/scripts
164 | $sudo ./load_yang.sh
166 - To enable Standard Defined VES format:
170 | Enable the Macro "StdDef" in file VesUtils.h
173 - Start Netopeer2-server:
176 | cd <O-DU High Directory>/l2/build/scripts
177 | sudo ./netopeer-server.sh start
185 - Navigate to Build folder
187 cd <O-DU High Directory>/l2/build/odu
189 - Clean O-DU High binary
191 make clean_odu MACHINE=BIT64 MODE=FDD
194 - Compile O-DU High binary
196 make odu MACHINE=BIT64 MODE=FDD
201 - Navigate to Build folder
203 cd <O-DU High Directory>/l2/build/odu
205 - Clean CU Stub binary
207 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
209 - Compile CU Stub binary
211 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
215 - Navigate to Build folder
217 cd <O-DU High Directory>/l2/build/odu
219 - Clean RIC Stub binary
221 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
223 - Compile RIC Stub binary
225 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
228 Compilation with O1 interface enabled
229 --------------------------------------
233 - Navigate to Build folder
235 cd <O-DU High Directory>/l2/build/odu
237 - Clean O-DU High binary
239 make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
242 - Compile O-DU High binary
244 make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
249 - Navigate to Build folder
251 cd <O-DU High Directory>/l2/build/odu
253 - Clean CU Stub binary
255 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
257 - Compile CU Stub binary
259 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
263 - Navigate to Build folder
265 cd <O-DU High Directory>/l2/build/odu
267 - Clean RIC Stub binary
269 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
271 - Compile RIC Stub binary
273 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
277 The above generated images can be found at:
279 - O-DU High - <O-DU High Directory>/l2/bin/odu
281 - CU Stub - <O-DU High Directory>/l2/bin/cu_stub
283 - RIC Stub - <O-DU High Directory>/l2/bin/ric_stub