1 .. SPDX-License-Identifier: CC-BY-4.0
2 .. Copyright 2019 ORANGE
11 :Release Date: 2020-11-16
13 Guilin Release tag - 7.0.2
17 - `EXTAPI-510 <https://jira.onap.org/browse/EXTAPI-510>`_ - 1 NBI pod has no limit
18 - `EXTAPI-509 <https://jira.onap.org/browse/EXTAPI-509>`_ - NBI has root pods
19 - `EXTAPI-197 <https://jira.onap.org/browse/EXTAPI-197>`_ - MSB registration
21 Detail of NBI features for Guilin are described in the readTheDoc documentation.
23 https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/index.html#master-index
31 Updates may to External API pods security are per TSC must have list
35 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
39 No major API changes. The API Major version is still 4.
45 :Release Date: 2020-06-04
47 Frankfurt Release tag - 6.0.3
51 - `OJSI-136 <https://jira.onap.org/browse/OJSI-136>`_ - In default deployment EXTAPI (nbi) exposes HTTP port 30274 outside of cluster.
52 - `EXTAPI-347 <https://jira.onap.org/browse/EXTAPI-347>`_ - Move to mariadb galera instead of mariadb
53 - `EXTAPI-222 <https://jira.onap.org/browse/EXTAPI-222>`_ - Add support for HTTPS with AAF artefacts
54 - `EXTAPI-294 <https://jira.onap.org/browse/EXTAPI-294>`_ - Add support for Service Orders using new "Object" type
55 - `EXTAPI-304 <https://jira.onap.org/browse/EXTAPI-304>`_ - Update SO request to use GR_API instead of VNF_API
56 - `EXTAPI-342 <https://jira.onap.org/browse/EXTAPI-342>`_ - NBI to SO: new URL and new Header params
57 - `EXTAPI-343 <https://jira.onap.org/browse/EXTAPI-343>`_ - NBI to SO: cloudowner value to be taken from application.properties
58 - `EXTAPI-258 <https://jira.onap.org/browse/EXTAPI-258>`_ - Identify whether the Service is of A-la-carte or macro type
59 - `EXTAPI-370 <https://jira.onap.org/browse/EXTAPI-370>`_ - Java 11 & oparent 3.0.0-SNAPSHOT
60 - `EXTAPI-378 <https://jira.onap.org/browse/EXTAPI-378>`_ - Update swagger based on spectral
61 - `EXTAPI-384 <https://jira.onap.org/browse/EXTAPI-384>`_ - SECCOM Java 11 migration from v8 [REQ-219] in NBI
62 - `EXTAPI-397 <https://jira.onap.org/browse/EXTAPI-397>`_ - Update Service Order Swagger to align to ONAP Style Guidelines
63 - `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
64 - `EXTAPI-400 <https://jira.onap.org/browse/EXTAPI-400>`_ - Migrate and Fix sonarcloud code coverage issue
65 - `EXTAPI-401 <https://jira.onap.org/browse/EXTAPI-401>`_ - remove sonar.jacoco.reportMissing.force.zero
66 - `EXTAPI-415 <https://jira.onap.org/browse/EXTAPI-415>`_ - Configure NBI with http xor https support, using basic spring capabilities
67 - `EXTAPI-417 <https://jira.onap.org/browse/EXTAPI-417>`_ - Support http local docker and https OOM via Env Variable
68 - `EXTAPI-423 <https://jira.onap.org/browse/EXTAPI-423>`_ - Check for CST template is case sensitive
69 - `EXTAPI-424 <https://jira.onap.org/browse/EXTAPI-424>`_ - Public HTTP port open
70 - `EXTAPI-427 <https://jira.onap.org/browse/EXTAPI-427>`_ - DMaap https port enable
72 Detail of NBI features are described in the readTheDoc documentation.
74 https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/index.html
83 In the Frankfurt release, External API has been updated to expose a https interface via OOM installations, in response to OJSI-136.
84 NBI has also upgraded to Java 11, using the base registry.gitlab.com/onap-integration/docker/onap-java image.
88 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
92 No major API changes. The API Major version is still 4.
96 Frankfurt API version is 4.1.0 i.e. Minor API changes only, as most changes are related to security updates. No new APIs.
97 Swagger changes are mainly in the use of additional markdown for API understanding and conformance to ONAP API Swagger Style Guidelines
98 https://wiki.onap.org/pages/viewpage.action?pageId=71834147
103 :Release Date: 2019-09-06
105 El Alto Release tag - 5.0.1
109 - `EXTAPI-248 <https://jira.onap.org/browse/EXTAPI-248>`_ - ExtAPI should not be polling SDC-DISTR-NOTIF-TOPIC-AUTO without authenticating
110 - `EXTAPI-249 <https://jira.onap.org/browse/EXTAPI-249>`_ - Change to oom dockers causing permissions failing when tosca parsing
111 - `EXTAPI-287 <https://jira.onap.org/browse/EXTAPI-287>`_ - NBI to SDC connectivity health checks fail
112 - `EXTAPI-305 <https://jira.onap.org/browse/EXTAPI-305>`_ - No Need for "ReadWriteMany" access on storage when deploying on Kubernetes
114 Detail of features described in the readTheDoc documentation.
116 https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/index.html
125 - Same as Dublin 4.0.0
129 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
133 No major API change. The API Major version is still 4.
137 El Alto API version is 4.0.1 i.e. Patch only
142 :Release Date: 2019-05-30
144 New major version v4 for the API, see Upgrade Notes
146 Dedicated Postman collection can be found in the integration project see `test/postman <https://git.onap.org/integration/tree/test/postman?h=dublin>`_
148 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.
152 Main new features are supports of
154 - `BroadBand Service Use Case ( BBS ) <https://wiki.onap.org/pages/viewpage.action?pageId=45297636>`_
155 - `Cross Domain and Cross Layer VPN ( CCVPN ) <https://wiki.onap.org/display/DW/CCVPN%28Cross+Domain+and+Cross+Layer+VPN%29+USE+CASE>`_
157 Main functional changes for BBS:
159 - `EXTAPI-98 <https://jira.onap.org/browse/EXTAPI-98>`_ - Service inventory notification`
160 - `EXTAPI-161 <https://jira.onap.org/browse/EXTAPI-161>`_ - New service specificationInputSchemas operation`
162 Main functional change for CCVPN
164 - `EXTAPI-182 <https://jira.onap.org/browse/EXTAPI-182>`_ - Create SO -> ExtAPI interface`
166 Many other changes and improvement are listed in JIRA:
168 - `All Dublin issues <https://jira.onap.org/issues/?filter=11786>`_
172 - `EXTAPI-197 <https://jira.onap.org/browse/EXTAPI-197>`_ - Bad hostname while registering on MSB
173 - `EXTAPI-222 <https://jira.onap.org/browse/EXTAPI-222>`_ - Add support for HTTPS
174 - `EXTAPI-249 <https://jira.onap.org/browse/EXTAPI-249>`_ - Change to oom dockers causing permissions failing when tosca parsing
176 EXTAPI-249 has limited impact on BBS use case:
177 GET /serviceSpecification{id}
178 returns empty serviceSpecCharacteristic.
182 *Fixed Security Issues*
184 NBI has been improved to reduce signs of vulnerabilities,
185 especially by migrating from Springboot 1.x to Springboot 2 and using ONAP Parent pom.xml
187 *Known Security Issues*
189 - `OJSI-136 <https://jira.onap.org/browse/OJSI-136>`_ - In default deployment EXTAPI (nbi) exposes HTTP port 30274 outside of cluster.
190 NBI exposes non TLS API endpoint on port 30274, meaning full plain text exchange with NBI API.
191 TLS configuration, with ONAP Root CA signed certificate will be proposed in El Alto.
193 As a workaround it is quite easy to add HTTPS support to NBI by configuring SSL and activating strict https.
194 Presuming you have a valid JKS keystore, with private key and a signed certificate:
198 src/main/resources/application.properties
203 server.ssl.key-store-type=JKS
204 server.ssl.key-store=classpath:certificate/yourkeystore.jks
205 server.ssl.key-store-password=password
206 server.ssl.key-alias=youralias
208 # disable http and activate https
209 security.require-ssl=true
211 *Known Vulnerabilities in Used Modules*
213 - `Dublin Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=51282484>`_
217 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
221 API is a new MAJOR v4 version due to the deletion of the 'hasStarted' attribute from getServiceById response
224 So don't forget to use this new path:
232 **Deprecation Notes**
243 :Release Date: 2019-01-31
245 Part of Casablanca Maintenance Release tag - 3.0.1 January 31st, 2019
249 - `EXTAPI-164 <https://jira.onap.org/browse/EXTAPI-164>`_ - Start up failed without msb
250 - `EXTAPI-172 <https://jira.onap.org/browse/EXTAPI-172>`_ - Multiple service orders in a single request
252 Detail of features described in the readTheDoc documentation.
260 - `Casablanca Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45310585>`_
264 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
267 https://wiki.onap.org/pages/viewpage.action?pageId=51282484
274 :Release Date: 2018-11-30
280 - `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API
281 - `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC
282 - `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API
283 - `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
284 - `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
285 - `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
286 - `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Add support for progress percentage on ServiceOrder tracking
288 Detail of features described in the readTheDoc documentation.
292 No new issue (see Beijing ones)
296 - `Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45301150>`_
300 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
304 No upgrade available from Beijing
306 **Deprecation Notes**
317 :Release Date: 2018-06-07
323 - `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
324 - `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
325 - `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
327 Detail of features described in the readTheDoc documentation.
331 Not applicable - This is an initial release
337 - Find criteria are limited
339 For service inventory:
341 - Customer information must be passed to get complete service representation.
342 - Find criteria are limited.
346 - ServiceOrder will manage only 'add' and 'delete' operation (no change).
347 - Only service level request is performed.
348 - No request for VNF/VF and no call to SDNC.
349 - `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue).
350 - Only active service state is considered to add a service.
352 Detail of limitations described in the readTheDoc documentation.
356 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>`_.
357 Authentication management and Data Access rights have not been implemented.
361 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
362 - `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_
363 - `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_
367 Not applicable - This is an initial release
369 **Deprecation Notes**
371 Not applicable - This is an initial release