F-Release Document Update

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

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index 4a72ca6..aced1ed 100644 (file)
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -1,30 +1,28 @@
 .. 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**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2021-12-15         |  3.0.0             |  Radisys,          |  e-release         |
+| 2022-06-16         |  4.0.0             |  Radisys,          |  F release         |
+|                    |                    |  HCL Technologies  |                    |
+|                    |                    |  Ltd.              |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2022-01-14         |  3.0.0             |  Radisys,          |  e-release         |
 |                    |                    |  HCL Technologies  |                    |
 |                    |                    |  Ltd.              |                    |
 +--------------------+--------------------+--------------------+--------------------+
@@ -41,7 +39,7 @@ Version history
 
 
 Introduction
-============
+------------
 
 This document describes the hardware and software requirements along with guidelines on how to install O-DU High.
 
@@ -49,13 +47,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
 
@@ -80,12 +78,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:
 
@@ -108,7 +106,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>.
 
@@ -118,8 +116,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
@@ -159,50 +157,12 @@ Setting up Netconf server (Only if O1 interface enabled)
       | $cd <O-DU High Directory>/l2/build/scripts
       | $sudo ./load_yang.sh
 
-    - Install additional 3GPP YANG models.
-
-      | $cd <O-DU High Directory>/l2/build/yang
-
-      | Download following 3GPP REL17 YANG models
-      | https://forge.3gpp.org/rep/sa5/MnS/tree/Rel17-draft/yang-models
-
-      | _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 :
+    - To enable Standard Defined VES format:      
       
-      | 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
+      | cd l2/src/o1/ves
+            
+      | Enable the Macro "StdDef" in file VesUtils.h      
+      | #define StdDef
 
 - Start Netopeer2-server:
 
@@ -212,7 +172,7 @@ Setting up Netconf server (Only if O1 interface enabled)
 
 
 Compilation
-------------
+===========
 
 - Build O-DU High:
 
@@ -260,7 +220,7 @@ Compilation
 
 
 Compilation with O1 interface enabled
---------------------------------------
+=====================================
 
 - Build O-DU High: