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 | 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release |
29 +--------------------+--------------------+--------------------+--------------------+
30 | 2020-12-04 | 1.0 | Radisys | Cherry Release |
32 +--------------------+--------------------+--------------------+--------------------+
38 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
40 The audience of this document is assumed to have good knowledge in RAN concepts and Linux system.
46 O-DU High images can be built using the source code or corresponding docker images can be downloaded.
52 Following minimum hardware requirements must be met for installation of O-DU High
54 +--------------------+----------------------------------------------------+
55 | **HW Aspect** | **Requirement** |
57 +--------------------+----------------------------------------------------+
58 | **# of servers** | 1 |
59 +--------------------+----------------------------------------------------+
62 +--------------------+----------------------------------------------------+
65 +--------------------+----------------------------------------------------+
68 +--------------------+----------------------------------------------------+
71 +--------------------+----------------------------------------------------+
74 Software installation and deployment
75 ==========================================
77 This section describes the installation of the O-DU High on the reference hardware.
82 Following libraries are required to compile and execute O-DU High:
85 - Ubuntu : sudo apt-get install -y build-essential
86 - CentOS : sudo yum groups mark install -y “Development Tools”
88 Ensure the version is 4.6.3 and above using
93 - Ubuntu : sudo apt-get install -y libsctp-dev
94 - CentOS : sudo yum install -y lksctp-tools-devel
97 - Ubuntu : sudo apt-get install -y libpcap-dev
98 - CentOS : sudo yum install -y libpcap-devel
105 - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
107 - Clone code into <O-DU High Directory>
109 git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
112 Setting up Netconf server
113 -------------------------
115 Following steps are required to compile ODU with O1 interface enabled:
117 - Install Netconf libraries:
119 libssh, libyang, libnetconf2, sysrepo, netopeer2
121 Script is provided in the following folder to install these libraries
125 | cd <O-DU High Directory>/l2/build/scripts
126 | sudo ./install_lib.sh -c
128 - Start Netopeer2-server:
131 | cd <O-DU High Directory>/l2/build/scripts
132 | sudo ./netopeer-server.sh start
134 - Create a new netconf user
136 Switch to root user and run following commands
140 | adduser --system netconf && \\
141 | echo "netconf:netconf!" | chpasswd
143 | mkdir -p /home/netconf/.ssh && \\
144 | ssh-keygen -A && \\
145 | ssh-keygen -t dsa -P '' -f /home/netconf/.ssh/id_dsa && \\
146 | cat /home/netconf/.ssh/id_dsa.pub > /home/netconf/.ssh/authorized_keys
148 - Install the YANG modules
152 | cd <O-DU High Directory>/l2/build/yang
153 | sysrepoctl -i ./yang/o-ran-sc-odu-alarm-v1.yang
154 | sysrepoctl -i ./yang/o-ran-sc-odu-interface-v1.yang
155 | sysrepoctl -i ./yang/o-ran-sc-du-hello-world.yang
157 - Configure the startup IP and Port configurations for DU, CU and RIC
161 | cd <O-DU High Directory>/l2/build/config
163 | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
164 | Then load the configuration in the sysrepo running datastore using the command below
166 | sysrepocfg --import=startup_config.xml --datastore running --module o-ran-sc-odu-interface-v1
168 - Configure the netconf server details for VES PNF Event
172 | cd <O-DU High Directory>/l2/build/config
174 | Open the netconfConfig.json and edit the desired MAC address, IP, Port, Username and Password for VES PNF Registration.
176 - Configure the VES server details to send VES Events
180 | cd <O-DU High Directory>/l2/build/config
182 | Open the vesConfig.json and edit the desired IP, Port, Username and Password to send VES Event.
184 - Configure the nacm module to provide access to new user
188 | cd <O-DU High Directory>/l2/build/config
190 | Open the nacm_config.xml and edit the desired user-name to provide the access to that user.
192 | $sysrepocfg --import=nacm_config.xml --datastore running --module ietf-netconf-acm
200 - Navigate to Build folder
202 cd <O-DU High Directory>/l2/build/odu
204 - Clean O-DU High binary
206 make clean_odu MACHINE=BIT64 MODE=FDD
209 - Compile O-DU High binary
211 make odu MACHINE=BIT64 MODE=FDD
216 - Navigate to Build folder
218 cd <O-DU High Directory>/l2/build/odu
220 - Clean CU Stub binary
222 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
224 - Compile CU Stub binary
226 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
230 - Navigate to Build folder
232 cd <O-DU High Directory>/l2/build/odu
234 - Clean RIC Stub binary
236 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
238 - Compile RIC Stub binary
240 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
243 Compilation with O1 interface enabled
244 --------------------------------------
248 - Navigate to Build folder
250 cd <O-DU High Directory>/l2/build/odu
252 - Clean O-DU High binary
254 make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
257 - Compile O-DU High binary
259 make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
264 - Navigate to Build folder
266 cd <O-DU High Directory>/l2/build/odu
268 - Clean CU Stub binary
270 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
272 - Compile CU Stub binary
274 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
278 - Navigate to Build folder
280 cd <O-DU High Directory>/l2/build/odu
282 - Clean RIC Stub binary
284 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
286 - Compile RIC Stub binary
288 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
292 The above generated images can be found at:
294 - O-DU High - <O-DU High Directory>/l2/bin/odu
296 - CU Stub - <O-DU High Directory>/l2/bin/cu_stub
298 - RIC Stub - <O-DU High Directory>/l2/bin/ric_stub