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
| **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 | | |
.. <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
---------------------
.. <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 |
| | |
| | |
| | |
------------------------------------
.. <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
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-
-..please write your project overview
-..please delete this content after editing
-
-
-your_repo Overview
+SMO O1 Overview
======================
+This repository is for the implementation, installation, and use of the O1 interface of SMO. It uses the Software Defined Netowrk (SDN) Controller for Radio (SDNR) to implement the O1 interface. The software comes in the form of Docker containers that are setup using docker-compose.
=============
-This document provides the release notes for <RELEASE> of <COMPONENT>.
+This document provides the release notes for releases related to SMO O1.
.. contents::
:depth: 3
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX | 0.1.0 | | First draft |
+| 2021-12-15 | E | | E-release |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| | 0.1.1 | | |
+| 2021-06-15 | D | | Dawn release |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| | 1.0 | | |
+| 2020-12-15 | C | | Cherry release |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
Summary
-------
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+E-release:
+The E-release was targeted towards network slicing. The O1 interface did not need any updates to support the use case. Most of the support for the use case has to come in the Network Function (NF), and in the rApp that supports the use case. The only percievable change is the change in the logo to the GUI interface.
+The D(awn) release was targeted towards implementation of the O1 interface itself and getting an initial implementation in place.
Release Data
------------
-<STATE RELEVANT RELEASE DATA/RECORDS>
-
-<EXAMPLE>:
+--------------------------------------+--------------------------------------+
| **Project** | E.g. project |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
-| | |
+| **Repo/commit-ID** | Repo: smo/o1 |
+| | Commit id: |
+--------------------------------------+--------------------------------------+
-| **Release designation** | E.g. Arno RC2 |
+| **Release designation** | |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | E.g. 2015-04-16 |
+| **Release date** | 2021-12-15 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | |
+| **Purpose of the delivery** | Support network slicing |
| | |
+--------------------------------------+--------------------------------------+
Feature Additions
^^^^^^^^^^^^^^^^^
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-
-<EXAMPLE>:
**JIRA BACK-LOG:**
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| | |
+| SMO-11 | Change banner in O1 GUI interface |
| | |
| | |
+--------------------------------------+--------------------------------------+
User Guide
==========
-This is the user guide of OSC <COMPONENT>.
+This is the user guide of OSC SMO O1 Interface
.. contents::
:depth: 3
.. Descirbe how the target users can get use of a O-RAN SC component.
.. If the guide contains sections on third-party tools, is it clearly stated why the O-RAN-OSC platform is using those tools? Are there instructions on how to install and configure each tool/toolset?
+This project is intended for operators that want to configure the RAN Network Functions (NF), i.e., O-DU, O-CU, O-RU, and the Near RT-RIC over the O1 (NETCONF/RESTCONF) interface.
+
+Each of the NFs advertise their own capabilities over a NETCONF session that is established between the SMO and each of the NFs. Thereafter the NETCONF session is used to configure and manage each of the NFs.
+
+This user guide assumes that Installation Guide has been followed to install the necessary hardware and software.
+
Feature Introduction
--------------------
.. Provide enough information that a user will be able to operate the feature on a deployed scenario. content can be added from administration, management, using, Troubleshooting sections perspectives.
+The GUI interface for O1 interface 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.
+
Code Review / smo / o1.git / commitdiff