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) 2021 highstreet technologies GmbH
   4
   5
   6 Operation and Maintenance Release Notes
   7 =======================================
   8
   9 This document provides the release notes for O-RAN-SC D-Release of the Operation and Maintenance (OAM) project.
  10
  11 A collection of release notes for used projects is available in `O-RAN-SC OAM wiki release notes <https://wiki.o-ran-sc.org/display/OAM/E-Release+Notes>`__.
  12
  13 Version 5.1.0, 2022-01-31
  14 -------------------------
  15
  16 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  17 | Issue                                                   | Summary                                                                         |
  18 +=========================================================+=================================================================================+
  19 | `OAM-48   <https://jira.o-ran-sc.org/browse/OAM-48>`__  | Bug fixes in o-ran-sc-du-hello-world yang                                       |
  20 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  21 | `OAM-237  <https://jira.o-ran-sc.org/browse/OAM-237>`__ | Bug fixes in o-ran-sc-du-hello-world yang                                       |
  22 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  23 | `OAM-240  <https://jira.o-ran-sc.org/browse/OAM-240>`__ | Late updates on integration deployment                                          |
  24 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  25 | `OAM-241  <https://jira.o-ran-sc.org/browse/OAM-241>`__ | OAM - VES sender script improvement                                             |
  26 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  27
  28 Known issues
  29 ------------
  30
  31 +--------------------------------------------------------------------------+---------------------------------------------------------------------------------+
  32 | Issue                                                                    | Summary                                                                         |
  33 +==========================================================================+=================================================================================+
  34 | `DCAEGEN2-3024 <https://jira.onap.org/browse/DCAEGEN2-3024>`__           | Support of values with 'oneOf' types.                                           |
  35 +--------------------------------------------------------------------------+---------------------------------------------------------------------------------+
  36 | `YANGTOOLS-1388 <https://jira.opendaylight.org/browse/YANGTOOLS-1388>`__ | Support of namespace for referred yang-identity values.                         |
  37 +--------------------------------------------------------------------------+---------------------------------------------------------------------------------+
  38
  39 Version 5.0.0, 2021-11-29
  40 -------------------------
  41
  42 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  43 | Issue                                                   | Summary                                                                         |
  44 +=========================================================+=================================================================================+
  45 | `OAM-221  <https://jira.o-ran-sc.org/browse/OAM-221>`__ | Wrong value format in measurement ves example                                   |
  46 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  47 | `OAM-222  <https://jira.o-ran-sc.org/browse/OAM-222>`__ | OAM Deployment enhancements                                                     |
  48 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  49 | `OAM-223  <https://jira.o-ran-sc.org/browse/OAM-223>`__ | update from stating to released                                                 |
  50 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  51 | `OAM-226  <https://jira.o-ran-sc.org/browse/OAM-226>`__ | Create yang model for CM according to the requirements by O-DU and the use case |
  52 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  53 | `OAM-227  <https://jira.o-ran-sc.org/browse/OAM-227>`__ | Create VES stndDefined extension for PM-streaming                               |
  54 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  55 | `OAM-228  <https://jira.o-ran-sc.org/browse/OAM-228>`__ | Update O-RAN-SC-Du Hello-world yang for CM                                      |
  56 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  57 | `OAM-229  <https://jira.o-ran-sc.org/browse/OAM-229>`__ | Update header of o-ran-sc-du-hello-world                                        |
  58 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  59 | `OAM-230  <https://jira.o-ran-sc.org/browse/OAM-230>`__ | Consider CM in o-ran-sc-du-hello-world.yang                                     |
  60 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  61 | `OAM-231  <https://jira.o-ran-sc.org/browse/OAM-231>`__ | Add slice management to o-ran-sc-du-hello-world.yang                            |
  62 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  63 | `OAM-232  <https://jira.o-ran-sc.org/browse/OAM-232>`__ | Add performance measurement job management to o-ran-sc-du-hello-world.yang      |
  64 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  65 | `OAM-233  <https://jira.o-ran-sc.org/browse/OAM-233>`__ | Add subscription management to o-ran-sc-du-hello-world.yang                     |
  66 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  67 | `OAM-234  <https://jira.o-ran-sc.org/browse/OAM-234>`__ | Create VES stndDefined PM streaming OpenAPI                                     |
  68 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  69 | `OAM-235  <https://jira.o-ran-sc.org/browse/OAM-235>`__ | Create a Yang notification syntax                                               |
  70 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  71 | `OAM-237  <https://jira.o-ran-sc.org/browse/OAM-237>`__ | Bug fixes in o-ran-sc-du-hello-world yang                                       |
  72 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  73 | `OAM-238  <https://jira.o-ran-sc.org/browse/OAM-238>`__ | Update O-RAN-SC wiki release page                                               |
  74 +---------------------------------------------------------+---------------------------------------------------------------------------------+
  75
  76
  77 Version 4.0.4, 2021-05-22
  78 -------------------------
  79
  80 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
  81 | Issue                                                              | Summary                                                                 |
  82 +====================================================================+=========================================================================+
  83 | `OAM-177     <https://jira.o-ran-sc.org/browse/OAM-177>`__         | Update Documentation for docker supporting IPv6                         |
  84 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
  85 | `OAM-188     <https://jira.o-ran-sc.org/browse/OAM-188>`__         | Provide OpenAPI                                                         |
  86 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
  87 | `OAM-191     <https://jira.o-ran-sc.org/browse/OAM-191>`__         | O-RU on-boarding                                                        |
  88 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
  89 | `OAM-192     <https://jira.o-ran-sc.org/browse/OAM-192>`__         | O-DU on-boarding                                                        |
  90 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
  91 | `OAM-193     <https://jira.o-ran-sc.org/browse/OAM-192>`__         | Test environment                                                        |
  92 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
  93 | `OAM-194     <https://jira.o-ran-sc.org/browse/OAM-194>`__         | O-RU closed loop recovery                                               |
  94 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
  95 | `OAM-195     <https://jira.o-ran-sc.org/browse/OAM-195>`__         | Documentation                                                           |
  96 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
  97 | `OAM-212     <https://jira.o-ran-sc.org/browse/OAM-212>`__         | Add section referencing O-RAN specifications                            |
  98 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
  99 | `OAM-213     <https://jira.o-ran-sc.org/browse/OAM-213>`__         | Update Deployment docs                                                  |
 100 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 101
 102 Version 4.0.3, 2021-04-23
 103 -------------------------
 104
 105 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 106 | Issue                                                              | Summary                                                                 |
 107 +====================================================================+=========================================================================+
 108 | `OAM-150     <https://jira.o-ran-sc.org/browse/OAM-150>`__         | Provide settings.xml                                                    |
 109 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 110 | `OAM-171     <https://jira.o-ran-sc.org/browse/OAM-171>`__         | Update docs OAM architecture diagram                                    |
 111 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 112 | `OAM-178     <https://jira.o-ran-sc.org/browse/OAM-178>`__         | Creation of use case docker-compose                                     |
 113 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 114 | `OAM-179     <https://jira.o-ran-sc.org/browse/OAM-179>`__         | Remove unused folders                                                   |
 115 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 116 | `OAM-181     <https://jira.o-ran-sc.org/browse/OAM-181>`__         | Update docker-compose to onap-sdnc:2.1.3                                |
 117 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 118 | `OAM-182     <https://jira.o-ran-sc.org/browse/OAM-182>`__         | Create dev example for additional ves domains                           |
 119 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 120 | `OAM-183     <https://jira.o-ran-sc.org/browse/OAM-183>`__         | Create VES client example for domain 'notification'                     |
 121 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 122 | `OAM-184     <https://jira.o-ran-sc.org/browse/OAM-184>`__         | Create VES client example for domain 'stateChange'                      |
 123 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 124 | `OAM-185     <https://jira.o-ran-sc.org/browse/OAM-185>`__         | Create VES client example for domain 'stndefined'                       |
 125 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 126 | `OAM-187     <https://jira.o-ran-sc.org/browse/OAM-187>`__         | Update Jenkins Jobs                                                     |
 127 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 128 | `OAM-189     <https://jira.o-ran-sc.org/browse/OAM-189>`__         | Remove builder jobs of project oam                                      |
 129 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 130
 131
 132 Version 4.0.3, 2021-04-23
 133 -------------------------
 134
 135 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 136 | Issue                                                              | Summary                                                                 |
 137 +====================================================================+=========================================================================+
 138 | `OAM-150     <https://jira.o-ran-sc.org/browse/OAM-150>`__         | Provide settings.xml                                                    |
 139 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 140 | `OAM-171     <https://jira.o-ran-sc.org/browse/OAM-171>`__         | Update docs OAM architecture diagram                                    |
 141 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 142 | `OAM-178     <https://jira.o-ran-sc.org/browse/OAM-178>`__         | Creation of use case docker-compose                                     |
 143 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 144 | `OAM-179     <https://jira.o-ran-sc.org/browse/OAM-179>`__         | Remove unused folders                                                   |
 145 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 146 | `OAM-181     <https://jira.o-ran-sc.org/browse/OAM-181>`__         | Update docker-compose to onap-sdnc:2.1.3                                |
 147 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 148 | `OAM-182     <https://jira.o-ran-sc.org/browse/OAM-182>`__         | Create dev example for additional ves domains                           |
 149 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 150 | `OAM-183     <https://jira.o-ran-sc.org/browse/OAM-183>`__         | Create VES client example for domain 'notification'                     |
 151 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 152 | `OAM-184     <https://jira.o-ran-sc.org/browse/OAM-184>`__         | Create VES client example for domain 'stateChange'                      |
 153 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 154 | `OAM-185     <https://jira.o-ran-sc.org/browse/OAM-185>`__         | Create VES client example for domain 'stndefined'                       |
 155 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 156 | `OAM-187     <https://jira.o-ran-sc.org/browse/OAM-187>`__         | Update Jenkins Jobs                                                     |
 157 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 158 | `OAM-189     <https://jira.o-ran-sc.org/browse/OAM-189>`__         | Remove builder jobs of project oam                                      |
 159 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 160
 161
 162 Version 4.0.3, 2021-04-23
 163 -------------------------
 164
 165 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 166 | Issue                                                              | Summary                                                                 |
 167 +====================================================================+=========================================================================+
 168 | `OAM-150     <https://jira.o-ran-sc.org/browse/OAM-150>`__         | Provide settings.xml                                                    |
 169 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 170 | `OAM-171     <https://jira.o-ran-sc.org/browse/OAM-171>`__         | Update docs OAM architecture diagram                                    |
 171 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 172 | `OAM-178     <https://jira.o-ran-sc.org/browse/OAM-178>`__         | Creation of use case docker-compose                                     |
 173 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 174 | `OAM-179     <https://jira.o-ran-sc.org/browse/OAM-179>`__         | Remove unused folders                                                   |
 175 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 176 | `OAM-181     <https://jira.o-ran-sc.org/browse/OAM-181>`__         | Update docker-compose to onap-sdnc:2.1.3                                |
 177 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 178 | `OAM-182     <https://jira.o-ran-sc.org/browse/OAM-182>`__         | Create dev example for additional ves domains                           |
 179 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 180 | `OAM-183     <https://jira.o-ran-sc.org/browse/OAM-183>`__         | Create VES client example for domain 'notification'                     |
 181 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 182 | `OAM-184     <https://jira.o-ran-sc.org/browse/OAM-184>`__         | Create VES client example for domain 'stateChange'                      |
 183 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 184 | `OAM-185     <https://jira.o-ran-sc.org/browse/OAM-185>`__         | Create VES client example for domain 'stndefined'                       |
 185 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 186 | `OAM-187     <https://jira.o-ran-sc.org/browse/OAM-187>`__         | Update Jenkins Jobs                                                     |
 187 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 188 | `OAM-189     <https://jira.o-ran-sc.org/browse/OAM-189>`__         | Remove builder jobs of project oam                                      |
 189 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 190
 191
 192 Version 4.0.2, 2021-04-02
 193 --------------------------
 194
 195 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 196 | Issue                                                              | Summary                                                                 |
 197 +====================================================================+=========================================================================+
 198 | `OAM-180     <https://jira.o-ran-sc.org/browse/OAM-180>`__         | Wrong time format in VES client scripts                                 |
 199 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 200 | `OAM-176     <https://jira.o-ran-sc.org/browse/OAM-176>`__         | Support of IPv6 by docker-compose                                       |
 201 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 202 | `OAM-175     <https://jira.o-ran-sc.org/browse/OAM-175>`__         | Update docker-compose and its configurations                            |
 203 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 204 | `OAM-174     <https://jira.o-ran-sc.org/browse/OAM-174>`__         | Update VES Client scripts supporting VES 7.2                            |
 205 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 206 | `OAM-173     <https://jira.o-ran-sc.org/browse/OAM-173>`__         | Update VES client scripts supporting https                              |
 207 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 208 | `OAM-170     <https://jira.o-ran-sc.org/browse/OAM-170>`__         | Delete folder 'model' from OAM repo'                                    |
 209 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 210 | `OAM-169     <https://jira.o-ran-sc.org/browse/OAM-169>`__         | Use case driven yang for O-DU                                           |
 211 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 212 | `OAM-168     <https://jira.o-ran-sc.org/browse/OAM-168>`__         | Update namespace definitions in prototype yangs of O-RAN-SC             |
 213 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 214 | `OAM-164     <https://jira.o-ran-sc.org/browse/OAM-164>`__         | Add WG4 november train yangs modules                                    |
 215 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 216 | `SDNC-1480   <https://jira.onap.org/browse/SDNC-1480>`__           | O-RAN (FrontHaul) deviceManager: support of GuiCutThrough               |
 217 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 218 | `CCSDK-3161  <https://jira.onap.org/browse/CCSDK-3161>`__          | O-RAN (FrontHaul) deviceManager: o-ran-fm.yang/alarm-notif to VES:fault |
 219 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 220 | `CCSDK-3160  <https://jira.onap.org/browse/CCSDK-3160>`__          | CallHome to VES:pnfRegistration                                         |
 221 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 222 | `NETCONF-766 <https://jira.opendaylight.org/browse/NETCONF-766>`__ | Logging al RESTCONF requests and responses [1]_                         |
 223 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 224 | `NETCONF-744 <https://jira.opendaylight.org/browse/NETCONF-744>`__ | Read whole leaf-list using get/get-config RPC [1]_                      |
 225 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 226 | `NETCONF-735 <https://jira.opendaylight.org/browse/NETCONF-735>`__ | Support NETCONF get/get-config with multiple selected subtrees [1]_     |
 227 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
 228
 229 .. [1] Patched via MAVEN repo into CCSDK as long as code is not merged into OpenDaylight master branch
 230
 231
 232 Version 4.0.1, 2021-03-12
 233 --------------------------
 234
 235 +--------------------------------------------------------+-------------------------------------------------------------+
 236 | Issue                                                  | Summary                                                     |
 237 +========================================================+=============================================================+
 238 | `OAM-166 <https://jira.o-ran-sc.org/browse/OAM-166>`__ | Add WG4 July 2020 yang modules                              |
 239 +--------------------------------------------------------+-------------------------------------------------------------+
 240 | `OAM-163 <https://jira.o-ran-sc.org/browse/OAM-163>`__ | Rename yang filename to <module>@<revision> format          |
 241 +--------------------------------------------------------+-------------------------------------------------------------+
 242 | `OAM-160 <https://jira.o-ran-sc.org/browse/OAM-160>`__ | Modeling Repo: SIM directory not longer required            |
 243 +--------------------------------------------------------+-------------------------------------------------------------+
 244 | `OAM-159 <https://jira.o-ran-sc.org/browse/OAM-159>`__ | Remove yang models from Repo                                |
 245 +--------------------------------------------------------+-------------------------------------------------------------+
 246 | `OAM-154 <https://jira.o-ran-sc.org/browse/OAM-154>`__ | OAM tr069: Changing .gitignore for IntelliJ related files   |
 247 +--------------------------------------------------------+-------------------------------------------------------------+
 248 | `OAM-121 <https://jira.o-ran-sc.org/browse/OAM-121>`__ | Request to modify SMO deployment SOP                        |
 249 +--------------------------------------------------------+-------------------------------------------------------------+
 250 | `OAM-120 <https://jira.o-ran-sc.org/browse/OAM-120>`__ | Release dashboard image at version 2.0.3                    |
 251 +--------------------------------------------------------+-------------------------------------------------------------+
 252
 253 Version 2.0.4, 2020-06-13
 254 --------------------------
 255
 256 * Documentation updated
 257 * Develop reusable OAM API such that the first consumer being a VTH can query, subscribe or publish on a DMaaP topic    Story
 258 * Create helm deployment for SMO
 259 * Feature split for starting devicemanagers
 260 * Seed coder for an YANG linter
 261 * Please see also Release Notes of `ONAP SDNC, DCAE, DMaaP, OOM <https://onap-doc.readthedocs.io/en/frankfurt/release/index.html>`_
 262
 263 Version 2.0.3, 2020-04-08
 264 -------------------------
 265
 266 * What is an SMO?
 267 * Provide xRAN datamodels
 268 * Provide curl bash scripts for Software Management
 269 * Add jenkins jobs for oam
 270 * Add parents to model artifacts
 271 * Add top level pom file to distribution
 272 * Wrong image tag in nonrt-o1-controller distribution pom
 273 * Use ONAP release parents directly
 274 * Adjust artifact group name to ORAN naming rule
 275 * Use ORAN parents
 276 * Add push registry to distribution pom
 277
 278 Version 2.0.2, 2020-03-16
 279 -------------------------
 280
 281 * Controller DeviceManager for O-RAN-SC
 282 * Provide O1 yang modules
 283
 284 Version 2.0.1, 2020-02-26
 285 -------------------------
 286
 287 * Develop VTH for A1 interface
 288
 289
 290 Version 1.0.0, 2019-11-14
 291 -------------------------
 292
 293 * Documentation added
 294
 295
 296 Version 0.1.1, 2019-09-18
 297 -------------------------
 298
 299 * Development environment added
 300
 301
 302 Version 0.1.0, 2019-09-08
 303 -------------------------
 304 * Initial version