docs/releasenotes/releasenotes.rst

   1 .. SPDX-License-Identifier: CC-BY-4.0
   2 .. Copyright 2019 ORANGE
   3
   4 Release Notes
   5 =============
   6
   7 Version: 5.0.0
   8 --------------
   9
  10 :Release Date: 2019-08-16
  11
  12 El Alto Early Drop Release tag - 5.0.0
  13
  14 **Fix**
  15
  16 - `EXTAPI-248 <https://jira.onap.org/browse/EXTAPI-248>`_ - ExtAPI should not be polling SDC-DISTR-NOTIF-TOPIC-AUTO without authenticating
  17 - `EXTAPI-249 <https://jira.onap.org/browse/EXTAPI-249>`_ - Change to oom dockers causing permissions failing when tosca parsing
  18
  19 Detail of features described in the readTheDoc documentation.
  20
  21 https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/index.html
  22
  23
  24 **Known Issues**
  25
  26 No new issues
  27
  28 **Security Notes**
  29
  30 - Same as Dublin 4.0.0
  31
  32 Quick Links:
  33
  34 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
  35
  36 **Upgrade Notes**
  37
  38 No major API change. The API Major version is still 4.
  39
  40 /nbi/api/v4
  41
  42 El Alto Early Drop API version is 4.0.1 i.e. Patch only
  43
  44 Version: 4.0.0
  45 --------------
  46
  47 :Release Date: 2019-05-30
  48
  49 New major version v4 for the API, see Upgrade Notes
  50
  51 Dedicated Postman collection can be found in the integration project see `test/postman <https://git.onap.org/integration/tree/test/postman?h=dublin>`_
  52
  53 All tests suites have been re written in Karate, see `src/test/resources/karatetest <https://git.onap.org/externalapi/nbi/tree/src/test/resources/karatetest?h=dublin>`_ for inspiration.
  54
  55 **New Features**
  56
  57 Main new features are supports of
  58
  59 - `BroadBand Service Use Case ( BBS ) <https://wiki.onap.org/pages/viewpage.action?pageId=45297636>`_
  60 - `Cross Domain and Cross Layer VPN ( CCVPN ) <https://wiki.onap.org/display/DW/CCVPN%28Cross+Domain+and+Cross+Layer+VPN%29+USE+CASE>`_
  61
  62 Main functional changes for BBS:
  63
  64 - `EXTAPI-98 <https://jira.onap.org/browse/EXTAPI-98>`_ - Service inventory notification`
  65 - `EXTAPI-161 <https://jira.onap.org/browse/EXTAPI-161>`_ - New service specificationInputSchemas operation`
  66
  67 Main functional change for CCVPN
  68
  69 - `EXTAPI-182 <https://jira.onap.org/browse/EXTAPI-182>`_ - Create SO -> ExtAPI interface`
  70
  71 Many other changes and improvement are listed in JIRA:
  72
  73 - `All Dublin issues <https://jira.onap.org/issues/?filter=11786>`_
  74
  75 **Known Issues**
  76
  77 - `EXTAPI-197 <https://jira.onap.org/browse/EXTAPI-197>`_ - Bad hostname while registering on MSB
  78 - `EXTAPI-222 <https://jira.onap.org/browse/EXTAPI-222>`_ - Add support for HTTPS
  79 - `EXTAPI-249 <https://jira.onap.org/browse/EXTAPI-249>`_ - Change to oom dockers causing permissions failing when tosca parsing
  80
  81 EXTAPI-249 has limited impact on BBS use case:
  82 GET /serviceSpecification{id}
  83 returns empty serviceSpecCharacteristic.
  84
  85 **Security Notes**
  86
  87 *Fixed Security Issues*
  88
  89 NBI has been improved to reduce signs of vulnerabilities,
  90 especially by migrating from Springboot 1.x to Springboot 2 and using ONAP Parent pom.xml
  91
  92 *Known Security Issues*
  93
  94 - `OJSI-136 <https://jira.onap.org/browse/OJSI-136>`_ - In default deployment EXTAPI (nbi) exposes HTTP port 30274 outside of cluster.
  95    NBI exposes non TLS API endpoint on port 30274, meaning full plain text exchange with NBI API.
  96    TLS configuration, with ONAP Root CA signed certificate will be proposed in El Alto.
  97
  98    As a workaround it is quite easy to add HTTPS support to NBI by configuring SSL and activating strict https.
  99    Presuming you have a valid JKS keystore, with private key and a signed certificate:
 100
 101    ::
 102
 103        src/main/resources/application.properties
 104
 105    ::
 106
 107        # tls/ssl
 108        server.ssl.key-store-type=JKS
 109        server.ssl.key-store=classpath:certificate/yourkeystore.jks
 110        server.ssl.key-store-password=password
 111        server.ssl.key-alias=youralias
 112
 113        # disable http and activate https
 114        security.require-ssl=true
 115
 116 *Known Vulnerabilities in Used Modules*
 117
 118 - `Dublin Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=51282484>`_
 119
 120 Quick Links:
 121
 122 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 123
 124 **Upgrade Notes**
 125
 126 API is a new MAJOR v4 version due to the deletion of the 'hasStarted' attribute from getServiceById response
 127 GET /service/{id}
 128
 129 So don't forget to use this new path:
 130
 131 /nbi/api/v4
 132
 133 before:
 134
 135 /nbi/api/v3
 136
 137 **Deprecation Notes**
 138
 139 API v3 is deprecated
 140
 141 **Other**
 142
 143 ===========
 144
 145 Version: 3.0.2
 146 --------------
 147
 148 :Release Date: 2019-01-31
 149
 150 Part of Casablanca Maintenance Release tag - 3.0.1 January 31st, 2019
 151
 152 **Fix**
 153
 154 - `EXTAPI-164 <https://jira.onap.org/browse/EXTAPI-164>`_ - Start up failed without msb
 155 - `EXTAPI-172 <https://jira.onap.org/browse/EXTAPI-172>`_ - Multiple service orders in a single request
 156
 157 Detail of features described in the readTheDoc documentation.
 158
 159 **Known Issues**
 160
 161 No new issues
 162
 163 **Security Notes**
 164
 165 - `Casablanca Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45310585>`_
 166
 167 Quick Links:
 168
 169 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 170
 171
 172 https://wiki.onap.org/pages/viewpage.action?pageId=51282484
 173
 174 ===========
 175
 176 Version: 3.0.1
 177 --------------
 178
 179 :Release Date: 2018-11-30
 180
 181 **New Features**
 182
 183 Main features are:
 184
 185 - `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API
 186 - `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC
 187 - `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API
 188 - `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
 189 - `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
 190 - `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
 191 - `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Add support for progress percentage on ServiceOrder tracking
 192
 193 Detail of features described in the readTheDoc documentation.
 194
 195 **Known Issues**
 196
 197 No new issue (see Beijing ones)
 198
 199 **Security Notes**
 200
 201 - `Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45301150>`_
 202
 203 Quick Links:
 204
 205 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 206
 207 **Upgrade Notes**
 208
 209 No upgrade available from Beijing
 210
 211 **Deprecation Notes**
 212
 213 NA
 214
 215 **Other**
 216
 217 ===========
 218
 219 Version: 1.0.0
 220 --------------
 221
 222 :Release Date: 2018-06-07
 223
 224 **New Features**
 225
 226 Main features are:
 227
 228 - `EXTAPI-39 <https://jira.onap.org/browse/EXTAPI-39>`_ - Retrieve SDC information (catalog information) for service level artifacts based on TMF633 open APIs - operation GET
 229 - `EXTAPI-41 <https://jira.onap.org/browse/EXTAPI-41>`_ - Retrieve AAI information (inventory information) for service instance level artifacts based on TMF638 open APIs - operation GET
 230 - `EXTAPI-42 <https://jira.onap.org/browse/EXTAPI-42>`_ - Create and retrieve SO service request for service level based on TMF641 open APIS - Operations POST & GET
 231
 232 Detail of features described in the readTheDoc documentation.
 233
 234 **Bug Fixes**
 235
 236 Not applicable - This is an initial release
 237
 238 **Known Issues**
 239
 240 For service catalog:
 241
 242 - Find criteria are limited
 243
 244 For service inventory:
 245
 246 - Customer information must be passed to get complete service representation.
 247 - Find criteria are limited.
 248
 249 For service order:
 250
 251 - ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change).
 252 - Only service level request is performed.
 253 - No request for VNF/VF and no call to SDNC.
 254 - `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue).
 255 - Only active service state is considered to add a service.
 256
 257 Detail of limitations described in the readTheDoc documentation.
 258
 259 **Security Notes**
 260
 261 External API code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The External API open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_.
 262 Authentication management and Data Access rights have not been implemented.
 263
 264 Quick Links:
 265
 266 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 267 - `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_
 268 - `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_
 269
 270 **Upgrade Notes**
 271
 272 Not applicable - This is an initial release
 273
 274 **Deprecation Notes**
 275
 276 Not applicable - This is an initial release
 277
 278 **Other**
 279
 280 ===========
 281
 282 End of Release Notes