.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. contents::
- :depth: 3
- :local:
-
O-DU High Installation Guide
*****************************
-Abstract
-========
-
This document describes how to install O-DU High, it's dependencies and required system resources.
.. contents::
:depth: 3
:local:
-Version history
+Version history
+---------------
+--------------------+--------------------+--------------------+--------------------+
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
+| 2022-12-15 | 5.0.1 | Radisys, | G release |
+| | | HCL Technologies | |
+| | | Ltd. | |
++--------------------+--------------------+--------------------+--------------------+
+| 2022-06-16 | 4.0.0 | Radisys, | F release |
+| | | HCL Technologies | |
+| | | Ltd. | |
++--------------------+--------------------+--------------------+--------------------+
+| 2022-01-14 | 3.0.0 | Radisys, | e-release |
+| | | HCL Technologies | |
+| | | Ltd. | |
++--------------------+--------------------+--------------------+--------------------+
+| 2021-07-07 | 2.0.0 | Radisys, | D Release |
+| | | HCL Technologies | |
+| | | Ltd. | |
++--------------------+--------------------+--------------------+--------------------+
| 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release |
| | | Ltd. | |
+--------------------+--------------------+--------------------+--------------------+
Introduction
-============
+------------
This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
Preface
-=======
+-------
O-DU High images can be built using the source code or corresponding docker images can be downloaded.
Hardware requirements
-=====================
+---------------------
Following minimum hardware requirements must be met for installation of O-DU High
Software installation and deployment
-==========================================
+-------------------------------------
This section describes the installation of the O-DU High on the reference hardware.
Libraries
-----------
+=========
Following libraries are required to compile and execute O-DU High:
Cloning code
---------------
+============
- Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
-Setting up Netconf server
--------------------------
-
- Following steps are required to compile ODU with O1 interface enabled:
-
-- Install Netconf libraries:
-
- libssh, libyang, libnetconf2, sysrepo, netopeer2
-
- Script is provided in the following folder to install these libraries
+Setting up Netconf server (Only if O1 interface enabled)
+========================================================
- - Ubuntu :
-
- | cd <O-DU High Directory>/l2/build/scripts
- | sudo ./install_lib.sh -c
-
-- Start Netopeer2-server:
-
- - Ubuntu :
- | cd <O-DU High Directory>/l2/build/scripts
- | sudo ./netopeer-server.sh start
+ Following steps are required to compile and run ODU with O1 interface enabled.
- Create a new netconf user
-
- Switch to root user and run following commands
-
- - Ubuntu :
-
- | adduser --system netconf && \\
- | echo "netconf:netconf!" | chpasswd
-
- | mkdir -p /home/netconf/.ssh && \\
- | ssh-keygen -A && \\
- | ssh-keygen -t dsa -P '' -f /home/netconf/.ssh/id_dsa && \\
- | cat /home/netconf/.ssh/id_dsa.pub > /home/netconf/.ssh/authorized_keys
-- Install the YANG modules
+ Switch to root user or use sudo and run following commands
- Ubuntu :
+ | cd <O-DU High Directory>/l2/build/scripts
+ | sudo ./add_netconf_user.sh
- | cd <O-DU High Directory>/l2/build/yang
- | sysrepoctl -i ./yang/o-ran-sc-odu-alarm-v1.yang
- | sysrepoctl -i ./yang/o-ran-sc-odu-interface-v1.yang
- | sysrepoctl -i ./yang/o-ran-sc-du-hello-world.yang
+- Install Netconf libraries:
-- Configure the startup IP and Port configurations for DU, CU and RIC
+ libssh, libyang, libnetconf2, sysrepo, netopeer2
- - Ubuntu :
+ Script is provided in the following folder to install these libraries
- | cd <O-DU High Directory>/l2/build/config
- |
- | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
- | Then load the configuration in the sysrepo running datastore using the command below
- |
- | sysrepocfg --import=startup_config.xml --datastore running --module o-ran-sc-odu-interface-v1
+ - Ubuntu :
+ | cd <O-DU High Directory>/l2/build/scripts
+ | sudo ./install_lib_O1.sh -c
-- Configure the netconf server details for VES PNF Event
+- Install the YANG modules and load initial configuration
- - Ubuntu :
+ - Navigate to config folder and update the desired initial configuration
| cd <O-DU High Directory>/l2/build/config
- |
- | Open the netconfConfig.json and edit the desired MAC address, IP, Port, Username and Password for VES PNF Registration.
-- Configure the VES server details to send VES Events
+ | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
+ | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
+ | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
+ | Open the oamVesConfig.json and edit the details of OAM VES collector.
+ | Open the smoVesConfig.json and edit the details of SMO VES collector.
+ | Open the netconfConfig.json and edit the details of Netopeer server.
- - Ubuntu :
+- Install the yang modules and load initial configuration.
- | cd <O-DU High Directory>/l2/build/config
- |
- | Open the vesConfig.json and edit the desired IP, Port, Username and Password to send VES Event.
+ - Ubuntu :
+
+ | $cd <O-DU High Directory>/l2/build/scripts
+ | $sudo ./load_yang.sh
-- Configure the nacm module to provide access to new user
+- Start Netopeer2-server:
- Ubuntu :
+ | cd <O-DU High Directory>/l2/build/scripts
+ | sudo ./netopeer-server.sh start
- | cd <O-DU High Directory>/l2/build/config
- |
- | Open the nacm_config.xml and edit the desired user-name to provide the access to that user.
- |
- | $sysrepocfg --import=nacm_config.xml --datastore running --module ietf-netconf-acm
-
+- In case standard defined VES format is to be enabled (this step is optional):
+
+ | cd l2/src/o1/ves
+
+ | Enable the Macro "StdDef" in file VesUtils.h
+ | #define StdDef
Compilation
-------------
+===========
- Build O-DU High:
Compilation with O1 interface enabled
---------------------------------------
+=====================================
- Build O-DU High:
Code Review / o-du / l2.git / blobdiff