docs/installation-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 .. contents::
   5    :depth: 3
   6    :local:
   7
   8 O-DU High Installation Guide
   9 *****************************
  10
  11 Abstract
  12 ========
  13
  14 This document describes how to install O-DU High, it's dependencies and required system resources.
  15
  16 .. contents::
  17    :depth: 3
  18    :local:
  19
  20 Version history
  21
  22
  23 +--------------------+--------------------+--------------------+--------------------+
  24 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  25 |                    |                    |                    |                    |
  26 +--------------------+--------------------+--------------------+--------------------+
  27 | 2020-12-04         |  1.0.1             |  HCL Technologies  |  Cherry Release    |
  28 |                    |                    |  Ltd.              |                    |
  29 +--------------------+--------------------+--------------------+--------------------+
  30 | 2020-12-04         |  1.0               |  Radisys           |  Cherry Release    |
  31 |                    |                    |                    |                    |
  32 +--------------------+--------------------+--------------------+--------------------+
  33
  34
  35 Introduction
  36 ============
  37
  38 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
  39
  40 The audience of this document is assumed to have good knowledge in RAN concepts and Linux system.
  41
  42
  43 Preface
  44 =======
  45
  46 O-DU High images can be built using the source code or corresponding docker images can be downloaded.
  47
  48
  49 Hardware requirements
  50 =====================
  51
  52 Following minimum hardware requirements must be met for installation of O-DU High
  53
  54 +--------------------+----------------------------------------------------+
  55 | **HW Aspect**      | **Requirement**                                    |
  56 |                    |                                                    |
  57 +--------------------+----------------------------------------------------+
  58 | **# of servers**   |  1                                                 |
  59 +--------------------+----------------------------------------------------+
  60 | **CPU**            |  4                                                 |
  61 |                    |                                                    |
  62 +--------------------+----------------------------------------------------+
  63 | **RAM**            |  8G                                                |
  64 |                    |                                                    |
  65 +--------------------+----------------------------------------------------+
  66 | **Disk**           |  500G                                              |
  67 |                    |                                                    |
  68 +--------------------+----------------------------------------------------+
  69 | **NICs**           |  1                                                 |
  70 |                    |                                                    |
  71 +--------------------+----------------------------------------------------+
  72
  73
  74 Software installation and deployment
  75 ==========================================
  76
  77 This section describes the installation of the O-DU High on the reference hardware.
  78
  79 Libraries
  80 ----------
  81
  82 Following libraries are required to compile and execute O-DU High:
  83
  84 - GCC
  85    - Ubuntu : sudo apt-get install -y build-essential
  86    - CentOS : sudo yum groups mark install -y “Development Tools”
  87
  88    Ensure the version is 4.6.3 and above using
  89
  90    -    gcc --version
  91
  92 - LKSCTP
  93    - Ubuntu : sudo apt-get install -y libsctp-dev
  94    - CentOS : sudo yum install -y lksctp-tools-devel
  95
  96 - PCAP:
  97    - Ubuntu : sudo apt-get install -y libpcap-dev
  98    - CentOS : sudo yum install -y libpcap-devel
  99
 100
 101
 102 Cloning code
 103 --------------
 104
 105 - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
 106
 107 - Clone code into <O-DU High Directory>
 108
 109   git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
 110
 111
 112 Setting up Netconf server
 113 -------------------------
 114
 115   Following steps are required to compile and run ODU with O1 interface enabled.
 116   This requires SMO components (OAM and VES collector) to be running.
 117
 118 - Create a new netconf user
 119
 120       Switch to root user or use sudo and run following commands
 121
 122    - Ubuntu :
 123       | cd <O-DU High Directory>/l2/build/scripts
 124       | sudo ./add_netconf_user.sh
 125
 126 - Install Netconf libraries:
 127
 128    libssh, libyang, libnetconf2, sysrepo, netopeer2
 129
 130    Script is provided in the following folder to install these libraries
 131
 132    - Ubuntu :
 133        | cd <O-DU High Directory>/l2/build/scripts
 134        | sudo ./install_lib_O1.sh -c
 135
 136 - Install the YANG modules and load initial configuration
 137
 138     - Navigate to config folder and update the desired initial configuration
 139
 140    - Ubuntu :
 141        | cd <O-DU High Directory>/l2/build/config
 142
 143       | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
 144       | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
 145       | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
 146       | Open the vesConfig.json and edit the details of VES collector.
 147       | Open the netconfConfig.json and edit the details of Netopeer server.
 148       | Install the yang modules and load initial configuration.
 149
 150    - Ubuntu :
 151        | cd <O-DU High Directory>/l2/build/scripts
 152        | sudo ./load_yang.sh
 153
 154 - Start Netopeer2-server:
 155
 156    - Ubuntu :
 157        | cd <O-DU High Directory>/l2/build/scripts
 158        | sudo ./netopeer-server.sh start
 159
 160
 161 Compilation
 162 ------------
 163
 164 - Build O-DU High:
 165
 166    - Navigate to Build folder
 167
 168        cd <O-DU High Directory>/l2/build/odu
 169
 170    - Clean O-DU High binary
 171
 172        make clean_odu MACHINE=BIT64 MODE=FDD
 173
 174
 175    - Compile O-DU High binary
 176
 177        make odu MACHINE=BIT64 MODE=FDD
 178
 179
 180 - Build CU Stub :
 181
 182    - Navigate to Build folder
 183
 184        cd <O-DU High Directory>/l2/build/odu
 185
 186    - Clean CU Stub binary
 187
 188        make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
 189
 190    - Compile CU Stub binary
 191
 192        make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
 193
 194 - Build RIC Stub :
 195
 196    - Navigate to Build folder
 197
 198        cd <O-DU High Directory>/l2/build/odu
 199
 200    - Clean RIC Stub binary
 201
 202        make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
 203
 204    - Compile RIC Stub binary
 205
 206        make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
 207
 208
 209 Compilation with O1 interface enabled
 210 --------------------------------------
 211
 212 - Build O-DU High:
 213
 214    - Navigate to Build folder
 215
 216        cd <O-DU High Directory>/l2/build/odu
 217
 218    - Clean O-DU High binary
 219
 220        make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
 221
 222
 223    - Compile O-DU High binary
 224
 225        make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
 226
 227
 228 - Build CU Stub :
 229
 230    - Navigate to Build folder
 231
 232        cd <O-DU High Directory>/l2/build/odu
 233
 234    - Clean CU Stub binary
 235
 236        make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
 237
 238    - Compile CU Stub binary
 239
 240        make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
 241
 242 - Build RIC Stub :
 243
 244    - Navigate to Build folder
 245
 246        cd <O-DU High Directory>/l2/build/odu
 247
 248    - Clean RIC Stub binary
 249
 250        make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
 251
 252    - Compile RIC Stub binary
 253
 254        make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
 255
 256
 257
 258 The above generated images can be found at:
 259
 260 - O-DU High - <O-DU High Directory>/l2/bin/odu
 261
 262 - CU Stub   - <O-DU High Directory>/l2/bin/cu_stub
 263
 264 - RIC Stub  - <O-DU High Directory>/l2/bin/ric_stub
 265