SMO-36: Update documentation for smo/o1 using the files in docs folder

[smo/o1.git] / docs / installation-guide.rst

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index 2412acf..ee2d29e 100644 (file)
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -13,7 +13,7 @@ Installation Guide
 Abstract
 --------
 
-This document describes how to install <Component>, it's dependencies and required system resources.
+This document describes how to install the software for SMO O1, it's dependencies and required system resources.
 
 
 Version history
@@ -22,10 +22,10 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX         | 0.1.0              |                   | First draft        |
+| 2021-12-13         | 0.0.1              |                   | Initial Version    |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 0.1.1              |                    |                    |
+|                    | 0.0.2              |                    |                    |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 |                    | 1.0                |                    |                    |
@@ -39,20 +39,20 @@ Introduction
 
 .. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
 
-.<EXAMPLE>:
+O1:
 
 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.
 
-The audience of this document is assumed to have good knowledge in RAN network nd Linux system.
+The audience of this document is assumed to have good knowledge in RAN network, Docker and Linux system.
 
 
 Preface
 -------
 .. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
 
-<EXAMPLE>:
+Prerequisites:
 
-Before starting the installation of <project name>, some planning must preceed.
+Before starting the installation of O1, make sure the following hardware and software requirements are met.
 
 .. note:any preperation you need before setting up sotfware and hardware 
 
@@ -61,26 +61,26 @@ Hardware Requirements
 ---------------------
 .. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
 
-<EXAMPLE>:
+System:
 
-Following minimum hardware requirements must be met for installation of <project name>:
+Following minimum hardware requirements must be met for installation of SMO O1. While the system can be installed on a smaller system, it will be slow, and difficult to use:
 
 +--------------------+----------------------------------------------------+
 | **HW Aspect**      | **Requirement**                                    |
 |                    |                                                    |
 +--------------------+----------------------------------------------------+
-| **# of servers**   |                                                           |
+| **# of servers**   |         1                                                 |
 +--------------------+----------------------------------------------------+
-| **CPU**            |                                                           |
+| **CPU**            |         4                                                 |
 |                    |                                                    |
 +--------------------+----------------------------------------------------+
-| **RAM**            |                                                           |
+| **RAM**            |         16G                                               |
 |                    |                                                    |
 +--------------------+----------------------------------------------------+
-| **Disk**           |                                                           |
+| **Disk**           |         100G                                              |
 |                    |                                                    |
 +--------------------+----------------------------------------------------+
-| **NICs**           |                                                           |
+| **NICs**           |         1                                                 |
 |                    |                                                    |
 |                    |                                                           |
 |                    |                                                    |
@@ -94,10 +94,36 @@ Software Installation and Deployment
 ------------------------------------
 .. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
 
-<EXAMPLE>:
+Docker and docker-compose:
 
-This section describes the installation of the <project name> installation on the reference hardware.
+This section describes the installation of the software to enable the SMO O1 interface on the referenced hardware.
 
+The software installation has been tested on a Ubuntu 20.04 based system. Assuming such an installation, make sure that Docker and docker-compose are installed on the system.
+
+To deploy the solution, type the following on the command line::
+
+    $ docker-compose up -d
+
+Once the deployment is successful, verify the deployment using the following command::
+
+    $ docker-compose ps
+
+Expect an output that is similar to this::
+
+    Name               Command               State                                         Ports
+    ------------------------------------------------------------------------------------------------------------------------------------
+    sdnr     /bin/sh -c /opt/onap/sdnc/ ...   Up      0.0.0.0:8101->8101/tcp,:::8101->8101/tcp, 0.0.0.0:8181->8181/tcp,:::8181->8181/tcp
+    sdnrdb   /tini -- /usr/local/bin/do ...   Up      9200/tcp, 9300/tcp
+
+Thereafter, the GUI interface for O1 can be accessed at::
+
+    http://<host_ip>:8181/odlux/index.html
+
+The username/password is:
+
+admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
+
+and can be updated by updating the .env file in the repository.
 
 
 References