X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=fbc906013ee8b696bdcad946df272fe34cc6c379;hb=1d6200fae3b85714f8d9ddec062a01c8b9faca23;hp=5a4ea45c5845937a45eefe7322be643a2af54659;hpb=ce136a8facf53778e327bead92b0cfe91b566571;p=o-du%2Fl2.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 5a4ea45c5..fbc906013 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -24,6 +24,10 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ +| 2021-07-07 | 2.0.0 | Radisys, | D Release | +| | | HCL Technologies | | +| | | Ltd. | | ++--------------------+--------------------+--------------------+--------------------+ | 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release | | | | Ltd. | | +--------------------+--------------------+--------------------+--------------------+ @@ -97,29 +101,64 @@ Following libraries are required to compile and execute O-DU High: - Ubuntu : sudo apt-get install -y libpcap-dev - CentOS : sudo yum install -y libpcap-devel -Following libraries are required to compile and execute O1 module: + + +Cloning code +-------------- + +- Create a folder to clone the O-DU High code into. The folder is hereafter referred to as . + +- Clone code into + + git clone "https://gerrit.o-ran-sc.org/r/o-du/l2" + + +Setting up Netconf server (Only if O1 interface enabled) +-------------------------------------------------------- -- Netconf: + Following steps are required to compile and run ODU with O1 interface enabled. + +- Create a new netconf user + + Switch to root user or use sudo and run following commands + + - Ubuntu : + | cd /l2/build/scripts + | sudo ./add_netconf_user.sh + +- Install Netconf libraries: + libssh, libyang, libnetconf2, sysrepo, netopeer2 Script is provided in the following folder to install these libraries - - Ubuntu : - - | cd /l2/build/o1 - | sudo ./install_lib.sh + - Ubuntu : + | cd /l2/build/scripts + | sudo ./install_lib_O1.sh -c +- Install the YANG modules and load initial configuration -Cloning code --------------- + - Navigate to config folder and update the desired initial configuration -- Create a folder to clone the O-DU High code into. The folder is hereafter referred to as . + - Ubuntu : + | cd /l2/build/config -- Clone code into + | 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 vesConfig.json and edit the details of VES collector. + | Open the netconfConfig.json and edit the details of Netopeer server. + | Install the yang modules and load initial configuration. + + - Ubuntu : + | cd /l2/build/scripts + | sudo ./load_yang.sh + +- Start Netopeer2-server: - git clone "https://gerrit.o-ran-sc.org/r/o-du/l2" && (cd "l2" && mkdir -p .git/hooks && curl -Lo `git rev-parse - --git-dir`/hooks/commit-msg https://gerrit.o-ran-sc.org/r/tools/hooks/commit-msg; chmod +x `git rev-parse - --git-dir`/hooks/commit-msg) + - Ubuntu : + | cd /l2/build/scripts + | sudo ./netopeer-server.sh start Compilation @@ -136,13 +175,10 @@ Compilation make clean_odu MACHINE=BIT64 MODE=FDD - - Build O-DU High binary + - Compile O-DU High binary make odu MACHINE=BIT64 MODE=FDD - To build with O1 interface enabled: - - make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES - Build CU Stub : @@ -154,7 +190,7 @@ Compilation make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD - - Build CU Stub binary + - Compile CU Stub binary make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD @@ -168,35 +204,57 @@ Compilation make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD - - Build RIC Stub binary + - Compile RIC Stub binary make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD -- Build O-DU High with O1 interface enabled: - - Navigate to o1 Build folder +Compilation with O1 interface enabled +-------------------------------------- + +- Build O-DU High: + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean O-DU High binary + + make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + + - Compile O-DU High binary + + make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + +- Build CU Stub : + + - Navigate to Build folder - cd /l2/build/o1 + cd /l2/build/odu - - Clean O1 binary + - Clean CU Stub binary - make clean_o1 MACHINE=BIT64 + make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES - - Build O1 binary + - Compile CU Stub binary - make o1 MACHINE=BIT64 + make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES - - Navigate to odu Build folder +- Build RIC Stub : + - Navigate to Build folder + cd /l2/build/odu - - Clean O-DU High binary + - Clean RIC Stub binary + + make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES - make clean_odu MACHINE=BIT64 MODE=FDD - - - Build O-DU High binary + - Compile RIC Stub binary - make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES @@ -208,4 +266,3 @@ The above generated images can be found at: - RIC Stub - /l2/bin/ric_stub -- O1 - /l2/build/o1/bin/o1