Add master index tag
[aai/aai-common.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
4 .. _release_notes:
5
6
7 AAI Release Notes
8 ==================
9
10 Abstract
11 ========
12
13 This document provides release notes for the Active and Available Inventory Project's Frankfurt Release
14
15 Release Data
16 ============
17
18 Version: 6.0.0
19 --------------
20
21 :Release Date: 2020-06-04 (TBD)
22
23 New Features
24 ------------
25
26 The R6 Frankfurt release of ONAP includes updates to both use cases and non-functional requirements.  AAI is serving v19 as the latest version of the REST APIs, and has support for v16 (Dublin and El Alto).
27
28 - Implemented new parent POM under org.onap.aai.aai-common.aai-parent for simplified management of 3rd party dependencies
29 - Upgrade to spring-boot 2 (partially complete)
30 - Model updates and edge rules changes in support of the following use cases:
31   * CCVPN for SOTN NNI
32   * 5G Network Slicing
33   * Multi-Domain Optical Network Services
34   * PNF enhancements
35 - Papyrus XMI UML files for run-time data model reverse engineering
36 - Integration with sonarcloud
37 - All containers run as non-root user
38
39 champ, spike, and gizmo are deprecated and removed from the helm chart. This will be the last release where aai manages its own helm chart, in R7 Guilin and beyond, the aai/oom submodule will be merged back into the oom project.
40
41 Known Limitations, Issues, and Workarounds
42 ==========================================
43
44 Known Issues
45 ------------
46
47 * `AAI-2766 <https://jira.onap.org/browse/AAI-2766>`_ - AAI data-router cannot communicate with DMaaP message router service
48 * `AAI-2905 <https://jira.onap.org/browse/AAI-2905>`_ - AAI sparky cannot communicate with portal due to certificate issue, might be related to https://jira.onap.org/browse/PORTAL-875
49
50 The AAI sub-project External System Registry (ESR) is re-using elalto containers.  The integration team has helped ESR to meet security requirements for Frankfurt, and the AAI is grateful for the contribution.
51
52 Workarounds
53 -----------
54
55 Roles for sparky are loaded into AAF by default, so previous workaround is no longer required.  However, the pods cannot resolve portal.api.simpledemo.onap.org anymore, so it's necessary to add an entry to /etc/hosts in the sparky-be pod.  This will get around the "unknown host" issue, but then it's leads to AAI-2905, where AAI cannot get the roles from Portal due to the issue with the AAF auto-created certificate.
56
57 The community has been unable to make data-router communicate with DMaaP, we welcome contributors who can help resurrect this service, or it will be deprecated in Guilin.
58
59 References
60 ==========
61
62 Quick links:
63
64 - `AAI project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
65 - `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
66
67 For more information on the ONAP Frankfurt release, please see:
68  
69 #. `ONAP Home Page`_
70 #. `ONAP Documentation`_
71 #. `ONAP Release Downloads`_
72 #. `ONAP Wiki Page`_
73  
74 .. _`ONAP Home Page`: https://www.onap.org
75 .. _`ONAP Wiki Page`: https://wiki.onap.org
76 .. _`ONAP Documentation`: https://docs.onap.org
77 .. _`ONAP Release Downloads`: https://git.onap.org
78
79 Version: 5.0.2
80 --------------
81 :Release Date: 2019-10-03
82
83 **New Features**
84
85 The R5 El Alto release of ONAP is a maintenance release, focusing on
86 deployability, technical debt, and footprint opimization.
87
88 AAI focused on converting all of our microservices to Alpine, created
89 common images for users to select either Alpine or Ubuntu, and reduced
90 the number of microservices that is started by default for the
91 demo. We updated to newer versions of spring boot - we are in the
92 process of moving to spring-boot 2, but many of the microservices are
93 still running 1.5.21.  We updated to JanusGraph 0.2.3, which is a
94 seamless upgrade from 0.2.0 which was used in Dublin.
95
96 Users who would like to further reduce the AAI footprint can update the
97 aai/oom helm charts.
98
99 To re-enable the services that have been disabled by default, update 
100 to "enabled: true" in aai/oom/values.yaml:
101
102  .. code-block:: bash
103
104     aai-champ:
105         enabled: true
106     aai-gizmo:
107         enabled: true
108     aai-spike:
109         enabled: true
110
111 To disable other components that are not critical to the Integration
112 use cases (vFw, vLB, vDNS, etc), add "enabled: false" in
113 aai/oom/values.yaml for each of the following services:
114
115  .. code-block:: bash
116
117     aai-data-router:
118         enabled: false
119     aai-search-data:
120         enabled: false
121     aai-elasticsearch: 
122         enabled: false
123     aai-sparky-fe: 
124         enabled: false
125
126 *Known Vulnerabilities in Used Modules*
127
128 AAI code has been formally scanned during build time using NexusIQ and
129 all Critical vulnerabilities have been addressed, items that remain
130 open have been assessed for risk and determined to be false
131 positive. The AAI open Critical security vulnerabilities and their
132 risk assessment have been documented as part of the linkTBD
133
134 **Known Issues**
135
136 The AAI UI is now integrated with Portal and AAF.  However, the AAF
137 default boostrap does not include a role that is necessary the demo
138 user to access the AAI UI.
139
140 Run the following as a workaround, adjust the URL and credentials
141 according to your environment. The user in CRED must be able to update
142 the org.onap.aai namespace.  The following example has been tested from
143 inside the AAI resources pod.
144
145  .. code-block:: bash
146
147     URL='https://aaf-service.onap:8100'
148     CRED='aai@aai.onap.org:demo123456!'
149
150     curl -v -k -u "$CRED" -H "Content-Type: application/RoleRequest+json" $URL/authz/role -d '{"name":"org.onap.aai.aaiui"}'
151
152     curl -v -k -u "$CRED" -H "Content-Type: application/UserRoleRequest+json" $URL/authz/userRole -d '{ "user":"demo@people.osaaf.org", "role":"org.onap.aai.aaiui" }'
153
154 Frankfurt will include the role and role assignment in the
155 default bootstrap data (being tracked under `AAI-2475 <https://jira.onap.org/browse/AAI-2475>`__)
156
157 - `AAI-2606 <https://jira.onap.org/browse/AAI-2606>`_ Schema-service entity description is not available
158
159 - `AAI-2457 <https://jira.onap.org/browse/AAI-2457>`_ Inconsistent error messages when getting AAI resources
160
161 - `AAI-2457 <https://jira.onap.org/browse/AAI-2457>`_ Inconsistent error messages when getting AAI resources
162
163 - `AAI-2092 <https://jira.onap.org/browse/AAI-2092>`_ aai-resources does excessive amounts of logging
164
165 - `AAI-2082 <https://jira.onap.org/browse/AAI-2082>`_ aai-resources gives incorrect output when aai-cassandra has shutdown with failure
166
167 Quick Links:
168
169 - `Active and Available Inventory project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
170 - `R5 Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
171 - `R5 Project Vulnerability Review Table for AAI <https://wiki.onap.org/pages/viewpage.action?pageId=64003431>`_
172
173
174 Version: 1.4.0
175 --------------
176
177 :Release Date: 2019-06-08
178
179 **New Features**
180
181 The R4 Dublin release of ONAP is a balanced release, focusing on
182 platform maturity and deployablity while also bringing in significant
183 new features and use cases . AAI continued to leverage oom and
184 kubernetes, and added new data types in support of multiple R4 use
185 cases.  AAI added a new schema service which moves AAI closer to being
186 more model-driven and flexible.
187
188 AAI is more model driven in Casablanca, which means it dynamically
189 operationalize new and updated models at run-time, with minimal
190 downtime and coding, so that the latest service and resource models
191 can be delivered quickly. To do this, AAI must update its internal
192 model, external API and behavior to respond to change to service and
193 resource models, including schema changes. The schema service provides
194 ONAP users the ability to quickly change the AAI data model without
195 re-building key microservices.
196
197 AAI delivered 55%+ test coverage on all Java-based repos.
198
199 See `AAI-1779 <https://jira.onap.org/browse/AAI-1779>`__ for details
200 on the schema updates in R4.
201
202 Some AAI services can be configured to leverage the ONAP Pluggable
203 Security Sidecar proof of concept (disabled by default, see the charts
204 under aai/oom for more details).
205
206 AAI now manages its own helm charts. See `aai/oom <https://gerrit.onap.org/r/admin/repos/aai/oom>`__
207
208 **Known Issues**
209
210 The AAI UI is now integrated with Portal and AAF.  However, the AAF
211 default boostrap does not include a role that is necessary the demo
212 user to access the AAI UI.
213
214 Run the following as a workaround, adjust the URL and credentials
215 according to your environment. The user in CRED must be able to update
216 the org.onap.aai namespace.  The following example has been tested from
217 inside the AAI resources pod.
218
219  .. code-block:: bash
220
221     URL='https://aaf-service.onap:8100'
222     CRED='aai@aai.onap.org:demo123456!'
223
224     curl -v -k -u "$CRED" -H "Content-Type: application/RoleRequest+json" $URL/authz/role -d '{"name":"org.onap.aai.aaiui"}'
225
226     curl -v -k -u "$CRED" -H "Content-Type: application/UserRoleRequest+json" $URL/authz/userRole -d '{ "user":"demo@people.osaaf.org", "role":"org.onap.aai.aaiui" }'
227
228 Future releases will include the role and role assignment in the
229 default bootstrap data (being tracked under `AAI-2475 <https://jira.onap.org/browse/AAI-2475>`__)
230
231
232 **Security Notes**
233
234 *Fixed Security Issues*
235
236 - `OJSI-114 <https://jira.onap.org/browse/OJSI-114>`_ In default deployment AAI (aai) exposes HTTP port 30232 outside of cluster.
237
238 *Known Security Issues*
239
240 *Known Vulnerabilities in Used Modules*
241
242 AAI 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 AAI open Critical security vulnerabilities and their risk assessment have been documented as part of the `R4 project wiki <https://wiki.onap.org/pages/viewpage.action?pageId=64003431>`_.
243
244 Quick Links:
245
246 - `AAI project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
247 - `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
248 - `R4 Project Vulnerability Review Table for AAI <https://wiki.onap.org/pages/viewpage.action?pageId=64003431>`_
249
250
251
252
253 Version: 1.3.2
254 --------------
255
256 :Release Date: 2019-03-31
257
258 **Updates**
259
260 AAI demo certificates were going to expire before Dublin release, so they've been refreshed to last until 2020.
261
262 - `AAI-2282 <https://jira.onap.org/browse/AAI-2282>`_ Update certifcate for Casablanca 3.0.2
263
264 Version: 1.3.1
265 --------------
266
267 :Release Date: 2019-01-31
268
269 **New Features**
270
271 The Casablanca Maintenance Release provides a number of security and
272 bug fixes. Highlights of the issues corrected in the Casablanca
273 Maintenance Release:
274
275 - `AAI-2047 <https://jira.onap.org/browse/AAI-2047>`_ Make success of createDbSchema job required to proceed in AAI startup
276
277 - `AAI-1923 <https://jira.onap.org/browse/AAI-1923>`_ Problem deleting due to EdgeRules in CCVPN usecase Casablanca
278
279 - `AAI-1776 <https://jira.onap.org/browse/AAI-1776>`_ Champ fails to start
280
281 - `AAI-1958 <https://jira.onap.org/browse/AAI-1958>`_ [graphadmin] createDbSchema.sh job loses detailed logfile
282
283 - `AAI-1973 <https://jira.onap.org/browse/AAI-1973>`_ Schema update wiki is out of data of Casablanca
284
285 - `AAI-2058 <https://jira.onap.org/browse/AAI-2058>`_ Upgrade to latest jetty-security
286
287 - `AAI-2076 <https://jira.onap.org/browse/AAI-2076>`_ A&AI healthcheck timeout
288
289 - `AAI-2079 <https://jira.onap.org/browse/AAI-2079>`_ aai-traversal and aai container failure to deploy issues in casablanca 3.0.0-ONAP
290
291 Dependencies were updated in multiple repos to patch security
292 vulnerabilities.
293
294 **Known Issues**
295
296 - `AAI-2090 <https://jira.onap.org/browse/AAI-2090>`_ aai-data-router pod enters CrashLoopBackOff state
297
298 This issue can still present itself if you use the OOM chart which
299 references version 1.3.2 (which is the version specified in the
300 casablanca branch of oom), data-router will not start.  The workaround
301 is to set 1.3.3 in the values.yaml file for data-router, or use the
302 docker-manifest to override.  File is oom/kubernetes/aai/charts/aai-data-router/values.yaml
303
304 Users should pay special attention to `AAI-2064
305 <https://jira.onap.org/browse/AAI-2064>`_ and should consult `this
306 page <https://www.rabbitmq.com/ssl.html>`_ for instructions on how to
307 properly secure it if they are concerned about the issue.
308
309 **Security Notes**
310
311 AAI code has been formally scanned during build time using NexusIQ and
312 all Critical vulnerabilities have been addressed, items that remain
313 open have been assessed for risk and determined to be false
314 positive. The AAI open Critical security vulnerabilities and their
315 risk assessment have been documented as part of the `R3 project wiki
316 <https://wiki.onap.org/pages/viewpage.action?pageId=45307817>`_.
317
318 Quick Links:
319
320 - `AAI main project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
321 - `CMR Vulnerability Review Table for AAI <https://wiki.onap.org/pages/viewpage.action?pageId=45307817>`_
322
323
324 Version: 1.3.0
325 --------------
326
327 :Release Date: 2018-11-30
328
329 **New Features**
330
331 The R3 Casablanca release of ONAP again focuses on platform maturity
332 and deployablity. AAI continued to leverage oom and kubernetes, and
333 added new data types in support of multiple R3 use cases.  AAI added a
334 new schema ingest library which moves AAI closer to being more
335 model-driven and a new microservice called "graphadmin" which provides
336 graph maintenance and configuration facilities.
337
338 AAI is more model driven in Casablanca, which means it dynamically
339 operationalize new and updated models at run-time, with minimal
340 downtime and coding, so that the latest service and resource models
341 can be delivered quickly. To do this, AAI must update its internal
342 model, external API and behavior to respond to change to service and
343 resource models, including schema changes. There are changes required
344 to align on implementation across different ONAP components to provide
345 a more strategic model-driven A&AI implementation. For this release
346 decomposing AAI model/schema artifacts (OXM/XSD) into a more granular
347 approach better enables extensibility and support logical subdivision
348 of models.
349
350 AAI added support fo the Cross Domain and Carrier Layer VPN use case
351 by adding new object types, models, and edge rules.
352
353 AAI delivered 50%+ test coverage on all Java-based repos.
354
355 Added support Support for SR-IOV.
356
357 Authentication and Authorization is performed using AAF with the CADI
358 framework. We use basic authentication with RBAC (Role Based Access
359 Control) to secure the AAI REST APIs.
360
361 AAI added automation support for orchestrating SR-IOV Provider
362 Networks that are compatible with the Network Cloud 1.0 infrastructure
363 solution based on standard SR-IOV. Allow for standard SR-IOV Provider
364 Networks to be defined with a set of one or more VLAN associations.
365
366 AAI added suport to allow clients to specify the format on GET
367 operations in the resources micoservices to output like the custom
368 query API does.
369
370 Added support for VLAN tagging.
371
372 **Known Issues**
373
374 Please find at this link the list of issues that will be fixed in the `Casablanca Maintenance Release <https://jira.onap.org/issues/?jql=fixVersion%20%3D%20%22Casablanca%20Maintenance%20Release%22%20and%20type%20%3D%20Bug%20and%20project%20%3D%20%22Active%20and%20Available%20Inventory%22>`_
375
376 **Security Notes**
377
378 AAI 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 AAI open Critical security vulnerabilities and their risk assessment have been documented as part of the `R2 project wiki <https://wiki.onap.org/pages/viewpage.action?pageId=45307817>`_.
379
380 Quick Links:
381
382 - `AAI project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
383 - `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
384 - `R3 Project Vulnerability Review Table for AAI <https://wiki.onap.org/pages/viewpage.action?pageId=45307817>`_
385
386
387 Version: 1.2.0
388 --------------
389
390 :Release Date: 2018-06-07
391
392 **New Features**
393
394 The R2 Beijing release of ONAP focuses on platform maturity - to that
395 end, AAI has switched from Titan on hbase to JanusGraph on a
396 multi-replica cassandra deployment.  We have added several
397 microservices which will be fully operational in R3 Casablanca.
398 Another significant change in R2 is that we converted our
399 Microservices from ASJC 2 to Springboot 1.5.  AAI provides
400 configurations for orchestration via HEAT or via OOM / kubernetes for
401 scaling and resiliency.
402
403 AAI added champ, a graph abstraction microservice, and Gizmo, a new
404 way to perform CRUD operations on the graph in a more atomic way that
405 exposes more of the underlying graph infrastructure.  Babel is a new
406 microservice that does TOSCA model translation on behalf of model
407 loader.  Event client provides an abstraction for dmaap events.
408
409 ONAP AAI R2 includes the following components:
410
411 - AAI Data Management
412 - Resources (CRUD operations)
413 - Traversal (Advanced search operations)
414 - Data Router (Route/persist AAI event data for consumption by the UI)
415 - Model Loader (Obtains SDC artifacts and loads them into the A&AI Resources service for storage)
416 - Search Data Service (Abstraction layer for searchengine, supporting queries and updates)
417 - Babel (TOSCA translation for model-loader)
418 - Event-client (DMaaP abstraction
419 - Champ (Graph abstraction microservice)
420 - Applications
421 - Sparky (AAI User Interface)
422
423 Source code of AAI is released under the following repositories at https://gerrit.onap.org
424
425 - aai/aai-common
426 - aai/event-client
427 - aai/babel
428 - aai/champ
429 - aai/data-router
430 - aai/esr-gui
431 - aai/esr-server
432 - aai/gizmo
433 - aai/logging-service
434 - aai/model-loader
435 - aai/resources
436 - aai/rest-client
437 - aai/router-core
438 - aai/search-data-service
439 - aai/sparky-be
440 - aai/sparky-fe
441 - aai/test-config
442 - aai/traversal
443
444 **Epic**
445
446 - `AAI-16 <https://jira.onap.org/browse/AAI-16>`_ A&AI Platform Deployment
447
448 - `AAI-17 <https://jira.onap.org/browse/AAI-17>`_ Seed code stabilization
449
450 - `AAI-21 <https://jira.onap.org/browse/AAI-21>`_ Gizmo
451
452 - `AAI-24 <https://jira.onap.org/browse/AAI-24>`_ Move to Active Open Source Graph Database
453
454 - `AAI-38 <https://jira.onap.org/browse/AAI-38>`_ AAI Microservice to generate AAI model XML
455
456 - `AAI-280 <https://jira.onap.org/browse/AAI-280>`_ This epic groups together the various requests for making AAI more configurable
457
458 - `AAI-466 <https://jira.onap.org/browse/AAI-466>`_ Beijing R2 AAI Schema Updates
459
460 - `AAI-680 <https://jira.onap.org/browse/AAI-680>`_ HPA Use Case Support in AAI
461
462 - `AAI-681 <https://jira.onap.org/browse/AAI-681>`_ Change Management Use Case Support in AAI
463
464 - `AAI-682 <https://jira.onap.org/browse/AAI-682>`_ Scale Out Use Case Support in AAI
465
466 - `AAI-769 <https://jira.onap.org/browse/AAI-769>`_ Required updates to the v13 REST API
467
468 **Bug Fixes**
469
470 - `AAI-129 <https://jira.onap.org/browse/AAI-129>`_ RestClientBuilder SSL protocol should be configurable
471
472 - `AAI-131 <https://jira.onap.org/browse/AAI-131>`_ Model-Loader service of A&AI has it's Log Provider Configuration File sealed inside the WAR
473
474 - `AAI-175 <https://jira.onap.org/browse/AAI-175>`_ aai core service of A&AI has it's Log Provider Configuration File configurable from startup.sh
475
476 - `AAI-295 <https://jira.onap.org/browse/AAI-295>`_ ChampDAO tests failing in gizmo
477
478 - `AAI-460 <https://jira.onap.org/browse/AAI-460>`_ vm1-aai-inst1 aai-resources fails to start
479
480 - `AAI-463 <https://jira.onap.org/browse/AAI-463>`_ Wrong Error message when we use PUT instead of POST to create the relationship
481
482 - `AAI-521 <https://jira.onap.org/browse/AAI-521>`_ A&AI resources container sporadically hangs on startup
483
484 - `AAI-523 <https://jira.onap.org/browse/AAI-523>`_ Sparky UI does not display RelationshipList nodes
485
486 - `AAI-558 <https://jira.onap.org/browse/AAI-558>`_ aai-resources java daily jenkins job is failing
487
488 - `AAI-559 <https://jira.onap.org/browse/AAI-559>`_ CSIT jobs should use a set of streams, not a list of branches
489
490 - `AAI-561 <https://jira.onap.org/browse/AAI-561>`_ aai-traversal java daily jenkins job is failing
491
492 - `AAI-568 <https://jira.onap.org/browse/AAI-568>`_ aai/logging-api build fails on license.txt not found when run outside of aai/logging-service dir - for root CI builds
493
494 - `AAI-601 <https://jira.onap.org/browse/AAI-601>`_ AAI search-data-service build failing on 1.1 JAX-RS instead of required 2.0 library only on clean Ubuntu 16.04/JDK1.8.0_151
495
496 - `AAI-603 <https://jira.onap.org/browse/AAI-603>`_ Sonar only push to master
497
498 - `AAI-666 <https://jira.onap.org/browse/AAI-666>`_ aai/datarouter startup fails to find logback.xml
499
500 - `AAI-679 <https://jira.onap.org/browse/AAI-679>`_ A&AI UI failed to search service-instance based on service-instance-id
501
502 - `AAI-699 <https://jira.onap.org/browse/AAI-699>`_ SDC Tosca does not generate Groups from resource yaml
503
504 - `AAI-738 <https://jira.onap.org/browse/AAI-738>`_ When register service to MSB, esr-server still will register to MSB automaticly
505
506 - `AAI-788 <https://jira.onap.org/browse/AAI-788>`_ fix the cookie decryption algorithm
507
508 - `AAI-796 <https://jira.onap.org/browse/AAI-796>`_ AAI is logging %PARSER_ERROR instead of REMOTE_USER
509
510 - `AAI-833 <https://jira.onap.org/browse/AAI-833>`_ The url of query vim type from multiCloud is incorrect
511
512 - `AAI-838 <https://jira.onap.org/browse/AAI-838>`_ Add back the properties that got removed
513
514 - `AAI-874 <https://jira.onap.org/browse/AAI-874>`_ Fix the test-config traversal aaiconfig to use proper timeout keys
515
516 - `AAI-948 <https://jira.onap.org/browse/AAI-948>`_ aai-rest-client build fails with non-resolvable parent POM
517
518 - `AAI-961 <https://jira.onap.org/browse/AAI-961>`_ Fix aai-sparky-be-master-aai-docker-java-daily
519
520 - `AAI-985 <https://jira.onap.org/browse/AAI-985>`_ Sparky-be: Change dependency to make use of sparky-fe war file from Beijing version
521
522 - `AAI-987 <https://jira.onap.org/browse/AAI-987>`_ Update ML with the latest changes
523
524 - `AAI-993 <https://jira.onap.org/browse/AAI-993>`_ Champ docker image name incorrect
525
526 - `AAI-994 <https://jira.onap.org/browse/AAI-994>`_ Crud-service (Gizmo) docker tag version is incorrect
527
528 - `AAI-995 <https://jira.onap.org/browse/AAI-995>`_ Gizmo docker image name incorrect
529
530 - `AAI-996 <https://jira.onap.org/browse/AAI-996>`_ Change ML pom file to address build failure problems
531
532 - `AAI-1005 <https://jira.onap.org/browse/AAI-1005>`_ Fix docker-compose-db.yml in test-config
533
534 - `AAI-1006 <https://jira.onap.org/browse/AAI-1006>`_ Babel start script does not set all required properties
535
536 - `AAI-1007 <https://jira.onap.org/browse/AAI-1007>`_ Babel: java.lang.NoClassDefFoundError: com/att/aft/dme2/internal/gson/JsonSyntaxException
537
538 - `AAI-1016 <https://jira.onap.org/browse/AAI-1016>`_ Model-loader: properties files are incorrectly named and have errors
539
540 - `AAI-1017 <https://jira.onap.org/browse/AAI-1017>`_ Fix Champ build - incorrect definition of Java system path
541
542 - `AAI-1018 <https://jira.onap.org/browse/AAI-1018>`_ Model-loader: CONF_INVALID_MSG_BUS_ADDRESS
543
544 - `AAI-1019 <https://jira.onap.org/browse/AAI-1019>`_ aai-resources: does not require username/password after springboot upgrade
545
546 - `AAI-1020 <https://jira.onap.org/browse/AAI-1020>`_ aai-traversal: does not require username/password after springboot upgrade
547
548 - `AAI-1024 <https://jira.onap.org/browse/AAI-1024>`_ Test-config: model-loader MSG_BUS_ADDRESSES not set
549
550 - `AAI-1025 <https://jira.onap.org/browse/AAI-1025>`_ Test-config: traversal updateQueryData.sh fails to update models and queries
551
552 - `AAI-1026 <https://jira.onap.org/browse/AAI-1026>`_ test-config: model-loader is attempting 2-way TLS with AAI
553
554 - `AAI-1027 <https://jira.onap.org/browse/AAI-1027>`_ ModelLoader basic auth failure with aai-resources
555
556 - `AAI-1029 <https://jira.onap.org/browse/AAI-1029>`_ The DOC about ESR installation should be update
557
558 - `AAI-1034 <https://jira.onap.org/browse/AAI-1034>`_ [sparky-be] Portal API Proxy missing from Spring Boot Sparky
559
560 - `AAI-1035 <https://jira.onap.org/browse/AAI-1035>`_ Security: Springboot 1.5.10 has new nexusIQ critical exceptions
561
562 - `AAI-1038 <https://jira.onap.org/browse/AAI-1038>`_ Babel missing .gitreview file
563
564 - `AAI-1049 <https://jira.onap.org/browse/AAI-1049>`_ [Model Loader] - Remove dependency on PowerMockito
565
566 - `AAI-1051 <https://jira.onap.org/browse/AAI-1051>`_ API Spec is specifying v12 in v13 file
567
568 - `AAI-1052 <https://jira.onap.org/browse/AAI-1052>`_ AAI is using -SNAPSHOT artifacts; remove -SNAPSHOT dependencies
569
570 - `AAI-1077 <https://jira.onap.org/browse/AAI-1077>`_ [Babel] master daily build job is not creating an autorelease staging repo
571
572 - `AAI-1082 <https://jira.onap.org/browse/AAI-1082>`_ Champ janus version incompatible with Resources janus version
573
574 - `AAI-1084 <https://jira.onap.org/browse/AAI-1084>`_ POST with PATCH override call is returning 405
575
576 - `AAI-1086 <https://jira.onap.org/browse/AAI-1086>`_ Babel: Compressed files contain proprietary markings
577
578 - `AAI-1088 <https://jira.onap.org/browse/AAI-1088>`_ aai-common: version.properties refers to previous patch release
579
580 - `AAI-1089 <https://jira.onap.org/browse/AAI-1089>`_ haproxy, aai-resources, and aai-traversal using outdated certificate in HEAT config
581
582 - `AAI-1090 <https://jira.onap.org/browse/AAI-1090>`_ v13 does not support External System under cloud region
583
584 - `AAI-1091 <https://jira.onap.org/browse/AAI-1091>`_ ESR fails to register EMS
585
586 - `AAI-1094 <https://jira.onap.org/browse/AAI-1094>`_ Model-loader: failure to negotiate with message router in OOM
587
588 - `AAI-1096 <https://jira.onap.org/browse/AAI-1096>`_ Increase length for field:password in ESR-GUI VIM registration page
589
590 - `AAI-1100 <https://jira.onap.org/browse/AAI-1100>`_ OOM Resources and Traversal Config map missing release
591
592 - `AAI-1101 <https://jira.onap.org/browse/AAI-1101>`_ haproxy, aai-resources, and aai-traversal using outdated certificate in OOM config
593
594 - `AAI-1105 <https://jira.onap.org/browse/AAI-1105>`_ aai-traversal job is failing when trying to start OOM
595
596 - `AAI-1106 <https://jira.onap.org/browse/AAI-1106>`_ aai-resources: scripts do not work properly with spring-boot
597
598 - `AAI-1107 <https://jira.onap.org/browse/AAI-1107>`_ Security: babel and m-l brings in springboot jersey starter, which includes logback 1.1.11
599
600 - `AAI-1108 <https://jira.onap.org/browse/AAI-1108>`_ [Babel] Remove license violations in latest commit.
601
602 - `AAI-1110 <https://jira.onap.org/browse/AAI-1110>`_ Model Loader logback.xml errors
603
604 - `AAI-1111 <https://jira.onap.org/browse/AAI-1111>`_ Update test-config project for Babel
605
606 - `AAI-1113 <https://jira.onap.org/browse/AAI-1113>`_ ESR VIM registration portal: Physical Location Id does not populate any data
607
608 - `AAI-1114 <https://jira.onap.org/browse/AAI-1114>`_ Security: [Champ] add Dockerfile and remove additional AJSC files
609
610 - `AAI-1116 <https://jira.onap.org/browse/AAI-1116>`_ [Gizmo] addressing Security vulnerabilities (Nexus IQ)
611
612 - `AAI-1117 <https://jira.onap.org/browse/AAI-1117>`_ [Champ] addressing Security vulnerabilities (Nexus IQ)
613
614 - `AAI-1118 <https://jira.onap.org/browse/AAI-1118>`_ [Gizmo] upgrade artefacts from aai-common to 1.2.4
615
616 - `AAI-1119 <https://jira.onap.org/browse/AAI-1119>`_ [Champ] Prevent deployment of Champ service jar
617
618 - `AAI-1120 <https://jira.onap.org/browse/AAI-1120>`_ [Gizmo] Fix Jacoco configuration
619
620 - `AAI-1121 <https://jira.onap.org/browse/AAI-1121>`_ Add the default realtime clients
621
622 - `AAI-1123 <https://jira.onap.org/browse/AAI-1123>`_ Babel logback.xml errors
623
624 - `AAI-1124 <https://jira.onap.org/browse/AAI-1124>`_ [router-core] NexusIQ reporting httpclient 4.5 vulnerability
625
626 - `AAI-1125 <https://jira.onap.org/browse/AAI-1125>`_ [data-router] NexusIQ reporting httpclient 4.5 vulnerability
627
628 - `AAI-1126 <https://jira.onap.org/browse/AAI-1126>`_ [Babel] Authorisation mechanism is not functioning
629
630 - `AAI-1127 <https://jira.onap.org/browse/AAI-1127>`_ [sparky-be] doesn't release artifacts because it is missing the staging plugin
631
632 - `AAI-1132 <https://jira.onap.org/browse/AAI-1132>`_ AAI's OOM server certificate doesn't include all k8 names
633
634 - `AAI-1133 <https://jira.onap.org/browse/AAI-1133>`_ AAI's haproxy server config doesn't include all k8 names
635
636 - `AAI-1134 <https://jira.onap.org/browse/AAI-1134>`_ OOF not defined in AAI realm properties files
637
638 - `AAI-1135 <https://jira.onap.org/browse/AAI-1135>`_ [traversal] closed loop named-query is missing property-collect-list
639
640 - `AAI-1136 <https://jira.onap.org/browse/AAI-1136>`_ Babel doesnt start in HEAT due to log directory permissions
641
642 - `AAI-1138 <https://jira.onap.org/browse/AAI-1138>`_ [Champ] Bump to 1.2.1-SNAPSHOT and 1.2.1 in version.properties
643
644 - `AAI-1139 <https://jira.onap.org/browse/AAI-1139>`_ [resources and traversal] do not release artifacts properly
645
646 - `AAI-1141 <https://jira.onap.org/browse/AAI-1141>`_ [champ] duplicate dependency in pom.xml
647
648 - `AAI-1142 <https://jira.onap.org/browse/AAI-1142>`_ [champ] doesn't create release artifacts
649
650 - `AAI-1143 <https://jira.onap.org/browse/AAI-1143>`_ [resources] createDbSchema.sh tries to add -SNAPSHOT version to classpath
651
652 - `AAI-1144 <https://jira.onap.org/browse/AAI-1144>`_ [oom and test-config] robot-ete is missing from realtime clients list
653
654 - `AAI-1146 <https://jira.onap.org/browse/AAI-1146>`_ [champ] daily build job is failing
655
656 - `AAI-1148 <https://jira.onap.org/browse/AAI-1148>`_ [Model-Loader] Rollback of VNF Images fails
657
658 - `AAI-1151 <https://jira.onap.org/browse/AAI-1151>`_ [Champ & Gizmo] Fix JJB jenkins jobs
659
660 - `AAI-1153 <https://jira.onap.org/browse/AAI-1153>`_ [Champ] Bump to 1.2.2-SNAPSHOT and 1.2.2 in version.properties
661
662 **Known Issues**
663
664 If the either the aai-resources or aai-traversal pod is deleted, haproxy will not automatically detect when the pod is re-instantiated.  As a temporary workaround, you can delete the haproxy pod (the one named "aai", for example, "dev-aai-8794fbff5-clx7d") and when the aai pod restarts the service should operate normally. A proposed fix is here: https://gerrit.onap.org/r/#/c/51075/1 if you want to see how to configure the haproxy service to auto-recover when the IP address of either the aai-resources or aai-traversal pod changes.
665
666 **Security Notes**
667
668 AAI 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 AAI open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25441383>`_.
669
670 Quick Links:
671
672 - `AAI project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
673 - `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
674 - `R2 Project Vulnerability Review Table for AAI <https://wiki.onap.org/pages/viewpage.action?pageId=25441383>`_
675
676 Version: 1.1.1
677 --------------
678
679 :Release Date: 2018-01-18
680
681 **Bug Fixes**
682
683 - `AAI-456 <https://jira.onap.org/browse/AAI-456>`_ AAI named-query for policy not returning extra-properties
684
685 - `AAI-458 <https://jira.onap.org/browse/AAI-458>`_ [aai] ML, Search, DR, and Sparky Jenkins jobs not creating autorelease repo
686
687 - `AAI-459 <https://jira.onap.org/browse/AAI-459>`_ aai-common child pom still depends on openecomp artifacts
688
689 - `AAI-461 <https://jira.onap.org/browse/AAI-461>`_ AAI mS configuration files are using old openecomp params in test-config
690
691 - `AAI-462 <https://jira.onap.org/browse/AAI-462>`_ Fix the resources junit tests broken in windows environment
692
693 - `AAI-558 <https://jira.onap.org/browse/AAI-558>`_ aai-resources java daily jenkins job is failing
694
695 - `AAI-561 <https://jira.onap.org/browse/AAI-561>`_ aai-traversal java daily jenkins job is failing
696
697 - `AAI-566 <https://jira.onap.org/browse/AAI-566>`_ AAI Eclipse build failure - aai-traversal pom as hardcoded 1.8.0_101 jdk.tools version
698
699 - `AAI-621 <https://jira.onap.org/browse/AAI-621>`_ Update the snapshot in test-config for v1.1.1-SNAPSHOT
700
701 Version: 1.1.0
702 --------------
703
704 :Release Date: 2017-11-16
705
706 **New Features**
707
708 Initial release of Active and Available Inventory (AAI) for Open Network Automation Platform (ONAP).  AAI provides ONAP with its logically centralized view of inventory data, taking in updates from orchestrators, controllers, and assurance systems.  AAI provides core REST services.
709
710 ONAP AAI R1 includes the following components:
711
712 - AAI Data Management
713 - Resources (CRUD operations)
714 - Traversal (Advanced search operations)
715 - Data Router (Route/persist AAI event data for consumption by the UI)
716 - Model Loader (Obtains SDC artifacts and loads them into the A&AI Resources service for storage)
717 - Search Data Service (Abstraction layer for searchengine, supporting queries and updates)
718 - Applications
719 - Sparky (AAI User Interface)
720
721 Source code of AAI is released under the following repositories at https://gerrit.onap.org .
722
723 - aai/aai-common
724 - aai/aai-config
725 - aai/aai-data
726 - aai/aai-service
727 - aai/babel
728 - aai/champ
729 - aai/data-router
730 - aai/esr-gui
731 - aai/esr-server
732 - aai/gizmo
733 - aai/logging-service
734 - aai/model-loader
735 - aai/resources
736 - aai/rest-client
737 - aai/router-core
738 - aai/search-data-service
739 - aai/sparky-be
740 - aai/sparky-fe
741 - aai/test-config
742 - aai/traversal
743
744 **Epic**
745
746 - `AAI-17 <https://jira.onap.org/browse/AAI-17>`_ Seed code stabilization
747 - `AAI-20 <https://jira.onap.org/browse/AAI-20>`_ Champ Library
748 - `AAI-22 <https://jira.onap.org/browse/AAI-22>`_ Amsterdam User Case Schema Updates
749 - `AAI-23 <https://jira.onap.org/browse/AAI-23>`_ Model Loader Support for R1
750 - `AAI-58 <https://jira.onap.org/browse/AAI-58>`_ Define and build functional test cases for CSIT
751 - `AAI-72 <https://jira.onap.org/browse/AAI-72>`_ External System Register
752 - `AAI-254 <https://jira.onap.org/browse/AAI-254>`_ Documentation of REST APIs, dev guides, onboarding, etc.
753 - `AAI-280 <https://jira.onap.org/browse/AAI-280>`_ Confguration enhancements
754
755 **Bug Fixes**
756
757 - `AAI-11 <https://jira.onap.org/browse/AAI-11>`_ robot_vm: demo.sh failing - '200' does not match '^(201|412)$' on vanilla openstack
758
759 - `AAI-13 <https://jira.onap.org/browse/AAI-13>`_ VM_init is failing to get sparky
760
761 - `AAI-31 <https://jira.onap.org/browse/AAI-31>`_ Compilation failure in aai-traversal
762
763 - `AAI-48 <https://jira.onap.org/browse/AAI-48>`_ AAI Common REST Client returns an error on a 204 (No Content) server response
764
765 - `AAI-49 <https://jira.onap.org/browse/AAI-49>`_ Health check is failing in DFW 1.1 RS. Connection refused
766
767 - `AAI-62 <https://jira.onap.org/browse/AAI-62>`_ Search Data Service should not implicitly create indexes on document write
768
769 - `AAI-63 <https://jira.onap.org/browse/AAI-63>`_ Data Router must handle Search Service document create failures if index does not exit
770
771 - `AAI-73 <https://jira.onap.org/browse/AAI-73>`_ Sparky sync issues
772
773 - `AAI-76 <https://jira.onap.org/browse/AAI-76>`_ Jenkins stage-site builds failing on resources and traversal
774
775 - `AAI-94 <https://jira.onap.org/browse/AAI-94>`_ AAI Certificate will expire 30 Nov 2017 - fyi
776
777 - `AAI-146 <https://jira.onap.org/browse/AAI-146>`_ Both esr-server and esr-gui Jenkins failed
778
779 - `AAI-192 <https://jira.onap.org/browse/AAI-192>`_ Model Loader depends on httpclient version 4.4.1
780
781 - `AAI-205 <https://jira.onap.org/browse/AAI-205>`_ Having an invalid xml namespace for v11, named-query api returns 500 error, model query return incorrect error message
782
783 - `AAI-206 <https://jira.onap.org/browse/AAI-206>`_ Model based delete is failing
784
785 - `AAI-217 <https://jira.onap.org/browse/AAI-217>`_ Remove internal references from A&AI seed code
786
787 - `AAI-222 <https://jira.onap.org/browse/AAI-222>`_ the version property of esr-server is incorrect
788
789 - `AAI-224 <https://jira.onap.org/browse/AAI-224>`_ aai/esr-gui daily build failed
790
791 - `AAI-225 <https://jira.onap.org/browse/AAI-225>`_ aai/esr-server daily build failed
792
793 - `AAI-265 <https://jira.onap.org/browse/AAI-265>`_ EdgePropertyMap throws NullPointer if edge rule does not include property
794
795 - `AAI-266 <https://jira.onap.org/browse/AAI-266>`_ auth-info edge rule does not include contains-other-v
796
797 - `AAI-273 <https://jira.onap.org/browse/AAI-273>`_ Fix the esr-server setup error issue
798
799 - `AAI-278 <https://jira.onap.org/browse/AAI-278>`_ AAI throws exception about mismatch keys adding esr-system-info to cloud-region
800
801 - `AAI-293 <https://jira.onap.org/browse/AAI-293>`_ Jenkins job failing for aai-sparky-fe-master-release-version-java-daily
802
803 - `AAI-377 <https://jira.onap.org/browse/AAI-377>`_ esr-gui docker build failed
804
805 - `AAI-393 <https://jira.onap.org/browse/AAI-393>`_ The jjb defiend in a error way that cause CSIT build failed.
806
807 - `AAI-398 <https://jira.onap.org/browse/AAI-398>`_ If a cloud-region didn't contain a external system info, there will be an null pointer error
808
809 - `AAI-400 <https://jira.onap.org/browse/AAI-400>`_ Register ServiceTest to microservice
810
811 - `AAI-401 <https://jira.onap.org/browse/AAI-401>`_ Remove DMaaP router duplication
812
813 - `AAI-407 <https://jira.onap.org/browse/AAI-407>`_ There is an error to startup esr-gui docker
814
815 - `AAI-412 <https://jira.onap.org/browse/AAI-412>`_ Replace the type specification in this constructor call with the diamond operator ("<>")
816
817 - `AAI-417 <https://jira.onap.org/browse/AAI-417>`_ Rackspace 20170928 fails to authenticate nexus3 on 10003 during *_init.sh* (sdnc for example)
818
819 - `AAI-420 <https://jira.onap.org/browse/AAI-420>`_ Can not get the MSB address in esr-server
820
821 - `AAI-422 <https://jira.onap.org/browse/AAI-422>`_ The esr-server csit failed
822
823 - `AAI-424 <https://jira.onap.org/browse/AAI-424>`_ The integration catalog is not in use, should be removed
824
825 - `AAI-425 <https://jira.onap.org/browse/AAI-425>`_ Fix the artifact of esr-gui
826
827 - `AAI-426 <https://jira.onap.org/browse/AAI-426>`_ Fix the artifact of esr-server
828
829 - `AAI-431 <https://jira.onap.org/browse/AAI-431>`_ esr-gui files did not contained in webapp of tomcat
830
831 - `AAI-433 <https://jira.onap.org/browse/AAI-433>`_ Failed to pre-load vCPE data to AAI. No response from AAI
832
833 - `AAI-434 <https://jira.onap.org/browse/AAI-434>`_ Can not visit ESR portal with demo deployment
834
835 - `AAI-435 <https://jira.onap.org/browse/AAI-435>`_ default tenant need be input to A&AI while register VIM
836
837 - `AAI-436 <https://jira.onap.org/browse/AAI-436>`_ Call the API from MultiCloud failed
838
839 - `AAI-440 <https://jira.onap.org/browse/AAI-440>`_ The version input box should be changed in a more easy to use when register a VIM
840
841 - `AAI-441 <https://jira.onap.org/browse/AAI-441>`_ Can not input the vendor and version information to EMS, but there is a default data for the two parameter
842
843 - `AAI-442 <https://jira.onap.org/browse/AAI-442>`_ Can't instantiate a service
844
845 - `AAI-444 <https://jira.onap.org/browse/AAI-444>`_ Cannot associate multiple service-instances to PNFs
846
847 - `AAI-446 <https://jira.onap.org/browse/AAI-446>`_ vnf to esr-system-info named-query is missing vnfc
848
849 - `AAI-448 <https://jira.onap.org/browse/AAI-448>`_ Remove snapshot dependencies from aai-common, data-router, and rest-client
850
851 - `AAI-450 <https://jira.onap.org/browse/AAI-450>`_ Named Query needs to be updated to return VNFC Info
852
853 - `AAI-453 <https://jira.onap.org/browse/AAI-453>`_ Fix stage-site jenkins job for aai-common
854
855 - `AAI-454 <https://jira.onap.org/browse/AAI-454>`_ LoggingContext.requestId required NULL handling in aai/aai-common (20170607) - during demo.sh init_customer
856
857 **Known Issues**
858
859 - `AAI-61 <https://jira.onap.org/browse/AAI-61>`_ AAI cleaned up references to OpenECOMP but in order to keep the release stable for R1, the XML namespace still contains openecomp.
860
861 Client systems should use http://org.openecomp.aai.inventory/v11 as the XML namespace for ONAP AAI R1.
862
863 **Security Issues**
864
865 See Common Vulnerabilities and Exposures `CVE <https://cve.mitre.org>`
866
867 ONAP docker images and repos include demo TLS server certificates that are signed by a demo Certificate Authority. DO NOT use the demo certificates in a production environment.
868
869 AAI uses HTTPS Basic Authentication.
870
871 **Upgrade Notes**
872
873 This is an initial release
874
875 **Deprecation Notes**
876
877 AAI Amsterdam provides support for legacy versions of the API, v8 and v11 in this release.  v11 is the latest and preferred version.
878
879 **Other**
880
881 ===========
882
883 End of Release Notes