JIRA ID:[ODUHIGH-282]:UL REASSEMBLE SDU

[o-du/l2.git] / docs / installation-guide.rst

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index d99fcd4..ab169b0 100644 (file)
--- 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    |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
@@ -79,8 +82,8 @@ Libraries
 Following libraries are required to compile and execute O-DU High:
 
 - GCC 
-   - Ubuntu : sudo apt install build-essential
-   - CentOS : sudo yum group install "Development Tools"
+   - Ubuntu : sudo apt-get install -y build-essential
+   - CentOS : sudo yum groups mark install -y “Development Tools”
 
    Ensure the version is 4.6.3 and above using
 
@@ -88,11 +91,24 @@ Following libraries are required to compile and execute O-DU High:
 
 - LKSCTP
    - Ubuntu : sudo apt-get install -y libsctp-dev
-   - CentOS : yum install lksctp-tools-devel
+   - CentOS : sudo yum install -y lksctp-tools-devel
 
 - PCAP:
    - Ubuntu : sudo apt-get install -y libpcap-dev
-   - CentOS : yum install libpcap-devel
+   - CentOS : sudo yum install -y libpcap-devel
+
+Following libraries are required to compile and execute O1 module:
+ 
+- Netconf:
+   libssh, libyang, libnetconf2, sysrepo, netopeer2
+
+   Script is provided in the following folder to install these libraries
+
+   - Ubuntu :  
+   
+       | cd <O-DU High Directory>/l2/build/o1
+       | sudo ./install_lib.sh
+
 
 Cloning code
 --------------
@@ -101,10 +117,7 @@ Cloning code
 
 - Clone code into <O-DU High Directory> 
 
-  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"
 
 Compilation
 ------------
@@ -118,10 +131,15 @@ Compilation
    - Clean O-DU High binary
 
        make clean_odu MACHINE=BIT64 MODE=FDD
+       
 
    - Build O-DU High binary
    
        make odu MACHINE=BIT64 MODE=FDD
+       
+       To build with O1 interface enabled:
+
+       make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
 
 - Build CU Stub :
 
@@ -151,6 +169,33 @@ Compilation
    
        make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
 
+- Build O-DU High with O1 interface enabled:
+
+   - Navigate to o1 Build folder
+   
+       cd <O-DU High Directory>/l2/build/o1
+
+   - Clean O1 binary
+   
+       make clean_o1 MACHINE=BIT64
+
+   - Build O1 binary
+   
+       make o1 MACHINE=BIT64
+
+   - Navigate to odu Build folder
+
+       cd <O-DU High Directory>/l2/build/odu
+
+   - Clean O-DU High binary
+
+       make clean_odu MACHINE=BIT64 MODE=FDD
+       
+   - Build O-DU High binary
+   
+       make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+
+
 
 The above generated images can be found at:
 
@@ -159,3 +204,5 @@ The above generated images can be found at:
 - CU Stub   - <O-DU High Directory>/l2/bin/cu_stub
 
 - RIC Stub  - <O-DU High Directory>/l2/bin/ric_stub
+
+- O1        - <O-DU High Directory>/l2/build/o1/bin/o1