docs/installation-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4
   5
   6 Installation Guide
   7 ==================
   8
   9 .. contents::
  10    :depth: 3
  11    :local:
  12
  13 Abstract
  14 --------
  15
  16 This document describes how to install the software for SMO O1, it's dependencies and required system resources.
  17
  18
  19 Version history
  20
  21 +--------------------+--------------------+--------------------+--------------------+
  22 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  23 |                    |                    |                    |                    |
  24 +--------------------+--------------------+--------------------+--------------------+
  25 | 2021-12-13         | 0.0.1              |                    | Initial Version    |
  26 |                    |                    |                    |                    |
  27 +--------------------+--------------------+--------------------+--------------------+
  28 |                    | 0.0.2              |                    |                    |
  29 |                    |                    |                    |                    |
  30 +--------------------+--------------------+--------------------+--------------------+
  31 |                    | 1.0                |                    |                    |
  32 |                    |                    |                    |                    |
  33 |                    |                    |                    |                    |
  34 +--------------------+--------------------+--------------------+--------------------+
  35
  36
  37 Introduction
  38 ------------
  39
  40 .. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
  41
  42 O1:
  43
  44 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.
  45
  46 The audience of this document is assumed to have good knowledge in RAN network, Docker and Linux system.
  47
  48
  49 Preface
  50 -------
  51 .. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
  52
  53 Prerequisites:
  54
  55 Before starting the installation of O1, make sure the following hardware and software requirements are met.
  56
  57 .. note:any preperation you need before setting up sotfware and hardware
  58
  59
  60 Hardware Requirements
  61 ---------------------
  62 .. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
  63
  64 System:
  65
  66 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:
  67
  68 +--------------------+----------------------------------------------------+
  69 | **HW Aspect**      | **Requirement**                                    |
  70 |                    |                                                    |
  71 +--------------------+----------------------------------------------------+
  72 | **# of servers**   |  1                                                 |
  73 +--------------------+----------------------------------------------------+
  74 | **CPU**            |  4                                                 |
  75 |                    |                                                    |
  76 +--------------------+----------------------------------------------------+
  77 | **RAM**            |  16G                                               |
  78 |                    |                                                    |
  79 +--------------------+----------------------------------------------------+
  80 | **Disk**           |  100G                                              |
  81 |                    |                                                    |
  82 +--------------------+----------------------------------------------------+
  83 | **NICs**           |  1                                                 |
  84 |                    |                                                    |
  85 |                    |                                                    |
  86 |                    |                                                    |
  87 |                    |                                                    |
  88 |                    |                                                    |
  89 +--------------------+----------------------------------------------------+
  90
  91
  92
  93 Software Installation and Deployment
  94 ------------------------------------
  95 .. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
  96
  97 Docker and docker-compose:
  98
  99 This section describes the installation of the software to enable the SMO O1 interface on the referenced hardware.
 100
 101 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.
 102
 103 To deploy the solution, type the following on the command line::
 104
 105     $ docker-compose up -d
 106
 107 Once the deployment is successful, verify the deployment using the following command::
 108
 109     $ docker-compose ps
 110
 111 Expect an output that is similar to this::
 112
 113     Name               Command               State                                         Ports
 114     ------------------------------------------------------------------------------------------------------------------------------------
 115     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
 116     sdnrdb   /tini -- /usr/local/bin/do ...   Up      9200/tcp, 9300/tcp
 117
 118 Thereafter, the GUI interface for O1 can be accessed at::
 119
 120     http://<host_ip>:8181/odlux/index.html
 121
 122 The username/password is:
 123
 124 admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
 125
 126 and can be updated by updating the .env file in the repository.
 127
 128
 129 References
 130 ----------
 131 .. <PROVIDE NEEDED/USEFUL REFERENCES>
 132
 133
 134
 135