Release image for e-release maintenance(5.0.3)
[o-du/l2.git] / docs / installation-guide.rst
index 700180e..f7d6c60 100644 (file)
@@ -24,6 +24,14 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
+| 2022-01-14         |  3.0.0             |  Radisys,          |  e-release         |
+|                    |                    |  HCL Technologies  |                    |
+|                    |                    |  Ltd.              |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2021-07-07         |  2.0.0             |  Radisys,          |  D Release         |
+|                    |                    |  HCL Technologies  |                    |
+|                    |                    |  Ltd.              |                    |
++--------------------+--------------------+--------------------+--------------------+
 | 2020-12-04         |  1.0.1             |  HCL Technologies  |  Cherry Release    |
 |                    |                    |  Ltd.              |                    |
 +--------------------+--------------------+--------------------+--------------------+
@@ -109,60 +117,99 @@ Cloning code
   git clone "https://gerrit.o-ran-sc.org/r/o-du/l2"
 
 
-Setting up Netconf server
--------------------------
+Setting up Netconf server (Only if O1 interface enabled)
+--------------------------------------------------------
  
-  Following steps are required to compile ODU with O1 interface enabled:
+  Following steps are required to compile and run ODU with O1 interface enabled.
+
+- Create a new netconf user
+
+      Switch to root user or use sudo and run following commands
+
+   - Ubuntu :
+      | cd <O-DU High Directory>/l2/build/scripts
+      | sudo ./add_netconf_user.sh
 
 - Install Netconf libraries:
-   
+
    libssh, libyang, libnetconf2, sysrepo, netopeer2
 
    Script is provided in the following folder to install these libraries
 
-   - Ubuntu :  
-   
+   - Ubuntu :
        | cd <O-DU High Directory>/l2/build/scripts
-       | sudo ./install_lib.sh -c
+       | sudo ./install_lib_O1.sh -c
 
-- Start Netopeer2-server:
-       
-   - Ubuntu :  
-       | cd <O-DU High Directory>/l2/build/scripts
-       | sudo ./netopeer-server.sh start
+- Install the YANG modules and load initial configuration
 
-- Create a new netconf user
-      
-      Switch to root user and run following commands
+    - Navigate to config folder and update the desired initial configuration
+
+      | cd <O-DU High Directory>/l2/build/config
+
+      | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
+      | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
+      | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
+      | 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.
+
+      - Ubuntu :
       
-   - Ubuntu :  
-   
-      | adduser --system netconf && \\
-      |    echo "netconf:netconf!" | chpasswd
+      | $cd <O-DU High Directory>/l2/build/scripts
+      | $sudo ./load_yang.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 additional 3GPP YANG models.
 
-- Install the YANG modules
+      | $cd <O-DU High Directory>/l2/build/yang
 
-   - Ubuntu : 
-    
-      | cd <O-DU High Directory>/l2/build/yang
-      | sysrepoctl -i ./yang/o-ran-sc-odu-alarm-v1.yang
-      | sysrepoctl -i ./yang/o-ran-sc-odu-interface-v1.yang
+      | Download following 3GPP REL17 YANG models
+      | https://forge.3gpp.org/rep/sa5/MnS/tree/Rel17-draft/yang-models
 
-- Configure the startup IP and Port configurations for DU, CU and RIC
+      | _3gpp-common-top.yang
+      | _3gpp-5g-common-yang-types.yang
+      | _3gpp-common-yang-types.yang
+      | _3gpp-common-managed-element.yang
+      | _3gpp-common-measurements.yang
+      | _3gpp-common-subscription-control.yang
+      | _3gpp-common-fm.yang
+      | _3gpp-common-trace.yang
+      | _3gpp-common-managed-function.yang
+      | _3gpp-nr-nrm-gnbdufunction.yang
+      | _3gpp-nr-nrm-nrcelldu.yang
+      | _3gpp-nr-nrm-rrmpolicy.yang
+
+      | Note : There are some corrections required in _3gpp-common-trace.yang and _3gpp-common-trace.yang yang model. Please follow these steps.
+
+      - Ubuntu :
+      
+      | sed -i -e 's/"IMMEDIATE_MDT"/"IMMEDIATE_MDT_ONLY"/g' _3gpp-common-trace.yang
+      | sed -i -e 's/"TRACE"/"TRACE_ONLY"/g' _3gpp-common-trace.yang
+
+   - Install all the downloaded yang models.
+
+       - Ubuntu :
+
+       | cd <O-DU High Directory>/l2/build/yang
+       | sysrepoctl -i      _3gpp-common-yang-types.yang
+       | sysrepoctl -i      _3gpp-common-top.yang
+       | sysrepoctl -i      _3gpp-common-measurements.yang
+       | sysrepoctl -i      _3gpp-common-trace.yang
+       | sysrepoctl -i      _3gpp-common-managed-function.yang
+       | sysrepoctl -i      _3gpp-common-subscription-control.yang
+       | sysrepoctl -i      _3gpp-common-fm.yang
+       | sysrepoctl -i      _3gpp-common-managed-element.yang
+       | sysrepoctl -i      _3gpp-5g-common-yang-types.yang
+       | sysrepoctl -i      _3gpp-nr-nrm-rrmpolicy.yang
+       | sysrepoctl -i      _3gpp-nr-nrm-gnbdufunction.yang
+       | sysrepoctl -i      _3gpp-nr-nrm-nrcelldu.yang
+
+- Start Netopeer2-server:
+
+   - Ubuntu :
+       | cd <O-DU High Directory>/l2/build/scripts
+       | sudo ./netopeer-server.sh start
 
-   - Ubuntu : 
-    
-      | cd <O-DU High Directory>/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 
 
 Compilation
 ------------