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