.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2019 highstreet technologies GmbH
+.. Copyright (C) 2019 highstreet technologies GmbH and others
sim/o1-interface Overview
==========================
-The o1-interface simulator is based on the Network Topology Simulator (NTS). NTS is a framework that allows simulating devices that expose a management interface through a NETCONF/YANG interface. The NTS is loaded with the YANG files associated with the O-RAN O1 interface specifications.
+The O1-interface simulator is based on the Network Topology Simulator (NTS). NTS is a framework that allows simulating devices that expose a management interface through a NETCONF/YANG interface. The NTS is loaded with the YANG files associated with the O-RAN O1 interface specifications.
The NETCONF/YANG management interface is simulated, and the O1 YANG models are loaded by the framework to be exposed. Random data is generated based on the specific models, such that each simulated device presents different data on its management interface.
The NTS Manager can be used to specify the simulation details and to manage the simulation environment at runtime.
The NTS framework is based on several open-source projects:
-* [Netopeer2](https://github.com/CESNET/Netopeer2)
-* [libnetconf2](https://github.com/CESNET/libnetconf2)
-* [libyang](https://github.com/CESNET/libyang)
-* [sysrepo](https://github.com/sysrepo/sysrepo) - all of these are used for the implementation of the NETCONF Server, both in the NTS Manager and in each simulated device
-* [cJSON](https://github.com/DaveGamble/cJSON) - used to create the JSON payloads for talking with the simulation framework
-* [pyang](https://github.com/mbj4668/pyang) - used to create random data from the YANG models that are exposed
+
+* `Netopeer2 <https://github.com/CESNET/Netopeer2>`_
+
+* `libnetconf2 <https://github.com/CESNET/libnetconf2>`_
+
+* `libyang <https://github.com/CESNET/libyang>`_
+
+* `sysrepo <https://github.com/sysrepo/sysrepo>`_ - all of these are used for the implementation of the NETCONF Server, both in the NTS Manager and in each simulated device
+
+* `cJSON <https://github.com/DaveGamble/cJSON>`_ - used to create the JSON payloads for talking with the simulation framework
+
+* `pyang <https://github.com/mbj4668/pyang>`_ - used to create random data from the YANG models that are exposed
Each simulated device is represented as a docker container, where the NETCONF Server is running. The creation and deletion of docker containers associated with simulated devices is handled by the NTS Manager. The NTS Manager is also running as a docker container and exposes a NETCONF/YANG interface to control the simulation.
\ No newline at end of file
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2019 highstreet technologies GmbH
+.. Copyright (C) 2019 highstreet technologies GmbH and others
Release Notes
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| 2019-11-13 | 0.1.0 | | First draft |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| | 0.1.1 | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| | 1.0 | | |
+| 2019-11-13 | 0.0.1 | Alex Stancu | First draft |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
Release Data
------------
-<STATE RELEVANT RELEASE DATA/RECORDS>
-
-<EXAMPLE>:
-
-+--------------------------------------+--------------------------------------+
-| **Project** | E.g. project |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release designation** | E.g. Arno RC2 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release date** | E.g. 2015-04-16 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | |
-| | |
-+--------------------------------------+--------------------------------------+
-
-
-
+N/A
Feature Additions
^^^^^^^^^^^^^^^^^
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-
-<EXAMPLE>:
-
-**JIRA BACK-LOG:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
+N/A
Bug Corrections
^^^^^^^^^^^^^^^
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
+N/A
Deliverables
^^^^^^^^^^^^
Software Deliverables
+++++++++++++++++++++
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+Two docker containers are the resulting artefacts of the sim-o1-project:
+
+* **sim-o1-interface-manager** - this image contains the NTS Manager, which handles the simulation environment;
+* **sim-o1-interface-device** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O1 interface specifications.
Documentation Deliverables
++++++++++++++++++++++++++
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-
-
Known Limitations, Issues and Workarounds
-----------------------------------------
+N/A
System Limitations
^^^^^^^^^^^^^^^^^^
-<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
-
-
+N/A
Known Issues
^^^^^^^^^^^^
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
-
-<EXAMPLE>:
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
+N/A
Workarounds
^^^^^^^^^^^
-
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
-
-
+N/A
References
----------
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
-
+`NTS Project <https://github.com/Melacon/ntsim>`_
Code Review / sim / o1-interface.git / commitdiff