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