docs/releasenotes/releasenotes.rst

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