From: Vidhu Date: Wed, 21 Sep 2022 10:07:26 +0000 (+0530) Subject: Documentation updates for O1 related steps [Issue-Id: ODUHIGH-474] X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?p=o-du%2Fl2.git;a=commitdiff_plain;h=556a245161500882667a29ab42d61e741fc21318 Documentation updates for O1 related steps [Issue-Id: ODUHIGH-474] Signed-off-by: Vidhu Change-Id: I2e93ac586ed864cf38e5107ac2dd5ff00e0205e8 --- diff --git a/docs/README b/docs/README index 8b5056d3a..e64a0935b 100644 --- a/docs/README +++ b/docs/README @@ -55,12 +55,18 @@ C. Pre-requisite for O1 Interface (Required only if run with O1 interface enable d. Open the oamVesConfig.json and edit the details of OAM VES collector. e. Open the smoVesConfig.json and edit the details of SMO VES collector. f. Open the netconfConfig.json and edit the details of Netopeer server. - g. Install the yang modules and load initial configuration + +3. Install the yang modules and load initial configuration: $cd l2/build/scripts $sudo ./load_yang.sh - h. To enable Standard Defined VES format: +4. Start Netopeer2-server: + + $cd l2/build/scripts + $sudo ./netopeer-server.sh start + +5. In case standard defined VES format is to be enabled (this step is optional): cd l2/src/o1/ves @@ -68,10 +74,6 @@ C. Pre-requisite for O1 Interface (Required only if run with O1 interface enable #define StdDef -3. Start Netopeer2-server: - $cd l2/build/scripts - $sudo ./netopeer-server.sh start - D. How to Clean and Build: -------------------------- @@ -178,7 +180,7 @@ PS: If O1 interface is enabled, IP should match those configured in step C.2.a. ./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 H to start the stack. G. How to test with Intel L1: ----------------------------- @@ -250,27 +252,40 @@ II. Execution ./odu -H. How to execute the Health Check : get alarm-list ----------------------------------------------------- - - Steps: +H. 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: - 1. Start Netconf netopeer client - - 2. Connect to the server with + $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 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 @@ -287,15 +302,6 @@ H. How to execute the Health Check : get alarm-list The XML output is a list of active alarms in the O-DU High system. -I. 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 H.1 and H.2. - 2. update cellConfig.xml and rrmPolicy.xml. - $cd l2/build/config - $edit-config --target candidate --config=cellConfig.xml - $edit-config --target candidate --config=rrmPolicy.xml - J. Troubleshooting Netconf server issues ---------------------------------------- @@ -303,4 +309,4 @@ J. Troubleshooting Netconf server issues $cd l2/build/scripts $sudo ./troubleshoot_netconf.sh cleanup - execute section C.2.f, C.3 again + execute section C.3 and C.4 again diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index aced1ed4b..3a7489117 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -150,26 +150,26 @@ Setting up Netconf server (Only if O1 interface enabled) | Open the oamVesConfig.json and edit the details of OAM VES collector. | Open the smoVesConfig.json and edit the details of SMO VES collector. | Open the netconfConfig.json and edit the details of Netopeer server. - | Install the yang modules and load initial configuration. + +- Install the yang modules and load initial configuration. - Ubuntu : | $cd /l2/build/scripts | $sudo ./load_yang.sh - - To enable Standard Defined VES format: - - | cd l2/src/o1/ves - - | Enable the Macro "StdDef" in file VesUtils.h - | #define StdDef - - Start Netopeer2-server: - Ubuntu : | cd /l2/build/scripts | sudo ./netopeer-server.sh start +- In case standard defined VES format is to be enabled (this step is optional): + + | cd l2/src/o1/ves + + | Enable the Macro "StdDef" in file VesUtils.h + | #define StdDef Compilation =========== diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 18dac0e53..b24fb63a4 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -57,8 +57,8 @@ PS: If O1 interface is enabled, IPs should match those configured in "startup_co - ./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 follow section E below. +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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -66,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:6.0.4 - - docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:6.0.4 + - 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:6.0.4 + 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:6.0.4 + nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:6.0.3 - ./odu @@ -205,28 +205,39 @@ Note: UL IQ-Sample request and response are needed by Intel O-DU Low in timer mo 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 | @@ -243,14 +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. -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 /l2/build/config - | $edit-config --target candidate --config=cellConfig.xml - | $edit-config --target candidate --config=rrmPolicy.xml