X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=e8c005b0aff9a0cff543b820d18c5929f8aa9e58;hb=8748e788a43465b180c15d31908c276504dad6d4;hp=f2e86be5b853c9c992cc9dc5306b591d2460b250;hpb=fca06a47bd21dc6679d29af3534877f9c1d70805;p=o-du%2Fl2.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index f2e86be5b..e8c005b0a 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -24,6 +24,9 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ +| 2020-12-04 | 1.0.1 | HCL Technologies | Cherry Release | +| | | Ltd. | | ++--------------------+--------------------+--------------------+--------------------+ | 2020-12-04 | 1.0 | Radisys | Cherry Release | | | | | | +--------------------+--------------------+--------------------+--------------------+ @@ -94,6 +97,8 @@ Following libraries are required to compile and execute O-DU High: - Ubuntu : sudo apt-get install -y libpcap-dev - CentOS : sudo yum install -y libpcap-devel + + Cloning code -------------- @@ -101,9 +106,90 @@ Cloning code - Clone code into - git clone "https://gerrit.o-ran-sc.org/r/o-du/l2" && (cd "l2" && mkdir -p .git/hooks && curl -Lo `git rev-parse - --git-dir`/hooks/commit-msg https://gerrit.o-ran-sc.org/r/tools/hooks/commit-msg; chmod +x `git rev-parse - --git-dir`/hooks/commit-msg) + git clone "https://gerrit.o-ran-sc.org/r/o-du/l2" + + +Setting up Netconf server +------------------------- + + Following steps are required to compile ODU with O1 interface enabled: + +- Install Netconf libraries: + + libssh, libyang, libnetconf2, sysrepo, netopeer2 + + Script is provided in the following folder to install these libraries + + - Ubuntu : + + | cd /l2/build/scripts + | sudo ./install_lib_O1.sh -c + +- Start Netopeer2-server: + + - Ubuntu : + | cd /l2/build/scripts + | sudo ./netopeer-server.sh start + +- Create a new netconf user + + Switch to root user and run following commands + + - Ubuntu : + + | 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 + +- Install the YANG modules + + - Ubuntu : + + | cd /l2/build/yang + | sysrepoctl -i ./yang/o-ran-sc-odu-alarm-v1.yang + | sysrepoctl -i ./yang/o-ran-sc-odu-interface-v1.yang + | sysrepoctl -i ./yang/o-ran-sc-du-hello-world.yang + +- Configure the startup IP and Port configurations for DU, CU and RIC + + - Ubuntu : + + | 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 + | + | sysrepocfg --import=startup_config.xml --datastore running --module o-ran-sc-odu-interface-v1 + +- Configure the netconf server details for VES PNF Event + + - Ubuntu : + + | cd /l2/build/config + | + | Open the netconfConfig.json and edit the desired MAC address, IP, Port, Username and Password for VES PNF Registration. + +- Configure the VES server details to send VES Events + + - Ubuntu : + + | cd /l2/build/config + | + | Open the vesConfig.json and edit the desired IP, Port, Username and Password to send VES Event. + +- Configure the nacm module to provide access to new user + + - Ubuntu : + + | 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 Compilation @@ -118,10 +204,12 @@ Compilation - Clean O-DU High binary make clean_odu MACHINE=BIT64 MODE=FDD + - - Build O-DU High binary + - Compile O-DU High binary make odu MACHINE=BIT64 MODE=FDD + - Build CU Stub : @@ -133,7 +221,7 @@ Compilation make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD - - Build CU Stub binary + - Compile CU Stub binary make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD @@ -147,11 +235,60 @@ Compilation make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD - - Build RIC Stub binary + - Compile RIC Stub binary make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD +Compilation with O1 interface enabled +-------------------------------------- + +- Build O-DU High: + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean O-DU High binary + + make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + + - Compile O-DU High binary + + make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + +- Build CU Stub : + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean CU Stub binary + + make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + - Compile CU Stub binary + + make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + +- Build RIC Stub : + + - Navigate to Build folder + + cd /l2/build/odu + + - Clean RIC Stub binary + + make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + - Compile RIC Stub binary + + make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES + + + The above generated images can be found at: - O-DU High - /l2/bin/odu @@ -159,3 +296,4 @@ The above generated images can be found at: - CU Stub - /l2/bin/cu_stub - RIC Stub - /l2/bin/ric_stub +