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