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