Documentation updates for O1 related steps [Issue-Id: ODUHIGH-474]
[o-du/l2.git] / docs / user-guide.rst
index eb5ccfc..b24fb63 100644 (file)
@@ -4,7 +4,7 @@
 User Guide
 ***********
 
-This is the user guide for Cherry release of O-DU/l2.
+This is the user guide for F 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,8 @@ 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.
+    In case O1 is enabled and SMO is not available run section D to start the stack.
 
 II. Execution - Using Docker Images
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -62,17 +66,17 @@ II. Execution - Using Docker Images
 The call flow between O-DU High and CU Stub can be achieved by executing docker containers.
 
 - Pull the last built docker images:
-    -  docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:3.0.1
-    -  docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:3.0.1
+    -  docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:6.0.3
+    -  docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:6.0.3
 
 - Run CU Stub docker:
     - docker run -it --privileged --net=host --entrypoint bash
-      nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:3.0.1   
+      nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:6.0.3
     - ./cu_stub
 
 - Run ODU docker:
     - docker run -it --privileged --net=host --entrypoint bash
-      nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:3.0.1   
+      nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:6.0.3
     - ./odu
 
 
@@ -127,7 +131,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 +147,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 +195,62 @@ 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. Push cell and slice configuration over O1 using netopeer-cli
+---------------------------------------------------------------
+   When O-DU High is run with O1 enabled it waits for initial cell configuration to be pushed by SMO before starting the stack. In case the SMO is not available then these configurations can be pushed via netopeer-cli as follows:
+
+      | $cd l2/build/config
+      | $netopeer2-cli
+      |  > connect --login netconf
+      |  Interactive SSH Authentication
+      |  Type your password:
+      |  Password: netconf!
+      |  > edit-config --target candidate --config=cellConfig.xml
+      |  > OK
+      |  > commit
+      |  > OK
+      |  > edit-config --target candidate --config=rrmPolicy.xml
+      |  > OK
+      |  > commit
+      |  > OK
+
+   For pushing these configurations in subsequent runs please edit cellConfig.xml and rrmPolicy.xml and increment number in the <id> tag to a new value e.g.
+
+    <id>rrm-2</id
+
+E. How to execute the Health Check using netopeer-cli : get alarm-list
+-----------------------------------------------------------------------
+
+   In case the SMO is not available the alarm list can be checked using netopeer-cli as follows:
+
+     |  netopeer2-cli
+     |  > connect --login netconf
+     |  Interactive SSH Authentication
+     |  Type your password:
+     |  Password: netconf!
+     |  > 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.
+