X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fuser-guide.rst;h=8a1f7b60e16bbc1a03ef5566aeb633b245ab5871;hb=2f4aa1b4a81b2511d67ef0894923a7733da65be7;hp=b58f85ab827f63b69cd297e2675887c9f1d73132;hpb=bd13ba3b2661a413492608b9cb16c699b3831d5e;p=o-du%2Fl2.git diff --git a/docs/user-guide.rst b/docs/user-guide.rst index b58f85ab8..8a1f7b60e 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -1,12 +1,11 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. (c) - User Guide *********** This is the user guide for Cherry release of O-DU/l2. +Follow installation-guide to get all the dependencies ready. .. contents:: :depth: 3 @@ -25,7 +24,35 @@ I. Execution - On locally compiling O-DU High Source Code b. ifconfig :CU_STUB "192.168.130.82" c. ifconfig :RIC_STUB "192.168.130.80" -2. Execute CU Stub: +2. Execute O1 (only if O-DU is built with O1 interface enabled): + + a. Navigate to O1 build folder + + - cd /l2/build/o1 + + b. Create a new netconf user and install the YANG module + + Switch to root user and run following commands + + | 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 + + sysrepoctl -i ./yang/o-ran-sc-odu-alarm-v1.yang + + c. Navigate to O1 execution folder + + - cd /l2/build/o1/bin/o1 + + d. Run O1 binary + + - ./o1 + +3. Execute CU Stub: a. Navigate to CU execution folder @@ -35,7 +62,7 @@ I. Execution - On locally compiling O-DU High Source Code - ./cu_stub -3. Execute RIC Stub: +4. Execute RIC Stub: a. Navigate to RIC execution folder @@ -45,7 +72,7 @@ I. Execution - On locally compiling O-DU High Source Code - ./ric_stub -4. Execute O-DU High: +5. Execute O-DU High: a. Navigate to ODU execution folder @@ -55,7 +82,7 @@ I. Execution - On locally compiling O-DU High Source Code - ./odu -PS: CU stub and RIC stub must be run (in no particular sequence) before ODU +PS: CU stub and RIC stub must be run (in no particular sequence) before ODU. If O-DU High is built with O1 interface enabled, the O1 binary must be run before all other binaries. II. Execution - Using Docker Images ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -84,8 +111,22 @@ This section describes the changes required in compilation and execution of O-DU with Intel O-DU Low in timer mode. -I. Compilation -^^^^^^^^^^^^^^ +I. Pre-requisites +^^^^^^^^^^^^^^^^^^ + + 1. Install O-DU High as per installation-guide . + + 2. Clone O-DU Low code in from + + a. https://gerrit.o-ran-sc.org/r/admin/repos/o-du/phy and, + + b. https://github.com/intel/FlexRAN + + 3. Install O-DU Low as per https://docs.o-ran-sc.org/projects/o-ran-sc-o-du-phy/en/latest/index.html . + + +II. Compilation +^^^^^^^^^^^^^^^^ 1. Build ODU : @@ -117,8 +158,8 @@ I. Compilation - make odu PHY=INTEL_L1 PHY_MODE=TIMER MACHINE=BIT64 MODE=FDD -II. Execution -^^^^^^^^^^^^^ +III. Execution +^^^^^^^^^^^^^^^ 1. Execute O-DU Low: @@ -180,10 +221,50 @@ Following diagram shows P5 messages exchanged with O-DU Low in timer mode. .. figure:: O-DU_High_Low_Flow.jpg :width: 600 - :alt: Figure 1 O-DU High - O-DU Low Message Flow Diagram + :alt: Figure 7 O-DU High - O-DU Low Message Flow Diagram - Figure 5 - O-DU High - O-DU Low Message Flow Diagram + Figure 7 - O-DU High - O-DU Low Message Flow Diagram Note: UL IQ-Sample request and response are needed by Intel O-DU Low in timer mode(testing mode) only. Code changes for these are guarded under INTEL_TIMER_MODE flag which can be enabled using compilation option "PHY_MODE=TIMER", as mentioned in section B.I.1.d . + + +D. Health Check execution: get alarm-list +------------------------------------------- + +To execute the get alarm-list flow, following steps are required to be executed: + + 1. Start Netconf netopeer client + + 2. Connect to the server with + + | user: netconf + | pwd: netconf + + 3. Send a Netconf get request for alarms xpath + +Here are the steps as executed in the terminal + + | netopeer2-cli + | > connect --login netconf + | Interactive SSH Authentication + | Type your password: + | Password: + | > get --filter-xpath /o-ran-sc-odu-alarm-v1\:odu/alarms + | DATA + | + | + | + | 1009 + | cell id [1] is up + | 2 + | Active + | cell UP + | + | + | + +The XML output is a list of active alarms in the O-DU High system. + +Note: Integration with SMO/OAM is not yet done so a Netconf CLI client(netopeer2-cli) is used to connect to the Netconf server and send the get request.