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 | 2021-04-15         | 1.2.1              |  Alex Stancu       | "D" release        |
  25 |                    |                    |                    |                    |
  26 +--------------------+--------------------+--------------------+--------------------+
  27 | 2021-04-12         | 1.2.0              |  Alex Stancu       | "D" release        |
  28 |                    |                    |                    |                    |
  29 +--------------------+--------------------+--------------------+--------------------+
  30 | 2020-12-02         | 1.0.3              |  Alex Stancu       | Cherry release     |
  31 |                    |                    |                    |                    |
  32 +--------------------+--------------------+--------------------+--------------------+
  33 | 2020-11-11         | 1.0.0              |  Alex Stancu       | Cherry release     |
  34 |                    |                    |                    |                    |
  35 +--------------------+--------------------+--------------------+--------------------+
  36 | 2020-06-08         | 0.6.1              |  Alex Stancu       | Bronze release     |
  37 |                    |                    |                    |                    |
  38 +--------------------+--------------------+--------------------+--------------------+
  39 | 2019-11-13         | 0.0.1              |  Alex Stancu       | First draft - Amber|
  40 |                    |                    |                    |                    |
  41 +--------------------+--------------------+--------------------+--------------------+
  42
  43
  44 Summary
  45 -------
  46
  47 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.
  48
  49
  50 Release Data
  51 ------------
  52
  53 version 1.2.1
  54
  55 - [fix] VES commmon header made uniform across all VES-related messages
  56
  57
  58 version 1.2.0
  59
  60 - [change] **Default password of the NETCONF Server was changed to "netconf!", to be complant with O-RAN requirements**
  61
  62 - [feature-add] NACM (NETCONF Access Control Module) default configuration is now according to O-RAN WG4 requirements instead of disabled, like before
  63
  64 - [change] Do not expose sysrepo internal YANG models in the yang-schema-list
  65
  66 - [change] Provide both IPv4 and IPv6 addresses (if available) in pnfRegistration message
  67
  68 - [change] Change ietf-system default configuration and web-ui URL (now points to ConfigApp in SDN-R)
  69
  70 - [fix] Correctly construct URL for SDN Controller and VES Collector when they are addressed via IPv6
  71
  72
  73 version 1.0.3
  74
  75 - [fixed] fixed issues where ODL could not parse the correct versions for yang files
  76
  77
  78 version 1.0.2
  79
  80 - [fixed] bug that occured when trying to start a wrong instance (bad docker-repository or docker-tag)
  81 - [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
  82
  83
  84 version 1.0.1
  85
  86 - [feature-add] added web-cut-through feature
  87 - [fixed] mount-point-addressing-method was mistakenly changing after starting
  88
  89
  90 version 1.0.0
  91 Initial release.
  92
  93 Feature Additions
  94 ^^^^^^^^^^^^^^^^^
  95 * IPv6 for the simulated devices
  96 * NETCONF CallHome for the simulated devices
  97 * Manual notification generation
  98 * Custom naming of the simulated devices
  99
 100 Bug Corrections
 101 ^^^^^^^^^^^^^^^
 102 * `ssh-connections` and `tls-connections` leafs are now removed from the simulator-config
 103 * `fault-notification-delay-period` has now the attribute `ordered-by user`
 104
 105 Deliverables
 106 ^^^^^^^^^^^^
 107
 108 Software Deliverables
 109 +++++++++++++++++++++
 110
 111 The following docker containers are the resulting artefacts of the sim-o1-project:
 112
 113 * **o-ran-sc/ntsim-manager** - this image contains the NTS Manager, which handles the simulation environment;
 114
 115 * **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;
 116
 117 * **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.
 118
 119 * **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;
 120
 121 * **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;
 122
 123 Documentation Deliverables
 124 ++++++++++++++++++++++++++
 125
 126
 127 Known Limitations, Issues and Workarounds
 128 -----------------------------------------
 129 N/A
 130
 131 System Limitations
 132 ^^^^^^^^^^^^^^^^^^
 133 N/A
 134
 135 Known Issues
 136 ^^^^^^^^^^^^
 137 N/A
 138
 139 Workarounds
 140 ^^^^^^^^^^^
 141 N/A
 142
 143
 144 References
 145 ----------
 146 `NTS Project <https://github.com/Melacon/ntsim>`_
 147
 148
 149