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 | 2021-07-07 | 2.0.0 | Radisys, | D Release |
28 | | | HCL Technologies | |
30 +--------------------+--------------------+--------------------+--------------------+
31 | 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release |
33 +--------------------+--------------------+--------------------+--------------------+
34 | 2020-12-04 | 1.0 | Radisys | Cherry Release |
36 +--------------------+--------------------+--------------------+--------------------+
42 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
44 The audience of this document is assumed to have good knowledge in RAN concepts and Linux system.
50 O-DU High images can be built using the source code or corresponding docker images can be downloaded.
56 Following minimum hardware requirements must be met for installation of O-DU High
58 +--------------------+----------------------------------------------------+
59 | **HW Aspect** | **Requirement** |
61 +--------------------+----------------------------------------------------+
62 | **# of servers** | 1 |
63 +--------------------+----------------------------------------------------+
66 +--------------------+----------------------------------------------------+
69 +--------------------+----------------------------------------------------+
72 +--------------------+----------------------------------------------------+
75 +--------------------+----------------------------------------------------+
78 Software installation and deployment
79 ==========================================
81 This section describes the installation of the O-DU High on the reference hardware.
86 Following libraries are required to compile and execute O-DU High:
89 - Ubuntu : sudo apt-get install -y build-essential
90 - CentOS : sudo yum groups mark install -y “Development Tools”
92 Ensure the version is 4.6.3 and above using
97 - Ubuntu : sudo apt-get install -y libsctp-dev
98 - CentOS : sudo yum install -y lksctp-tools-devel
101 - Ubuntu : sudo apt-get install -y libpcap-dev
102 - CentOS : sudo yum install -y libpcap-devel
109 - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
111 - Clone code into <O-DU High Directory>
113 git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
116 Setting up Netconf server (Only if O1 interface enabled)
117 --------------------------------------------------------
119 Following steps are required to compile and run ODU with O1 interface enabled.
121 - Create a new netconf user
123 Switch to root user or use sudo and run following commands
126 | cd <O-DU High Directory>/l2/build/scripts
127 | sudo ./add_netconf_user.sh
129 - Install Netconf libraries:
131 libssh, libyang, libnetconf2, sysrepo, netopeer2
133 Script is provided in the following folder to install these libraries
136 | cd <O-DU High Directory>/l2/build/scripts
137 | sudo ./install_lib_O1.sh -c
139 - Install the YANG modules and load initial configuration
141 - Navigate to config folder and update the desired initial configuration
144 | cd <O-DU High Directory>/l2/build/config
146 | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
147 | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
148 | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
149 | Open the vesConfig.json and edit the details of VES collector.
150 | Open the netconfConfig.json and edit the details of Netopeer server.
151 | Install the yang modules and load initial configuration.
154 | cd <O-DU High Directory>/l2/build/scripts
155 | sudo ./load_yang.sh
157 - Start Netopeer2-server:
160 | cd <O-DU High Directory>/l2/build/scripts
161 | sudo ./netopeer-server.sh start
169 - Navigate to Build folder
171 cd <O-DU High Directory>/l2/build/odu
173 - Clean O-DU High binary
175 make clean_odu MACHINE=BIT64 MODE=FDD
178 - Compile O-DU High binary
180 make odu MACHINE=BIT64 MODE=FDD
185 - Navigate to Build folder
187 cd <O-DU High Directory>/l2/build/odu
189 - Clean CU Stub binary
191 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
193 - Compile CU Stub binary
195 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
199 - Navigate to Build folder
201 cd <O-DU High Directory>/l2/build/odu
203 - Clean RIC Stub binary
205 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
207 - Compile RIC Stub binary
209 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
212 Compilation with O1 interface enabled
213 --------------------------------------
217 - Navigate to Build folder
219 cd <O-DU High Directory>/l2/build/odu
221 - Clean O-DU High binary
223 make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
226 - Compile O-DU High binary
228 make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
233 - Navigate to Build folder
235 cd <O-DU High Directory>/l2/build/odu
237 - Clean CU Stub binary
239 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
241 - Compile CU Stub binary
243 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
247 - Navigate to Build folder
249 cd <O-DU High Directory>/l2/build/odu
251 - Clean RIC Stub binary
253 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
255 - Compile RIC Stub binary
257 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
261 The above generated images can be found at:
263 - O-DU High - <O-DU High Directory>/l2/bin/odu
265 - CU Stub - <O-DU High Directory>/l2/bin/cu_stub
267 - RIC Stub - <O-DU High Directory>/l2/bin/ric_stub