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