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