X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fuser-guide.rst;h=01d1729bcb872e4921cff3124faaf51aa00899fe;hb=26bef3ac5e0b2a5dc9f72c8001e10a3f69528e50;hp=04f463d57cf96a50963b8e36d691b11b458cb511;hpb=069f38324ca51afc183962404383802ae8a5553c;p=o-du%2Fl2.git diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 04f463d57..01d1729bc 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 I 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,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 run section D to start the stack. II. Execution - Using Docker Images ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -91,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:9.0.4 + - docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub: - 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:9.0.4 - ./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:9.0.4 - ./odu @@ -109,7 +84,7 @@ B. Pairwise testing with Intel O-DU Low: ----------------------------------------- This section describes the changes required in compilation and execution of O-DU High binaries to successfully integrate -with Intel O-DU Low in timer mode. +with Intel O-DU Low in radio mode. I. Pre-requisites @@ -156,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 @@ -172,7 +147,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,38 +195,49 @@ 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 + :alt: Figure 28 O-DU High - O-DU Low Message Flow Diagram - Figure 7 - O-DU High - O-DU Low Message Flow Diagram + Figure 28 - 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: -D. Health Check execution: get alarm-list -------------------------------------------- - -To execute the get alarm-list flow, following steps are required to be executed: + | $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 - 1. Start Netconf netopeer client - - 2. Connect to the server with + For pushing these configurations in subsequent runs please edit cellConfig.xml and rrmPolicy.xml and increment number in the tag to a new value e.g. - | user: netconf - | pwd: netconf + rrm-2 connect --login netconf | Interactive SSH Authentication | Type your password: - | Password: + | Password: netconf! | > get --filter-xpath /o-ran-sc-odu-alarm-v1\:odu/alarms | DATA | @@ -268,4 +254,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.