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