docs/releasenotes/releasenotes.rst

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