Integration issues of o1

[o-du/l2.git] / docs / user-guide.rst

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index eb5ccfc..1d077d7 100644 (file)
--- 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,6 +24,9 @@ I. Execution - On locally compiling O-DU High Source Code
    b. ifconfig <interface name>:CU_STUB "192.168.130.82"
    c. ifconfig <interface name>:RIC_STUB "192.168.130.80"
 
+PS: If O1 interface is enabled, IPs should match those configured in "startup_config.xml"
+    ( Refer Installation Guide - "Setting up Netconf server" )
+
 2. Execute CU Stub:
 
    a. Navigate to CU execution folder
@@ -54,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
+PS: CU stub and RIC stub must be run (in no particular sequence) before ODU. 
 
 II. Execution - Using Docker Images
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -127,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
@@ -143,7 +146,7 @@ III. Execution
       b. Run O-DU Low binary :
       
          - cd <O-DU Low Directory>/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
@@ -191,12 +194,50 @@ 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 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
+     |  <odu xmlns=\"urn\:o-ran\:odu\:alarm\:1.0\">
+     |    <alarms>
+     |      <alarm>
+     |        <alarm-id>1009</alarm-id>
+     |        <alarm-text>cell id  [1] is up</alarm-text>
+     |        <severity>2</severity>
+     |        <status>Active</status>
+     |        <additional-info>cell UP</additional-info>
+     |      </alarm>
+     |    </alarms>
+     |  </odu>
+
+The XML output is a list of active alarms in the O-DU High system.