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
   4 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   5 .. _release_notes:
   6
   7
   8
   9 ========================
  10 DMI-Plugin Release Notes
  11 ========================
  12
  13 .. contents::
  14     :depth: 2
  15 ..
  16
  17 ..      ========================
  18 ..      * * *   JAKARTA   * * *
  19 ..      ========================
  20
  21 Version: 1.1.0-SNAPSHOT
  22 =======================
  23
  24 This section lists the main changes & fixes merged into master (snapshot) version of NCMP-DMI-Plugin. This information is here to assist developers that want experiment/test using our latest code bases directly. Stability of this is not guaranteed.
  25
  26 Features
  27 --------
  28    - `CPS-637 <https://jira.onap.org/browse/CPS-637>`_  Support Update operation for datastore pass-through running
  29    - `CPS-639 <https://jira.onap.org/browse/CPS-639>`_  Support Delete operation for datastore pass-through running
  30
  31 Bug Fixes
  32 ---------
  33
  34 None
  35
  36 Known Limitations, Issues and Workarounds
  37 -----------------------------------------
  38
  39 *System Limitations*
  40
  41 None
  42
  43 *Known Vulnerabilities*
  44
  45 None
  46
  47 *Workarounds*
  48
  49 None
  50
  51 Security Notes
  52 --------------
  53
  54 *Fixed Security Issues*
  55
  56 None
  57
  58 *Known Security Issues*
  59
  60 None
  61
  62 ..      ========================
  63 ..      * * *   ISTANBUL   * * *
  64 ..      ========================
  65
  66 Version: 1.0.1
  67 ==============
  68
  69 Release Data
  70 ------------
  71
  72 +--------------------------------------+--------------------------------------------------------+
  73 | **CPS Project**                      |  DMI-Plugin                                            |
  74 |                                      |                                                        |
  75 +--------------------------------------+--------------------------------------------------------+
  76 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.1                            |
  77 |                                      |                                                        |
  78 +--------------------------------------+--------------------------------------------------------+
  79 | **Release designation**              | 1.0.1 Istanbul                                         |
  80 |                                      |                                                        |
  81 +--------------------------------------+--------------------------------------------------------+
  82 | **Release date**                     | 2021-14-10                                             |
  83 |                                      |                                                        |
  84 +--------------------------------------+--------------------------------------------------------+
  85
  86 Bug Fixes
  87 ---------
  88
  89    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
  90    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
  91    - `CPS-669 <https://jira.onap.org/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
  92    - `CPS-678 <https://jira.onap.org/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
  93    - `CPS-679 <https://jira.onap.org/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
  94    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
  95
  96 Known Limitations, Issues and Workarounds
  97 -----------------------------------------
  98
  99 *System Limitations*
 100
 101   - `CPS-719 <https://jira.onap.org/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
 102
 103 *Known Vulnerabilities*
 104
 105 None
 106
 107 *Workarounds*
 108
 109 None
 110
 111 Security Notes
 112 --------------
 113
 114 *Fixed Security Issues*
 115
 116 None
 117
 118 *Known Security Issues*
 119
 120 None
 121
 122 Version: 1.0.0
 123 ==============
 124
 125 Release Data
 126 ------------
 127
 128 +--------------------------------------+--------------------------------------------------------+
 129 | **CPS Project**                      |  DMI-Plugin                                            |
 130 |                                      |                                                        |
 131 +--------------------------------------+--------------------------------------------------------+
 132 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.0                            |
 133 |                                      |                                                        |
 134 +--------------------------------------+--------------------------------------------------------+
 135 | **Release designation**              | 1.0.0 Istanbul                                         |
 136 |                                      |                                                        |
 137 +--------------------------------------+--------------------------------------------------------+
 138 | **Release date**                     | 2021-14-09                                             |
 139 |                                      |                                                        |
 140 +--------------------------------------+--------------------------------------------------------+
 141
 142 Features
 143 --------
 144 * Implement plugin registration.
 145 * Retrieve data from cmHandles using ncmp-datastores passthrough.
 146 * Retrieve Yang Resources from one or more modules of a  CM Handle.
 147
 148 .. _istanbul_deliverable:
 149
 150 Deliverables
 151 ------------
 152
 153 Software Deliverables
 154
 155 .. csv-table::
 156    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 157    :widths: auto
 158
 159    "cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
 160
 161 Bug Fixes
 162 ---------
 163
 164    - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
 165    - `CPS-589 <https://jira.onap.org/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
 166    - `CPS-617 <https://jira.onap.org/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
 167
 168 Summary
 169 -------
 170
 171 Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
 172
 173     * Platform components
 174
 175     * Service components
 176
 177     * Additional resources that CPS utilizes deployed using ONAP common charts
 178
 179 Below service components (mS) are available to be deployed on-demand.
 180
 181 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 182
 183 Known Limitations, Issues and Workarounds
 184 -----------------------------------------
 185
 186 *System Limitations*
 187
 188 None
 189
 190 *Known Vulnerabilities*
 191
 192    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 193    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 194
 195 *Workarounds*
 196
 197 None
 198
 199 Security Notes
 200 --------------
 201
 202 *Fixed Security Issues*
 203
 204 None
 205
 206 *Known Security Issues*
 207
 208 None
 209
 210 References
 211 ----------
 212
 213 For more information on the ONAP Istanbul release, please see:
 214
 215 #. `ONAP Home Page`_
 216 #. `ONAP Documentation`_
 217 #. `ONAP Release Downloads`_
 218 #. `ONAP Wiki Page`_
 219
 220
 221 .. _`ONAP Home Page`: https://www.onap.org
 222 .. _`ONAP Wiki Page`: https://wiki.onap.org
 223 .. _`ONAP Documentation`: https://docs.onap.org
 224 .. _`ONAP Release Downloads`: https://git.onap.org
 225
 226 Quick Links:
 227
 228         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 229         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_