Add NF addressing method as ENV.
[sim/o1-interface.git] / docs / release-notes.rst
index e59befe..0be9080 100644 (file)
@@ -7,7 +7,7 @@ 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,7 +21,25 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2019-11-13         | 0.0.1              |  Alex Stancu       | First draft        |
+| 2021-04-27         | 1.2.3              |  Alex Stancu       | "D" release        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2021-04-15         | 1.2.1              |  Alex Stancu       | "D" release        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2021-04-12         | 1.2.0              |  Alex Stancu       | "D" release        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-12-02         | 1.0.3              |  Alex Stancu       | Cherry release     |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-11-11         | 1.0.0              |  Alex Stancu       | Cherry release     |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-06-08         | 0.6.1              |  Alex Stancu       | Bronze release     |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2019-11-13         | 0.0.1              |  Alex Stancu       | First draft - Amber|
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 
@@ -29,21 +47,74 @@ Version history
 Summary
 -------
 
-The O1 interface simulator is a framework that provides simulated devices with a management plane exposed through a NETCONF/YANG interface, using the O-RAN O1 interface YANG modules.
+The O1 interface simulator is a framework that provides simulated network functions (NF) with a management plane exposed through a NETCONF/YANG interface, using YANG models defined in O-RAN.
 
 
 Release Data
 ------------
-N/A
+
+version 1.2.3
+
+- [change] moved all NETCONF x-paths to xpath.h for easier management and cleaner codebase
+  
+- [feature-add] Manager now automatically tries to pull missing images (last version) when not found, if **DOCKER_REPOSITORY** env var is set to a certain Docker repository; note that repository authentication currently not supported
+  
+- [feature-add] log-rotation application; does not include supervisor redirected paths, not stderr; log is hard-coded at ~5000 lines per file
+  
+- [feature-add] host-mapping is now available when running NF is running in standalone mode via the **NTS_NF_MOUNT_POINT_ADDRESSING_METHOD** variable
+  
+
+version 1.2.1
+
+- [fix] VES commmon header made uniform across all VES-related messages
+
+
+version 1.2.0
+
+- [change] **Default password of the NETCONF Server was changed to "netconf!", to be complant with O-RAN requirements**
+
+- [feature-add] NACM (NETCONF Access Control Module) default configuration is now according to O-RAN WG4 requirements instead of disabled, like before
+
+- [change] Do not expose sysrepo internal YANG models in the yang-schema-list
+
+- [change] Provide both IPv4 and IPv6 addresses (if available) in pnfRegistration message
+
+- [change] Change ietf-system default configuration and web-ui URL (now points to ConfigApp in SDN-R)
+
+- [fix] Correctly construct URL for SDN Controller and VES Collector when they are addressed via IPv6
+
+
+version 1.0.3
+
+- [fixed] fixed issues where ODL could not parse the correct versions for yang files
+
+
+version 1.0.2
+
+- [fixed] bug that occured when trying to start a wrong instance (bad docker-repository or docker-tag)
+- [fixed] when populating the fault-delay-list, if the sum of all the faults was 0, the network funciton kept on generating faults and crashed
+
+
+version 1.0.1
+
+- [feature-add] added web-cut-through feature
+- [fixed] mount-point-addressing-method was mistakenly changing after starting
+
+
+version 1.0.0
+Initial release.
 
 Feature Additions
 ^^^^^^^^^^^^^^^^^
-N/A
+* IPv6 for the simulated devices
+* NETCONF CallHome for the simulated devices
+* Manual notification generation
+* Custom naming of the simulated devices
 
 Bug Corrections
 ^^^^^^^^^^^^^^^
-
-N/A
+* `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
 ^^^^^^^^^^^^
@@ -51,12 +122,17 @@ Deliverables
 Software Deliverables
 +++++++++++++++++++++
 
-Two docker containers are the resulting artefacts of the sim-o1-project:
+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-fh** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O1 FH interface specifications;
 
-* **sim-o1-interface-manager** - this image contains the NTS Manager, which handles the simulation environment;
+* **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.
 
-* **sim-o1-interface-device** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O1 interface specifications.
+* **o-ran-sc/ntsim-o-ran-ru-fh** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O-RU FH YANG models, as per the November 2020 train;
 
+* **o-ran-sc/ntsim-o-ran-du** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O-DU YANG models;
 
 Documentation Deliverables
 ++++++++++++++++++++++++++