docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2021-2022 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _release_notes:
   7
   8
   9
  10 ========================
  11 DMI-Plugin Release Notes
  12 ========================
  13
  14 .. contents::
  15     :depth: 2
  16 ..
  17 ..      ====================
  18 ..      * * *   KOHN   * * *
  19 ..      ====================
  20
  21 Version: 1.4.0
  22 ==============
  23
  24 Release Data
  25 ------------
  26
  27 +--------------------------------------+--------------------------------------------------------+
  28 | **CPS Project**                      |  DMI-Plugin                                            |
  29 |                                      |                                                        |
  30 +--------------------------------------+--------------------------------------------------------+
  31 | **Docker images**                    | onap/ncmp-dmi-plugin:1.4.0                             |
  32 |                                      |                                                        |
  33 +--------------------------------------+--------------------------------------------------------+
  34 | **Release designation**              | 1.4.0 Montreal                                         |
  35 |                                      |                                                        |
  36 +--------------------------------------+--------------------------------------------------------+
  37 | **Release date**                     | (not yet released)                                     |
  38 |                                      |                                                        |
  39 +--------------------------------------+--------------------------------------------------------+
  40
  41 Features
  42 --------
  43    - `CPS-1775 <https://jira.onap.org/browse/CPS-1775>`_  Migrate to Java 17.
  44    - `CPS-1790 <https://jira.onap.org/browse/CPS-1790>`_  Update to Spring Boot 3.1.2.
  45
  46
  47 Version: 1.2.2 (not yet released)
  48 =================================
  49
  50 Release Data
  51 ------------
  52
  53 +--------------------------------------+--------------------------------------------------------+
  54 | **CPS Project**                      |  DMI-Plugin                                            |
  55 |                                      |                                                        |
  56 +--------------------------------------+--------------------------------------------------------+
  57 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.2                             |
  58 |                                      |                                                        |
  59 +--------------------------------------+--------------------------------------------------------+
  60 | **Release designation**              | 1.2.2 Kohn                                             |
  61 |                                      |                                                        |
  62 +--------------------------------------+--------------------------------------------------------+
  63 | **Release date**                     | (not yet released)                                     |
  64 |                                      |                                                        |
  65 +--------------------------------------+--------------------------------------------------------+
  66
  67 Bug Fixes
  68 ---------
  69    - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_  [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
  70
  71
  72 Version: 1.2.1
  73 ==============
  74
  75 Release Data
  76 ------------
  77
  78 +--------------------------------------+--------------------------------------------------------+
  79 | **CPS Project**                      |  DMI-Plugin                                            |
  80 |                                      |                                                        |
  81 +--------------------------------------+--------------------------------------------------------+
  82 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.1                             |
  83 |                                      |                                                        |
  84 +--------------------------------------+--------------------------------------------------------+
  85 | **Release designation**              | 1.2.1 Kohn                                             |
  86 |                                      |                                                        |
  87 +--------------------------------------+--------------------------------------------------------+
  88 | **Release date**                     | 2022 October 5                                         |
  89 |                                      |                                                        |
  90 +--------------------------------------+--------------------------------------------------------+
  91
  92 Bug Fixes
  93 ---------
  94    - None
  95
  96 Version: 1.2.0
  97 ==============
  98
  99 Release Data
 100 ------------
 101
 102 +--------------------------------------+--------------------------------------------------------+
 103 | **CPS Project**                      |  DMI-Plugin                                            |
 104 |                                      |                                                        |
 105 +--------------------------------------+--------------------------------------------------------+
 106 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.0                             |
 107 |                                      |                                                        |
 108 +--------------------------------------+--------------------------------------------------------+
 109 | **Release designation**              | 1.2.0 Kohn                                             |
 110 |                                      |                                                        |
 111 +--------------------------------------+--------------------------------------------------------+
 112 | **Release date**                     | 2022 September 21                                      |
 113 |                                      |                                                        |
 114 +--------------------------------------+--------------------------------------------------------+
 115
 116 Features
 117 --------
 118    - `CPS-562 <https://jira.onap.org/browse/CPS-562>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (DMI Plugin.)
 119    - `CPS-832 <https://jira.onap.org/browse/CPS-832>`_  Async: E2E Integration
 120    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
 121
 122 Bug Fixes
 123 ---------
 124    - None
 125
 126 Known Limitations, Issues and Workarounds
 127 -----------------------------------------
 128
 129 *System Limitations*
 130
 131 None
 132
 133 *Known Vulnerabilities*
 134
 135 None
 136
 137 *Workarounds*
 138
 139 None
 140
 141 Security Notes
 142 --------------
 143
 144 *Fixed Security Issues*
 145
 146 None
 147
 148 *Known Security Issues*
 149
 150 None
 151
 152 ..      ========================
 153 ..      * * *   JAKARTA   * * *
 154 ..      ========================
 155
 156 Version: 1.1.0
 157 ==============
 158
 159 Release Data
 160 ------------
 161
 162 +--------------------------------------+--------------------------------------------------------+
 163 | **CPS Project**                      |  DMI-Plugin                                            |
 164 |                                      |                                                        |
 165 +--------------------------------------+--------------------------------------------------------+
 166 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.1.0                            |
 167 |                                      |                                                        |
 168 +--------------------------------------+--------------------------------------------------------+
 169 | **Release designation**              | 1.1.0 Jakarta                                          |
 170 |                                      |                                                        |
 171 +--------------------------------------+--------------------------------------------------------+
 172 | **Release date**                     | 2022 March 15                                          |
 173 |                                      |                                                        |
 174 +--------------------------------------+--------------------------------------------------------+
 175
 176 Features
 177 --------
 178    - `CPS-637 <https://jira.onap.org/browse/CPS-637>`_  Support Update operation for datastore pass-through running
 179    - `CPS-639 <https://jira.onap.org/browse/CPS-639>`_  Support Delete operation for datastore pass-through running
 180    - `CPS-784 <https://jira.onap.org/browse/CPS-784>`_  Add examples to DMI-Plugin API Spec
 181
 182 Bug Fixes
 183 ---------
 184
 185    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
 186
 187 Known Limitations, Issues and Workarounds
 188 -----------------------------------------
 189
 190 *System Limitations*
 191
 192 None
 193
 194 *Known Vulnerabilities*
 195
 196 None
 197
 198 *Workarounds*
 199
 200 None
 201
 202 Security Notes
 203 --------------
 204
 205 *Fixed Security Issues*
 206
 207 None
 208
 209 *Known Security Issues*
 210
 211 None
 212
 213 ..      ========================
 214 ..      * * *   ISTANBUL   * * *
 215 ..      ========================
 216
 217 Version: 1.0.3
 218 ==============
 219
 220 Release Data
 221 ------------
 222
 223 +--------------------------------------+--------------------------------------------------------+
 224 | **CPS Project**                      |  DMI-Plugin                                            |
 225 |                                      |                                                        |
 226 +--------------------------------------+--------------------------------------------------------+
 227 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.3                            |
 228 |                                      |                                                        |
 229 +--------------------------------------+--------------------------------------------------------+
 230 | **Release designation**              | 1.0.3 Istanbul                                         |
 231 |                                      |                                                        |
 232 +--------------------------------------+--------------------------------------------------------+
 233 | **Release date**                     | 2022-07-01                                             |
 234 |                                      |                                                        |
 235 +--------------------------------------+--------------------------------------------------------+
 236
 237 Bug Fixes
 238 ---------
 239
 240    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
 241
 242 Version: 1.0.2
 243 ==============
 244
 245 Release Data
 246 ------------
 247
 248 +--------------------------------------+--------------------------------------------------------+
 249 | **CPS Project**                      |  DMI-Plugin                                            |
 250 |                                      |                                                        |
 251 +--------------------------------------+--------------------------------------------------------+
 252 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.2                            |
 253 |                                      |                                                        |
 254 +--------------------------------------+--------------------------------------------------------+
 255 | **Release designation**              | 1.0.2 Istanbul                                         |
 256 |                                      |                                                        |
 257 +--------------------------------------+--------------------------------------------------------+
 258 | **Release date**                     | 2021-16-12                                             |
 259 |                                      |                                                        |
 260 +--------------------------------------+--------------------------------------------------------+
 261
 262 Bug Fixes
 263 ---------
 264
 265    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
 266
 267 Version: 1.0.1
 268 ==============
 269
 270 Release Data
 271 ------------
 272
 273 +--------------------------------------+--------------------------------------------------------+
 274 | **CPS Project**                      |  DMI-Plugin                                            |
 275 |                                      |                                                        |
 276 +--------------------------------------+--------------------------------------------------------+
 277 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.1                            |
 278 |                                      |                                                        |
 279 +--------------------------------------+--------------------------------------------------------+
 280 | **Release designation**              | 1.0.1 Istanbul                                         |
 281 |                                      |                                                        |
 282 +--------------------------------------+--------------------------------------------------------+
 283 | **Release date**                     | 2021-14-10                                             |
 284 |                                      |                                                        |
 285 +--------------------------------------+--------------------------------------------------------+
 286
 287 Bug Fixes
 288 ---------
 289
 290    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 291    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 292    - `CPS-669 <https://jira.onap.org/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
 293    - `CPS-678 <https://jira.onap.org/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
 294    - `CPS-679 <https://jira.onap.org/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
 295    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
 296
 297 Known Limitations, Issues and Workarounds
 298 -----------------------------------------
 299
 300 *System Limitations*
 301
 302   - `CPS-719 <https://jira.onap.org/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
 303
 304 *Known Vulnerabilities*
 305
 306 None
 307
 308 *Workarounds*
 309
 310 None
 311
 312 Security Notes
 313 --------------
 314
 315 *Fixed Security Issues*
 316
 317 None
 318
 319 *Known Security Issues*
 320
 321 None
 322
 323 Version: 1.0.0
 324 ==============
 325
 326 Release Data
 327 ------------
 328
 329 +--------------------------------------+--------------------------------------------------------+
 330 | **CPS Project**                      |  DMI-Plugin                                            |
 331 |                                      |                                                        |
 332 +--------------------------------------+--------------------------------------------------------+
 333 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.0                            |
 334 |                                      |                                                        |
 335 +--------------------------------------+--------------------------------------------------------+
 336 | **Release designation**              | 1.0.0 Istanbul                                         |
 337 |                                      |                                                        |
 338 +--------------------------------------+--------------------------------------------------------+
 339 | **Release date**                     | 2021-14-09                                             |
 340 |                                      |                                                        |
 341 +--------------------------------------+--------------------------------------------------------+
 342
 343 Features
 344 --------
 345 * Implement plugin registration.
 346 * Retrieve data from cmHandles using ncmp-datastores passthrough.
 347 * Retrieve Yang Resources from one or more modules of a  CM Handle.
 348
 349 .. _istanbul_deliverable:
 350
 351 Deliverables
 352 ------------
 353
 354 Software Deliverables
 355
 356 .. csv-table::
 357    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 358    :widths: auto
 359
 360    "cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
 361
 362 Bug Fixes
 363 ---------
 364
 365    - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
 366    - `CPS-589 <https://jira.onap.org/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
 367    - `CPS-617 <https://jira.onap.org/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
 368
 369 Summary
 370 -------
 371
 372 Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
 373
 374     * Platform components
 375
 376     * Service components
 377
 378     * Additional resources that CPS utilizes deployed using ONAP common charts
 379
 380 Below service components (mS) are available to be deployed on-demand.
 381
 382 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 383
 384 Known Limitations, Issues and Workarounds
 385 -----------------------------------------
 386
 387 *System Limitations*
 388
 389 None
 390
 391 *Known Vulnerabilities*
 392
 393    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 394    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 395
 396 *Workarounds*
 397
 398 None
 399
 400 Security Notes
 401 --------------
 402
 403 *Fixed Security Issues*
 404
 405 None
 406
 407 *Known Security Issues*
 408
 409 None
 410
 411 References
 412 ----------
 413
 414 For more information on the latest ONAP release, please see:
 415
 416 #. `ONAP Home Page`_
 417 #. `ONAP Wiki Page`_
 418 #. `ONAP Documentation`_
 419 #. `ONAP DMI Plugin Documentation`_
 420 #. `ONAP Release Downloads`_
 421
 422
 423 .. _`ONAP Home Page`: https://www.onap.org
 424 .. _`ONAP Wiki Page`: https://wiki.onap.org
 425 .. _`ONAP Documentation`: https://docs.onap.org
 426 .. _`ONAP DMI Plugin Documentation`: https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin
 427 .. _`ONAP Release Downloads`: https://git.onap.org
 428
 429 Quick Links:
 430
 431         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 432         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_