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