X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2FREADME;h=9eb9fe7b431be680af08cdc0f437559bc055ad6f;hb=8748e788a43465b180c15d31908c276504dad6d4;hp=cc9d63803bf199504caaedc569fae6f9c0bd8efa;hpb=b92944068f8a7b643b333515e424517db4192b61;p=o-du%2Fl2.git diff --git a/docs/README b/docs/README index cc9d63803..9eb9fe7b4 100644 --- a/docs/README +++ b/docs/README @@ -39,7 +39,7 @@ C. Pre-requisite for O1 Interface (Required only if run with O1 interface enable Create new netconf user (login with root user and run following commands) $adduser --system netconf && \ - echo "netconf:netconf" | chpasswd + echo "netconf:netconf!" | chpasswd $mkdir -p /home/netconf/.ssh && \ ssh-keygen -A && \ @@ -47,8 +47,8 @@ C. Pre-requisite for O1 Interface (Required only if run with O1 interface enable 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 + $chmod +x install_lib_O1.sh + $ ./install_lib_O1.sh -c 2. Start Netopeer2-server: $cd l2/build/scripts @@ -58,6 +58,7 @@ C. Pre-requisite for O1 Interface (Required only if run with O1 interface enable $cd l2/build/yang $sysrepoctl -i o-ran-sc-odu-alarm-v1.yang $sysrepoctl -i o-ran-sc-odu-interface-v1.yang + $sysrepoctl -i o-ran-sc-du-hello-world.yang 4. Configure the startup IP and Port configurations for DU, CU and RIC @@ -68,34 +69,71 @@ C. Pre-requisite for O1 Interface (Required only if run with O1 interface enable $sysrepocfg --import=startup_config.xml --datastore running --module o-ran-sc-odu-interface-v1 +5. Configure the netconf server details for VES PNF Event + + $cd l2/build/config + + Open the netconfConfig.json and edit the desired MAC address, IP, Port, Username and Password for VES PNF Registration. + +6. Configure the VES server details to send VES Events + + $cd l2/build/config + + Open the vesConfig.json and edit the desired IP, Port, Username and Password to send VES Event. + +7. Configure the nacm module to provide access to new user + + $cd l2/build/config + + Open the nacm_config.xml and edit the desired user-name to provide the access to that user. + + $sysrepocfg --import=nacm_config.xml --datastore running --module ietf-netconf-acm + + D. How to Clean and Build: -------------------------- -1. Building ODU binary: +1. Build commands: + a. odu - Builds all components of ODU + b. cu_stub - Builds all CU Stub + c. ric_stub - Builds all RIC_Stub + d. clean_odu - clean up ODU + e. clean_cu - clean up CU Stub + f. clean_ric - clean up RIC Stub + g. clean_all - cleanup everything + h. options: + i. MACHINE=BIT64/BIT32 - Specify underlying machine type. Default is BIT32 + ii. NODE=TEST_STUB - Specify if it is a test node. Mandatory for cu_stub/ric_stub. Must not be used for odu + iii. MODE=FDD/TDD - Specify duplex mode. Default is FDD + iv. PHY=INTEL_L1 - Specify type of phy. If not specified, PHY stub is used + v. PHY_MODE=TIMER - Specify mode of phy. Used only if PHY=INTEL_L1. Default is radio mode + vi. O1_ENABLE=YES - Specify if O1 interface is enabled. If not specified, it is disabled + +2. Building ODU binary: a. Build folder cd l2/build/odu b. Building ODU binary - make odu MACHINE=BIT64 MODE=FDD + make odu MACHINE= MODE= c. Cleaning ODU binary - make clean_odu MACHINE=BIT64 MODE=FDD + make clean_odu MACHINE= MODE= -2. Building CU Stub binary: +3. Building CU Stub binary: a. Build folder cd l2/build/odu b. Building CU Stub binary - make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD + make cu_stub NODE= MACHINE= MODE= c. Cleaning CU Stub binary - make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD + make clean_cu NODE= MACHINE= MODE= -3. Building RIC Stub binary: +4. Building RIC Stub binary: a. Build folder cd l2/build/odu b. Building RIC Stub binary - make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD + make ric_stub NODE= MACHINE= MODE= c. Cleaning RIC Stub binary - make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD + make clean_ric NODE= MACHINE= MODE= -4. Cleaning ODU, CU Stub and RIC Stub: +5. Cleaning ODU, CU Stub and RIC Stub: make clean_all @@ -106,25 +144,25 @@ E. How to Clean and Build with O1 interface enabled (Requires pre-requisite step a. Build folder cd l2/build/odu b. Building ODU binary - make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + make odu MACHINE= MODE= O1_ENABLE= c. Cleaning ODU binary - make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + make clean_odu MACHINE= MODE= O1_ENABLE= 2. Building CU Stub binary: a. Build folder cd l2/build/odu b. Building CU Stub binary - make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + make cu_stub NODE= MACHINE= MODE= O1_ENABLE= c. Cleaning CU Stub binary - make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + make clean_cu NODE= MACHINE= MODE= O1_ENABLE= 3. Building RIC Stub binary: a. Build folder cd l2/build/odu b. Building RIC Stub binary - make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + make ric_stub NODE= MACHINE= MODE= O1_ENABLE= c. Cleaning RIC Stub binary - make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + make clean_ric NODE= MACHINE= MODE= O1_ENABLE= 4. Cleaning ODU, CU Stub and RIC Stub: make clean_all @@ -182,19 +220,24 @@ I. Compilation c. Build folder cd l2/build/odu d. Build ODU Binary: - make odu PHY=INTEL_L1 PHY_MODE=TIMER MACHINE=BIT64 MODE=FDD + make odu PHY= PHY_MODE= MACHINE= MODE= 2. Build CU Stub and RIC Stub: - a. Execute steps in sections D.2 and D.3. + a. Execute steps in sections D.3 and D.4 II. Execution - 1. Execute L1: + 1. Refer to below link for assumptions, dependencies, pre-requisites etc for ODU-Low execution + https://docs.o-ran-sc.org/projects/o-ran-sc-o-du-phy/en/latest/ + + 2. Execute L1: a. Setup environment: cd /phy/ source ./setupenv.sh b. Run L1 binary : cd /FlexRAN/l1/bin/nr5g/gnb/l1 - To run in timer mode : ./l1.sh -e + To run + i. In timer mode : ./l1.sh -e + ii. In radio mode : ./l1.sh -xran L1 is up when console prints follow: Non BBU threads in application @@ -205,7 +248,7 @@ II. Execution   PHY>welcome to application console - 2. Execute FAPI Translator: + 3. Execute FAPI Translator: a. Setup environment: cd /phy/ source ./setupenv.sh @@ -213,10 +256,10 @@ II. Execution cd /phy/fapi_5g/bin/ ./oran_5g_fapi --cfg=oran_5g_fapi.cfg - 3. Execute CU Stub and RIC Stub: + 4. Execute CU Stub and RIC Stub: a. Run steps in sections E.1-E.3 - 4. Execute DU: + 5. Execute DU: a. DU execution folder cd l2/bin/odu b. Export WLS library path @@ -235,7 +278,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