[Issue-ID: ODUHIGH-485] G-release document version update

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

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index 2c5b1ba..0d87235 100644 (file)
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -1,29 +1,27 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-.. contents::
-   :depth: 3
-   :local:
-
 O-DU High Installation Guide
 *****************************
 
-Abstract
-========
-
 This document describes how to install O-DU High, it's dependencies and required system resources.
 
 .. contents::
    :depth: 3
    :local:
 
-Version history
 
+Version history
+---------------
 
 +--------------------+--------------------+--------------------+--------------------+
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
+| 2022-12-15         |  5.0.1             |  Radisys,          |  G release         |
+|                    |                    |  HCL Technologies  |                    |
+|                    |                    |  Ltd.              |                    |
++--------------------+--------------------+--------------------+--------------------+
 | 2022-06-16         |  4.0.0             |  Radisys,          |  F release         |
 |                    |                    |  HCL Technologies  |                    |
 |                    |                    |  Ltd.              |                    |
@@ -45,7 +43,7 @@ Version history
 
 
 Introduction
-============
+------------
 
 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
 
@@ -53,13 +51,13 @@ The audience of this document is assumed to have good knowledge in RAN concepts
 
 
 Preface
-=======
+-------
 
 O-DU High images can be built using the source code or corresponding docker images can be downloaded.
 
 
 Hardware requirements
-=====================
+---------------------
 
 Following minimum hardware requirements must be met for installation of O-DU High
 
@@ -84,12 +82,12 @@ Following minimum hardware requirements must be met for installation of O-DU Hig
 
 
 Software installation and deployment
-==========================================
+-------------------------------------
 
 This section describes the installation of the O-DU High on the reference hardware.
 
 Libraries
-----------
+=========
 
 Following libraries are required to compile and execute O-DU High:
 
@@ -112,7 +110,7 @@ Following libraries are required to compile and execute O-DU High:
 
 
 Cloning code
---------------
+============
 
 - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as <O-DU High Directory>.
 
@@ -122,8 +120,8 @@ Cloning code
 
 
 Setting up Netconf server (Only if O1 interface enabled)
---------------------------------------------------------
- 
+========================================================
+
   Following steps are required to compile and run ODU with O1 interface enabled.
 
 - Create a new netconf user
@@ -156,29 +154,29 @@ Setting up Netconf server (Only if O1 interface enabled)
       | 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.
+
+- Install the yang modules and load initial configuration.
 
       - Ubuntu :
       
       | $cd <O-DU High Directory>/l2/build/scripts
       | $sudo ./load_yang.sh
 
-    - To enable Standard Defined VES format:      
-      
-      | cd l2/src/o1/ves
-            
-      | Enable the Macro "StdDef" in file VesUtils.h      
-      | #define StdDef
-
 - Start Netopeer2-server:
 
    - Ubuntu :
        | cd <O-DU High Directory>/l2/build/scripts
        | sudo ./netopeer-server.sh start
 
+- In case standard defined VES format is to be enabled (this step is optional): 
+      
+      | cd l2/src/o1/ves
+            
+      | Enable the Macro "StdDef" in file VesUtils.h      
+      | #define StdDef
 
 Compilation
-------------
+===========
 
 - Build O-DU High:
 
@@ -226,7 +224,7 @@ Compilation
 
 
 Compilation with O1 interface enabled
---------------------------------------
+=====================================
 
 - Build O-DU High: