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