X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FREADME;h=bd57bec0a5696d29d9766ced350051307a32c325;hb=refs%2Fchanges%2F48%2F7348%2F3;hp=cb5ebfa4bbd39acd27de2f568f4fb525a01a43c1;hpb=d76403d03e7b7f60cd515f1b834d28278685a70b;p=o-du%2Fl2.git diff --git a/docs/README b/docs/README index cb5ebfa4b..bd57bec0a 100644 --- a/docs/README +++ b/docs/README @@ -18,7 +18,7 @@ A. Directory Structure : f. mt : wrapper functions over OS g. phy_stub : Stub code for Physical layer h. rlog : logging module - i. o1 : o1 module + i. O1 : O1 module B. Pre-requisite for Compilation : @@ -37,36 +37,31 @@ C. Pre-requisite for O1 Interface (Required only if run with O1 interface enable ----------------------------------------------------------------------------------- 1. Setup netconf server - Create new netconf user (login with root user and run following commands) - $adduser --system netconf && \ - echo "netconf:netconf" | chpasswd + a. Add new netconf user (login with root user or use sudo and run following script) + $cd l2/build/scripts + $sudo ./add_netconf_user.sh - $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 - Install netconf packages. - $cd l2/build/scripts - $chmod +x install_lib.sh - $ ./install_lib.sh -c + b. Install netconf packages. + $chmod +x install_lib_O1.sh + $sudo ./install_lib_O1.sh -c -2. Start Netopeer2-server: - $cd l2/build/scripts - $./netopeer-server.sh start - -3. Install the yang modules - $cd l2/build/yang - $sysrepoctl -i o-ran-sc-odu-alarm-v1.yang - $sysrepoctl -i o-ran-sc-odu-interface-v1.yang - -4. Configure the startup IP and Port configurations for DU, CU and RIC +2. Update the configuration according to your setup. $cd l2/build/config - Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC. - Then load the configuration in the sysrepo running datastore using the command below + a. Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC. + b. Open the nacm_config.xml and edit the desired user name to provide the access to that user. + c. Open the netconf_server_ipv6.xml and edit the desired netconf server configuration. + d. Open the vesConfig.json and edit the details of VES collector. + e. Open the netconfConfig.json and edit the details of Netopeer server. + f. Install the yang modules and load initial configuration - $sysrepocfg --import=startup_config.xml --datastore running --module o-ran-sc-odu-interface-v1 + $cd l2/build/scripts + $sudo ./load_yang.sh + +3. Start Netopeer2-server: + $cd l2/build/scripts + $sudo ./netopeer-server.sh start D. How to Clean and Build: @@ -153,7 +148,7 @@ F. How to execute: b. ifconfig :CU_STUB "192.168.130.82" c. ifconfig :RIC_STUB "192.168.130.80" -PS: If O1 interface is enabled, IP should match those configured in step C.4. +PS: If O1 interface is enabled, IP should match those configured in step C.2.a. 2. Execute CU Stub: a. CU execution folder: @@ -256,7 +251,7 @@ H. How to execute the Health Check : get alarm-list 2. Connect to the server with user: netconf - pwd: netconf + pwd: netconf! 3. Send a Netconf get request for alarms xpath @@ -283,3 +278,11 @@ 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. + +G. Troubleshooting Netconf server issues +---------------------------------------- + In case the Netconf server and sysrepo breaks down, run the following steps: + + $cd l2/build/scripts + $sudo ./troubleshoot_netconf.sh cleanup + execute section C.2.f, C.3 again