X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fuser-guide.rst;h=1d077d786520322d400e4e41fb079427ec76bdd1;hb=refs%2Fchanges%2F48%2F7348%2F3;hp=04f463d57cf96a50963b8e36d691b11b458cb511;hpb=f01eb5471d34834e2ef1d8dbbfc4b2fe68403650;p=o-du%2Fl2.git diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 04f463d57..1d077d786 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -4,7 +4,7 @@ User Guide *********** -This is the user guide for Cherry release of O-DU/l2. +This is the user guide for D release of O-DU/l2. Follow installation-guide to get all the dependencies ready. .. contents:: @@ -24,36 +24,10 @@ 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 O1 (only if O-DU is built with O1 interface enabled): +PS: If O1 interface is enabled, IPs should match those configured in "startup_config.xml" + ( Refer Installation Guide - "Setting up Netconf server" ) - 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 - sysrepoctl -i ./yang/o-ran-sc-odu-interface-v1.yang - - c. Navigate to O1 execution folder - - - cd /l2/build/o1/bin/o1 - - d. Run O1 binary - - - ./o1 - -3. Execute CU Stub: +2. Execute CU Stub: a. Navigate to CU execution folder @@ -63,7 +37,7 @@ I. Execution - On locally compiling O-DU High Source Code - ./cu_stub -4. Execute RIC Stub: +3. Execute RIC Stub: a. Navigate to RIC execution folder @@ -73,7 +47,7 @@ I. Execution - On locally compiling O-DU High Source Code - ./ric_stub -5. Execute O-DU High: +4. Execute O-DU High: a. Navigate to ODU execution folder @@ -83,7 +57,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. If O-DU High is built with O1 interface enabled, the O1 binary must be run before all other binaries. +PS: CU stub and RIC stub must be run (in no particular sequence) before ODU. II. Execution - Using Docker Images ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -156,7 +130,7 @@ II. Compilation d. Build ODU Binary: - - make odu PHY=INTEL_L1 PHY_MODE=TIMER MACHINE=BIT64 MODE=FDD + - make odu PHY=INTEL_L1 MACHINE=BIT64 MODE=FDD III. Execution @@ -172,7 +146,7 @@ III. Execution b. Run O-DU Low binary : - cd /FlexRAN/l1/bin/nr5g/gnb/l1 - - To run in timer mode : ./l1.sh -e + - To run in radio mode : ./l1.sh -xran - L1 is up when following prints are seen on console: | Non BBU threads in application @@ -220,7 +194,7 @@ C. Message Flow: O-DU High opens WLS interface during bring up. Message exchanges can begin once the interface is ready. Following diagram shows P5 messages exchanged with O-DU Low in timer mode. -.. figure:: O-DU_High_Low_Flow.jpg +.. figure:: O-DU_High_Low_Flow.PNG :width: 600 :alt: Figure 7 O-DU High - O-DU Low Message Flow Diagram @@ -241,7 +215,7 @@ To execute the get alarm-list flow, following steps are required to be executed: 2. Connect to the server with | user: netconf - | pwd: netconf + | pwd: netconf! 3. Send a Netconf get request for alarms xpath @@ -267,5 +241,3 @@ Here are the steps as executed in the terminal | 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.