[Task-ID: ODUHIGH-455] Changes to support new L1 20.11

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

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 8a1f7b6..19437b9 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 F release of O-DU/l2.
 Follow installation-guide to get all the dependencies ready.
 
 .. contents::
@@ -24,35 +24,10 @@ 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"
 
-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 <O-DU High Directory>/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 <O-DU High Directory>/l2/build/o1/bin/o1
-
-   d. Run O1 binary
-      
-      - ./o1
-
-3. Execute CU Stub:
+2. Execute CU Stub:
 
    a. Navigate to CU execution folder
 
@@ -62,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
 
@@ -72,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
 
@@ -82,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. 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. 
+    In case O1 is enabled and SMO is not available follow section E below.
 
 II. Execution - Using Docker Images
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -90,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.2
+    -  docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:6.0.2
 
 - 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.2
     - ./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.2
     - ./odu
 
 
@@ -155,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
@@ -171,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
@@ -219,7 +195,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
 
@@ -240,7 +216,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,4 +243,14 @@ 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.
+E. Push cell and slice configuration over O1 using netopeer-cli
+---------------------------------------------------------------
+
+When O-DU High is run with O1 enabled it waits for cell configuration to be pushed by SMO. In case the SMO is not available then these configurations can be pushed via netopeer-cli as follows.
+
+   1. Follow step D.1 and D.2.
+   2. update cellConfig.xml and rrmPolicy.xml.
+
+      | $cd <O-DU High Directory>/l2/build/config
+      | $edit-config --target candidate --config=cellConfig.xml
+      | $edit-config --target candidate --config=rrmPolicy.xml