X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=26c9133f1d9b29529e4f66fd3f04b93d0c922cbd;hb=824033853e6b3b52f9019283e85f21006596b0fb;hp=f78a5eec2401e25c71d77f9f8342794449e73796;hpb=e6b4d27d99570c34271d3176c6969bc5bc46a039;p=nonrtric.git

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index f78a5eec..26c9133f 100644
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -1,7 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-
-
+.. Copyright (C) 2020 Nordix
 
 Installation Guide
 ==================
@@ -13,97 +12,60 @@ Installation Guide
 Abstract
 --------
 
-This document describes how to install the Non-RT RIC dashboard, its dependencies and required system resources.
+This document describes how to install the Non-RT RIC SDNC A1 Controller, its dependencies and required system resources.
 
+This work is in progress. Please visit the `api-docs page`_ for more information about the SDNC A1 Controller and the Policy Agent.
 
-Version history
+.. _api-docs page: ./api-docs.html
 
-+--------------------+--------------------+--------------------+--------------------+
-| **Date**           | **Ver.**           | **Author**         | **Comment**        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX         | 0.1.0              | 		       | First draft        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    | 0.1.1              |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    | 1.0                |                    |                    |
-|                    |                    |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-
-
-Introduction
+Installation
 ------------
 
-.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
-
-.<EXAMPLE>:
-
-This document describes the supported software and hardware configurations for the reference component as well as providing guidelines on how to install and configure such reference system.
+Download the SDNC repo:
 
-The audience of this document is assumed to have good knowledge in RAN network and Linux system.
+   git clone "https://gerrit.o-ran-sc.org/r/nonrtric"
 
+The SDNC A1 Controller could be found in this repo.
 
-Preface
--------
-.. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
+Build SDNC project:
 
-<EXAMPLE>:
+   Enter into the sdnc-a1-controller project, northbound and oam project will located there.
 
-Before starting the installation of <project name>, some planning must precede.
+      cd sdnc-a1-controller
 
-.. note:any preperation you need before setting up sotfware and hardware
+   Build northbound project with command:
 
+      mvn clean install -Dmaven.test.skip=true
 
-Hardware Requirements
----------------------
-.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
+   Build oam project with command:
 
-<EXAMPLE>:
+      mvn clean install -Dmaven.test.skip=true -P docker
 
-Following minimum hardware requirements must be met for installation of <project name>:
+   Enter into this directory:
 
-+--------------------+----------------------------------------------------+
-| **HW Aspect**      | **Requirement**                                    |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **# of servers**   | 		                                          |
-+--------------------+----------------------------------------------------+
-| **CPU**            | 						          |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **RAM**            | 							  |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **Disk**           | 					                  |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **NICs**           | 							  |
-|                    |                                                    |
-|                    | 							  |
-|                    |                                                    |
-|                    |  					 	  |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
+      cd nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml
 
+   and run the command:
 
+      MTU=1500 docker-compose up a1-controller
 
-Software Installation and Deployment
-------------------------------------
-.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
-
-<EXAMPLE>:
-
-This section describes the installation of the <project name> installation on the reference hardware.
-
-
-
-References
-----------
-.. <PROVIDE NEEDED/USEFUL REFERENCES>
+Version history
+---------------
 
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2019-11-12         | 0.1.0              | Maxime Bonneau     | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-03-24         | 0.1.1              | Maxime Bonneau     | Second draft       |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 1.0                |                    |                    |
+|                    |                    |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+