docs/releasenotes/releasenotes.rst

   1 .. SPDX-License-Identifier: CC-BY-4.0
   2 .. Copyright 2019 ORANGE
   3
   4 Release Notes
   5 =============
   6
   7 Version: 6.0.1
   8 --------------
   9
  10 :Release Date: 2020-04-06
  11
  12 Frankfurt Release tag - 6.0.1
  13
  14 **Fix**
  15
  16 - `OJSI-136 <https://jira.onap.org/browse/OJSI-136>`_ - In default deployment EXTAPI (nbi) exposes HTTP port 30274 outside of cluster.
  17 - `EXTAPI-347 <https://jira.onap.org/browse/EXTAPI-347>`_ - Move to mariadb galera instead of mariadb
  18 - `EXTAPI-222 <https://jira.onap.org/browse/EXTAPI-222>`_ - Add support for HTTPS with AAF artefacts
  19 - `EXTAPI-294 <https://jira.onap.org/browse/EXTAPI-294>`_ - Add support for Service Orders using new "Object" type
  20 - `EXTAPI-304 <https://jira.onap.org/browse/EXTAPI-304>`_ - Update SO request to use GR_API instead of VNF_API
  21 - `EXTAPI-342 <https://jira.onap.org/browse/EXTAPI-342>`_ - NBI to SO: new URL and new Header params
  22 - `EXTAPI-343 <https://jira.onap.org/browse/EXTAPI-343>`_ - NBI to SO: cloudowner value to be taken from application.properties
  23 - `EXTAPI-258 <https://jira.onap.org/browse/EXTAPI-258>`_ - Identify whether the Service is of A-la-carte or macro type
  24 - `EXTAPI-370 <https://jira.onap.org/browse/EXTAPI-370>`_ - Java 11 & oparent 3.0.0-SNAPSHOT
  25 - `EXTAPI-378 <https://jira.onap.org/browse/EXTAPI-378>`_ - Update swagger based on spectral
  26 - `EXTAPI-384 <https://jira.onap.org/browse/EXTAPI-384>`_ - SECCOM Java 11 migration from v8 [REQ-219] in NBI
  27 - `EXTAPI-397 <https://jira.onap.org/browse/EXTAPI-397>`_ - Update Service Order Swagger to align to ONAP Style Guidelines
  28 - `EXTAPI-399 <https://jira.onap.org/browse/EXTAPI-399>`_ - Fix Docker File Image to point to correct base and use 3.0.0 in pom
  29 - `EXTAPI-400 <https://jira.onap.org/browse/EXTAPI-400>`_ - Migrate and Fix sonarcloud code coverage issue
  30 - `EXTAPI-401 <https://jira.onap.org/browse/EXTAPI-401>`_ - remove sonar.jacoco.reportMissing.force.zero
  31 - `EXTAPI-415 <https://jira.onap.org/browse/EXTAPI-415>`_ - Configure NBI with http xor https support, using basic spring capabilities
  32 - `EXTAPI-417 <https://jira.onap.org/browse/EXTAPI-417>`_ - Support http local docker and https OOM via Env Variable
  33 - `EXTAPI-423 <https://jira.onap.org/browse/EXTAPI-423>`_ - Check for CST template is case sensitive
  34 - `EXTAPI-424 <https://jira.onap.org/browse/EXTAPI-424>`_ - Public HTTP port open
  35
  36 Detail of NBI features are described in the readTheDoc documentation.
  37
  38 https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/index.html
  39
  40
  41 **Known Issues**
  42
  43 No new issues
  44
  45 **Security Notes**
  46
  47 In the Frankfurt release, External API has been updated to expose a https interface via OOM installations, in response to OJSI-136.
  48 NBI has also upgraded to Java 11, using the base registry.gitlab.com/onap-integration/docker/onap-java image.
  49
  50 Quick Links:
  51
  52 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
  53
  54 **Upgrade Notes**
  55
  56 No major API changes. The API Major version is still 4.
  57
  58 /nbi/api/v4
  59
  60 Frankfurt API version is 4.1.0 i.e. Minor API changes only,  as most changes are related to security updates. No new APIs.
  61 Swagger changes are mainly in the use of additional markdown for API understanding and conformance to ONAP API Swagger Style Guidelines
  62 https://wiki.onap.org/pages/viewpage.action?pageId=71834147
  63
  64 Version: 5.0.1
  65 --------------
  66
  67 :Release Date: 2019-09-06
  68
  69 El Alto Release tag - 5.0.1
  70
  71 **Fix**
  72
  73 - `EXTAPI-248 <https://jira.onap.org/browse/EXTAPI-248>`_ - ExtAPI should not be polling SDC-DISTR-NOTIF-TOPIC-AUTO without authenticating
  74 - `EXTAPI-249 <https://jira.onap.org/browse/EXTAPI-249>`_ - Change to oom dockers causing permissions failing when tosca parsing
  75 - `EXTAPI-287 <https://jira.onap.org/browse/EXTAPI-287>`_ - NBI to SDC connectivity health checks fail
  76 - `EXTAPI-305 <https://jira.onap.org/browse/EXTAPI-305>`_ - No Need for "ReadWriteMany" access on storage when deploying on Kubernetes
  77
  78 Detail of features described in the readTheDoc documentation.
  79
  80 https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/index.html
  81
  82
  83 **Known Issues**
  84
  85 No new issues
  86
  87 **Security Notes**
  88
  89 - Same as Dublin 4.0.0
  90
  91 Quick Links:
  92
  93 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
  94
  95 **Upgrade Notes**
  96
  97 No major API change. The API Major version is still 4.
  98
  99 /nbi/api/v4
 100
 101 El Alto API version is 4.0.1 i.e. Patch only
 102
 103 Version: 4.0.0
 104 --------------
 105
 106 :Release Date: 2019-05-30
 107
 108 New major version v4 for the API, see Upgrade Notes
 109
 110 Dedicated Postman collection can be found in the integration project see `test/postman <https://git.onap.org/integration/tree/test/postman?h=dublin>`_
 111
 112 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.
 113
 114 **New Features**
 115
 116 Main new features are supports of
 117
 118 - `BroadBand Service Use Case ( BBS ) <https://wiki.onap.org/pages/viewpage.action?pageId=45297636>`_
 119 - `Cross Domain and Cross Layer VPN ( CCVPN ) <https://wiki.onap.org/display/DW/CCVPN%28Cross+Domain+and+Cross+Layer+VPN%29+USE+CASE>`_
 120
 121 Main functional changes for BBS:
 122
 123 - `EXTAPI-98 <https://jira.onap.org/browse/EXTAPI-98>`_ - Service inventory notification`
 124 - `EXTAPI-161 <https://jira.onap.org/browse/EXTAPI-161>`_ - New service specificationInputSchemas operation`
 125
 126 Main functional change for CCVPN
 127
 128 - `EXTAPI-182 <https://jira.onap.org/browse/EXTAPI-182>`_ - Create SO -> ExtAPI interface`
 129
 130 Many other changes and improvement are listed in JIRA:
 131
 132 - `All Dublin issues <https://jira.onap.org/issues/?filter=11786>`_
 133
 134 **Known Issues**
 135
 136 - `EXTAPI-197 <https://jira.onap.org/browse/EXTAPI-197>`_ - Bad hostname while registering on MSB
 137 - `EXTAPI-222 <https://jira.onap.org/browse/EXTAPI-222>`_ - Add support for HTTPS
 138 - `EXTAPI-249 <https://jira.onap.org/browse/EXTAPI-249>`_ - Change to oom dockers causing permissions failing when tosca parsing
 139
 140 EXTAPI-249 has limited impact on BBS use case:
 141 GET /serviceSpecification{id}
 142 returns empty serviceSpecCharacteristic.
 143
 144 **Security Notes**
 145
 146 *Fixed Security Issues*
 147
 148 NBI has been improved to reduce signs of vulnerabilities,
 149 especially by migrating from Springboot 1.x to Springboot 2 and using ONAP Parent pom.xml
 150
 151 *Known Security Issues*
 152
 153 - `OJSI-136 <https://jira.onap.org/browse/OJSI-136>`_ - In default deployment EXTAPI (nbi) exposes HTTP port 30274 outside of cluster.
 154    NBI exposes non TLS API endpoint on port 30274, meaning full plain text exchange with NBI API.
 155    TLS configuration, with ONAP Root CA signed certificate will be proposed in El Alto.
 156
 157    As a workaround it is quite easy to add HTTPS support to NBI by configuring SSL and activating strict https.
 158    Presuming you have a valid JKS keystore, with private key and a signed certificate:
 159
 160    ::
 161
 162        src/main/resources/application.properties
 163
 164    ::
 165
 166        # tls/ssl
 167        server.ssl.key-store-type=JKS
 168        server.ssl.key-store=classpath:certificate/yourkeystore.jks
 169        server.ssl.key-store-password=password
 170        server.ssl.key-alias=youralias
 171
 172        # disable http and activate https
 173        security.require-ssl=true
 174
 175 *Known Vulnerabilities in Used Modules*
 176
 177 - `Dublin Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=51282484>`_
 178
 179 Quick Links:
 180
 181 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 182
 183 **Upgrade Notes**
 184
 185 API is a new MAJOR v4 version due to the deletion of the 'hasStarted' attribute from getServiceById response
 186 GET /service/{id}
 187
 188 So don't forget to use this new path:
 189
 190 /nbi/api/v4
 191
 192 before:
 193
 194 /nbi/api/v3
 195
 196 **Deprecation Notes**
 197
 198 API v3 is deprecated
 199
 200 **Other**
 201
 202 ===========
 203
 204 Version: 3.0.2
 205 --------------
 206
 207 :Release Date: 2019-01-31
 208
 209 Part of Casablanca Maintenance Release tag - 3.0.1 January 31st, 2019
 210
 211 **Fix**
 212
 213 - `EXTAPI-164 <https://jira.onap.org/browse/EXTAPI-164>`_ - Start up failed without msb
 214 - `EXTAPI-172 <https://jira.onap.org/browse/EXTAPI-172>`_ - Multiple service orders in a single request
 215
 216 Detail of features described in the readTheDoc documentation.
 217
 218 **Known Issues**
 219
 220 No new issues
 221
 222 **Security Notes**
 223
 224 - `Casablanca Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45310585>`_
 225
 226 Quick Links:
 227
 228 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 229
 230
 231 https://wiki.onap.org/pages/viewpage.action?pageId=51282484
 232
 233 ===========
 234
 235 Version: 3.0.1
 236 --------------
 237
 238 :Release Date: 2018-11-30
 239
 240 **New Features**
 241
 242 Main features are:
 243
 244 - `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API
 245 - `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC
 246 - `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API
 247 - `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
 248 - `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
 249 - `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
 250 - `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Add support for progress percentage on ServiceOrder tracking
 251
 252 Detail of features described in the readTheDoc documentation.
 253
 254 **Known Issues**
 255
 256 No new issue (see Beijing ones)
 257
 258 **Security Notes**
 259
 260 - `Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45301150>`_
 261
 262 Quick Links:
 263
 264 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 265
 266 **Upgrade Notes**
 267
 268 No upgrade available from Beijing
 269
 270 **Deprecation Notes**
 271
 272 NA
 273
 274 **Other**
 275
 276 ===========
 277
 278 Version: 1.0.0
 279 --------------
 280
 281 :Release Date: 2018-06-07
 282
 283 **New Features**
 284
 285 Main features are:
 286
 287 - `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
 288 - `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
 289 - `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
 290
 291 Detail of features described in the readTheDoc documentation.
 292
 293 **Bug Fixes**
 294
 295 Not applicable - This is an initial release
 296
 297 **Known Issues**
 298
 299 For service catalog:
 300
 301 - Find criteria are limited
 302
 303 For service inventory:
 304
 305 - Customer information must be passed to get complete service representation.
 306 - Find criteria are limited.
 307
 308 For service order:
 309
 310 - ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change).
 311 - Only service level request is performed.
 312 - No request for VNF/VF and no call to SDNC.
 313 - `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue).
 314 - Only active service state is considered to add a service.
 315
 316 Detail of limitations described in the readTheDoc documentation.
 317
 318 **Security Notes**
 319
 320 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>`_.
 321 Authentication management and Data Access rights have not been implemented.
 322
 323 Quick Links:
 324
 325 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 326 - `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_
 327 - `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_
 328
 329 **Upgrade Notes**
 330
 331 Not applicable - This is an initial release
 332
 333 **Deprecation Notes**
 334
 335 Not applicable - This is an initial release
 336
 337 **Other**
 338
 339 ===========
 340
 341 End of Release Notes