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