Add release notes information.
[sim/o1-interface.git] / docs / release-notes.rst
index 25258b8..516a823 100644 (file)
@@ -1,13 +1,13 @@
 .. 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
 =============
 
 
-This document provides the release notes for Amber of sim/o1-interface.
+This document provides the release notes for the sim/o1-interface project.
 
 .. contents::
    :depth: 3
@@ -21,13 +21,10 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2019-11-13         | 0.1.0              |                    | First draft        |
+| 2020-06-08         | 0.6.1              |  Alex Stancu       | Bronze release     |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 0.1.1              |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    | 1.0                |                    |                    |
+| 2019-11-13         | 0.0.1              |  Alex Stancu       | First draft - Amber|
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 
@@ -40,68 +37,19 @@ The O1 interface simulator is a framework that provides simulated devices with a
 
 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**                           |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
+* IPv6 for the simulated devices
+* NETCONF CallHome for the simulated devices
+* Manual notification generation
+* Custom naming of the simulated devices
 
 Bug Corrections
 ^^^^^^^^^^^^^^^
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE**                   | **SLOGAN**                           |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
+* `ssh-connections` and `tls-connections` leafs are now removed from the simulator-config
+* `fault-notification-delay-period` has now the attribute `ordered-by user`
 
 Deliverables
 ^^^^^^^^^^^^
@@ -109,60 +57,41 @@ Deliverables
 Software Deliverables
 +++++++++++++++++++++
 
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+The following docker containers are the resulting artefacts of the sim-o1-project:
 
+* **o-ran-sc/ntsim-manager** - this image contains the NTS Manager, which handles the simulation environment;
 
+* **o-ran-sc/ntsim-o-ran-ru-fh** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O1 FH interface specifications;
 
-Documentation Deliverables
-++++++++++++++++++++++++++
+* **o-ran-sc/ntsim-o-ran-sc-o-ran-ru** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O-RAN-SC O-RU Management interface defined by the OAM project;
 
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+* **o-ran-sc/ntsim-x-ran** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the X-RAN Management interface.
 
 
+Documentation Deliverables
+++++++++++++++++++++++++++
 
 
 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>`_