docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2019 highstreet technologies GmbH and others
   4
   5
   6 Release Notes
   7 =============
   8
   9
  10 This document provides the release notes for the sim/o1-interface project.
  11
  12 .. contents::
  13    :depth: 3
  14    :local:
  15
  16
  17 Version history
  18 ---------------
  19
  20 +--------------------+--------------------+--------------------+--------------------+
  21 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  22 |                    |                    |                    |                    |
  23 +--------------------+--------------------+--------------------+--------------------+
  24 | 2020-12-02         | 1.0.3              |  Alex Stancu       | Cherry release     |
  25 |                    |                    |                    |                    |
  26 +--------------------+--------------------+--------------------+--------------------+
  27 | 2020-11-11         | 1.0.0              |  Alex Stancu       | Cherry release     |
  28 |                    |                    |                    |                    |
  29 +--------------------+--------------------+--------------------+--------------------+
  30 | 2020-06-08         | 0.6.1              |  Alex Stancu       | Bronze release     |
  31 |                    |                    |                    |                    |
  32 +--------------------+--------------------+--------------------+--------------------+
  33 | 2019-11-13         | 0.0.1              |  Alex Stancu       | First draft - Amber|
  34 |                    |                    |                    |                    |
  35 +--------------------+--------------------+--------------------+--------------------+
  36
  37
  38 Summary
  39 -------
  40
  41 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.
  42
  43
  44 Release Data
  45 ------------
  46 version 1.0.3
  47
  48 [fixed] fixed issues where ODL could not parse the correct versions for yang files
  49
  50
  51 version 1.0.2
  52
  53 [fixed] bug that occured when trying to start a wrong instance (bad docker-repository or docker-tag)
  54 [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
  55
  56
  57 version 1.0.1
  58
  59 [feature-add] added web-cut-through feature
  60 [fixed] mount-point-addressing-method was mistakenly changing after starting
  61
  62
  63 version 1.0.0
  64 Initial release.
  65
  66 Feature Additions
  67 ^^^^^^^^^^^^^^^^^
  68 * IPv6 for the simulated devices
  69 * NETCONF CallHome for the simulated devices
  70 * Manual notification generation
  71 * Custom naming of the simulated devices
  72
  73 Bug Corrections
  74 ^^^^^^^^^^^^^^^
  75 * `ssh-connections` and `tls-connections` leafs are now removed from the simulator-config
  76 * `fault-notification-delay-period` has now the attribute `ordered-by user`
  77
  78 Deliverables
  79 ^^^^^^^^^^^^
  80
  81 Software Deliverables
  82 +++++++++++++++++++++
  83
  84 The following docker containers are the resulting artefacts of the sim-o1-project:
  85
  86 * **o-ran-sc/ntsim-manager** - this image contains the NTS Manager, which handles the simulation environment;
  87
  88 * **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;
  89
  90 * **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.
  91
  92
  93 Documentation Deliverables
  94 ++++++++++++++++++++++++++
  95
  96
  97 Known Limitations, Issues and Workarounds
  98 -----------------------------------------
  99 N/A
 100
 101 System Limitations
 102 ^^^^^^^^^^^^^^^^^^
 103 N/A
 104
 105 Known Issues
 106 ^^^^^^^^^^^^
 107 N/A
 108
 109 Workarounds
 110 ^^^^^^^^^^^
 111 N/A
 112
 113
 114 References
 115 ----------
 116 `NTS Project <https://github.com/Melacon/ntsim>`_
 117
 118
 119