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.5.2
  67
  68 - [feature-add] new VES O1 PNF Registration (stndDefined) message available. It can be enabled by using ves-o1-pnf-registration feature name.
  69
  70
  71 version 1.5.0
  72
  73 - [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.
  74
  75
  76 version 1.4.3
  77
  78 - [feature-add] aligned o-ran-sc-du-hello-world YANG model
  79 - [feature-add] o-ran-du standalone mode with subscription-streams and performance-management-jobs streamlined
  80 - [feature-add] dynamic VES template generation with parameters and functions for o-ran-du
  81
  82 version 1.4.1
  83
  84 - [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
  85
  86
  87 version 1.4.0
  88
  89 - [update] datastore population code revised and rearragned and simplified wherever possible with various fixes
  90
  91
  92 version 1.3.7
  93
  94 - [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
  95
  96
  97 version 1.3.6
  98
  99 - [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...).
 100
 101
 102 version 1.3.5
 103
 104 - [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.
 105
 106 version 1.2.3
 107
 108 - [change] moved all NETCONF x-paths to xpath.h for easier management and cleaner codebase
 109
 110 - [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
 111
 112 - [feature-add] log-rotation application; does not include supervisor redirected paths, not stderr; log is hard-coded at ~5000 lines per file
 113
 114 - [feature-add] host-mapping is now available when running NF is running in standalone mode via the **NTS_NF_MOUNT_POINT_ADDRESSING_METHOD** variable
 115
 116
 117 version 1.2.1
 118
 119 - [fix] VES commmon header made uniform across all VES-related messages
 120
 121
 122 version 1.2.0
 123
 124 - [change] **Default password of the NETCONF Server was changed to "netconf!", to be complant with O-RAN requirements**
 125
 126 - [feature-add] NACM (NETCONF Access Control Module) default configuration is now according to O-RAN WG4 requirements instead of disabled, like before
 127
 128 - [change] Do not expose sysrepo internal YANG models in the yang-schema-list
 129
 130 - [change] Provide both IPv4 and IPv6 addresses (if available) in pnfRegistration message
 131
 132 - [change] Change ietf-system default configuration and web-ui URL (now points to ConfigApp in SDN-R)
 133
 134 - [fix] Correctly construct URL for SDN Controller and VES Collector when they are addressed via IPv6
 135
 136
 137 version 1.0.3
 138
 139 - [fixed] fixed issues where ODL could not parse the correct versions for yang files
 140
 141
 142 version 1.0.2
 143
 144 - [fixed] bug that occured when trying to start a wrong instance (bad docker-repository or docker-tag)
 145 - [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
 146
 147
 148 version 1.0.1
 149
 150 - [feature-add] added web-cut-through feature
 151 - [fixed] mount-point-addressing-method was mistakenly changing after starting
 152
 153
 154 version 1.0.0
 155 Initial release.
 156
 157 Feature Additions
 158 ^^^^^^^^^^^^^^^^^
 159 * IPv6 for the simulated devices
 160 * NETCONF CallHome for the simulated devices
 161 * Manual notification generation
 162 * Custom naming of the simulated devices
 163
 164 Bug Corrections
 165 ^^^^^^^^^^^^^^^
 166 * `ssh-connections` and `tls-connections` leafs are now removed from the simulator-config
 167 * `fault-notification-delay-period` has now the attribute `ordered-by user`
 168
 169 Deliverables
 170 ^^^^^^^^^^^^
 171
 172 Software Deliverables
 173 +++++++++++++++++++++
 174
 175 The following docker containers are the resulting artefacts of the sim-o1-project:
 176
 177 * **o-ran-sc/ntsim-manager** - this image contains the NTS Manager, which handles the simulation environment;
 178
 179 * **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;
 180
 181 * **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.
 182
 183 * **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;
 184
 185 * **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;
 186
 187 Documentation Deliverables
 188 ++++++++++++++++++++++++++
 189
 190
 191 Known Limitations, Issues and Workarounds
 192 -----------------------------------------
 193 N/A
 194
 195 System Limitations
 196 ^^^^^^^^^^^^^^^^^^
 197 N/A
 198
 199 Known Issues
 200 ^^^^^^^^^^^^
 201 N/A
 202
 203 Workarounds
 204 ^^^^^^^^^^^
 205 N/A
 206
 207
 208 References
 209 ----------
 210 `NTS Project <https://github.com/Melacon/ntsim>`_
 211
 212
 213