From: Alex Stancu Date: Thu, 14 Nov 2019 15:54:13 +0000 (+0200) Subject: Documentation improvements. X-Git-Tag: 0.0.1~2 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?p=sim%2Fo1-interface.git;a=commitdiff_plain;h=b4dd14f8579e67e0d7b416a138d985c899647578 Documentation improvements. Signed-off-by: Alex Stancu Change-Id: Ief75157150c98da06b54584498e03a0d9718f17d --- diff --git a/.gitignore b/.gitignore index b271380..3b1b00a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ .cproject .project +.vscode/ # documentation .tox -docs/_build/ \ No newline at end of file +docs/_build/ diff --git a/docs/index.rst b/docs/index.rst index 22dd18a..44c214b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ .. 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 Welcome to O-RAN SC sim/o1-interface Documentation diff --git a/docs/overview.rst b/docs/overview.rst index 6592e58..b7203ba 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,23 +1,29 @@ .. 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 `_ + +* `libnetconf2 `_ + +* `libyang `_ + +* `sysrepo `_ - all of these are used for the implementation of the NETCONF Server, both in the NTS Manager and in each simulated device + +* `cJSON `_ - used to create the JSON payloads for talking with the simulation framework + +* `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 diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 25258b8..e59befe 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,6 +1,6 @@ .. 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 @@ -21,13 +21,7 @@ Version history | **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 | | | | | | +--------------------+--------------------+--------------------+--------------------+ @@ -40,68 +34,16 @@ The O1 interface simulator is a framework that provides simulated devices with a Release Data ------------ - - -: - -+--------------------------------------+--------------------------------------+ -| **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 ^^^^^^^^^^^^^^^^^ - - -: - -**JIRA BACK-LOG:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ +N/A Bug Corrections ^^^^^^^^^^^^^^^ -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ +N/A Deliverables ^^^^^^^^^^^^ @@ -109,60 +51,37 @@ Deliverables Software Deliverables +++++++++++++++++++++ - +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 ++++++++++++++++++++++++++ - - - - Known Limitations, Issues and Workarounds ----------------------------------------- +N/A System Limitations ^^^^^^^^^^^^^^^^^^ - - - +N/A Known Issues ^^^^^^^^^^^^ - - -: - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ +N/A Workarounds ^^^^^^^^^^^ - - - - +N/A References ---------- - - +`NTS Project `_