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 | 2022-12-15         | 1.5.2              | Alex Stancu        | "G" Release        |
  25 |                    |                    |                    |                    |
  26 +--------------------+--------------------+--------------------+--------------------+
  27 | 2022-06-27         | 1.5.0              | Alex Stancu        | "F" Release        |
  28 |                    |                    |                    |                    |
  29 +--------------------+--------------------+--------------------+--------------------+
  30 | 2021-12-09         | 1.4.3              |  Alex Stancu       | "E" release        |
  31 |                    |                    |                    |                    |
  32 +--------------------+--------------------+--------------------+--------------------+
  33 | 2021-04-27         | 1.2.3              |  Alex Stancu       | "D" release        |
  34 |                    |                    |                    |                    |
  35 +--------------------+--------------------+--------------------+--------------------+
  36 | 2021-04-15         | 1.2.1              |  Alex Stancu       | "D" release        |
  37 |                    |                    |                    |                    |
  38 +--------------------+--------------------+--------------------+--------------------+
  39 | 2021-04-12         | 1.2.0              |  Alex Stancu       | "D" release        |
  40 |                    |                    |                    |                    |
  41 +--------------------+--------------------+--------------------+--------------------+
  42 | 2020-12-02         | 1.0.3              |  Alex Stancu       | Cherry release     |
  43 |                    |                    |                    |                    |
  44 +--------------------+--------------------+--------------------+--------------------+
  45 | 2020-11-11         | 1.0.0              |  Alex Stancu       | Cherry release     |
  46 |                    |                    |                    |                    |
  47 +--------------------+--------------------+--------------------+--------------------+
  48 | 2020-06-08         | 0.6.1              |  Alex Stancu       | Bronze release     |
  49 |                    |                    |                    |                    |
  50 +--------------------+--------------------+--------------------+--------------------+
  51 | 2019-11-13         | 0.0.1              |  Alex Stancu       | First draft - Amber|
  52 |                    |                    |                    |                    |
  53 +--------------------+--------------------+--------------------+--------------------+
  54
  55
  56
  57 Summary
  58 -------
  59
  60 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.
  61
  62
  63 Release Data
  64 ------------
  65
  66 version 1.6.1
  67
  68 - [feature-add] new O-DU docker image containing 3GPP YANG models. This needs to be built locally!
  69
  70 version 1.5.2
  71
  72 - [feature-add] new VES O1 PNF Registration (stndDefined) message available. It can be enabled by using ves-o1-pnf-registration feature name.
  73
  74
  75 version 1.5.0
  76
  77 - [feature-add] new topology-service image available, with latest YANG specifications from OAM project. It exposes a RESTCONF endpoint with specific topology information as configured.
  78
  79
  80 version 1.4.3
  81
  82 - [feature-add] aligned o-ran-sc-du-hello-world YANG model
  83 - [feature-add] o-ran-du standalone mode with subscription-streams and performance-management-jobs streamlined
  84 - [feature-add] dynamic VES template generation with parameters and functions for o-ran-du
  85
  86 version 1.4.1
  87
  88 - [feature-add] network-function dynamic operational datastore: when running in network-function mode, after the initial datastore population, NTS subscribes to all populated modules changes (running datastore), and whenever changed are detected, the operational store is dynamically updated accordingly
  89
  90
  91 version 1.4.0
  92
  93 - [update] datastore population code revised and rearragned and simplified wherever possible with various fixes
  94
  95
  96 version 1.3.7
  97
  98 - [feature-add] add SDN Controller CallHome IP different than the SDN Controller RESTCONF port. This is defined as a new ENV variable: SDN_CONTROLLER_CALLHOME_IP
  99
 100
 101 version 1.3.6
 102
 103 - [feature-add] add support for hostname addressing instead of IP for SDN Controller and VES Collector. A hostname can be specified instead of the IP address. If the Port ENV variables (i.e. SDN_CONTROLLER_PORT and VES_ENDPOINT_PORT) are not set for the NF, the URL for addressing the SDN Controller and VES Collector will be constructed without it (e.g. http://sdn-controller-hostname/rests/data...). If the Port ENV variables are set, they will be used when constructing the URL (e.g. http://sdn-controller-hostname:8181/rests/data...).
 104
 105
 106 version 1.3.5
 107
 108 - [feature-add] add support for NETCONF CallHome via TLS. Please note that this works only with ODL Silicon and above, because of API changes in the ODL CallHome module. 4335 is the port for CallHome via TLS. If any other port is used, CallHome via SSH will be used.
 109
 110 version 1.2.3
 111
 112 - [change] moved all NETCONF x-paths to xpath.h for easier management and cleaner codebase
 113
 114 - [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
 115
 116 - [feature-add] log-rotation application; does not include supervisor redirected paths, not stderr; log is hard-coded at ~5000 lines per file
 117
 118 - [feature-add] host-mapping is now available when running NF is running in standalone mode via the **NTS_NF_MOUNT_POINT_ADDRESSING_METHOD** variable
 119
 120
 121 version 1.2.1
 122
 123 - [fix] VES commmon header made uniform across all VES-related messages
 124
 125
 126 version 1.2.0
 127
 128 - [change] **Default password of the NETCONF Server was changed to "netconf!", to be complant with O-RAN requirements**
 129
 130 - [feature-add] NACM (NETCONF Access Control Module) default configuration is now according to O-RAN WG4 requirements instead of disabled, like before
 131
 132 - [change] Do not expose sysrepo internal YANG models in the yang-schema-list
 133
 134 - [change] Provide both IPv4 and IPv6 addresses (if available) in pnfRegistration message
 135
 136 - [change] Change ietf-system default configuration and web-ui URL (now points to ConfigApp in SDN-R)
 137
 138 - [fix] Correctly construct URL for SDN Controller and VES Collector when they are addressed via IPv6
 139
 140
 141 version 1.0.3
 142
 143 - [fixed] fixed issues where ODL could not parse the correct versions for yang files
 144
 145
 146 version 1.0.2
 147
 148 - [fixed] bug that occured when trying to start a wrong instance (bad docker-repository or docker-tag)
 149 - [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
 150
 151
 152 version 1.0.1
 153
 154 - [feature-add] added web-cut-through feature
 155 - [fixed] mount-point-addressing-method was mistakenly changing after starting
 156
 157
 158 version 1.0.0
 159 Initial release.
 160
 161 Feature Additions
 162 ^^^^^^^^^^^^^^^^^
 163 * IPv6 for the simulated devices
 164 * NETCONF CallHome for the simulated devices
 165 * Manual notification generation
 166 * Custom naming of the simulated devices
 167
 168 Bug Corrections
 169 ^^^^^^^^^^^^^^^
 170 * `ssh-connections` and `tls-connections` leafs are now removed from the simulator-config
 171 * `fault-notification-delay-period` has now the attribute `ordered-by user`
 172
 173 Deliverables
 174 ^^^^^^^^^^^^
 175
 176 Software Deliverables
 177 +++++++++++++++++++++
 178
 179 The following docker containers are the resulting artefacts of the sim-o1-project:
 180
 181 * **o-ran-sc/ntsim-manager** - this image contains the NTS Manager, which handles the simulation environment;
 182
 183 * **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;
 184
 185 * **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.
 186
 187 * **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;
 188
 189 * **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;
 190
 191 Documentation Deliverables
 192 ++++++++++++++++++++++++++
 193
 194
 195 Known Limitations, Issues and Workarounds
 196 -----------------------------------------
 197 N/A
 198
 199 System Limitations
 200 ^^^^^^^^^^^^^^^^^^
 201 N/A
 202
 203 Known Issues
 204 ^^^^^^^^^^^^
 205 N/A
 206
 207 Workarounds
 208 ^^^^^^^^^^^
 209 N/A
 210
 211
 212 References
 213 ----------
 214 `NTS Project <https://github.com/Melacon/ntsim>`_
 215
 216
 217