Merge "Move SDK documentation to RTD"
[dcaegen2.git] / docs / sections / 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 (c) 2017-2020 AT&T Intellectual Property. All rights reserved.
4 .. _release_notes:
5
6
7
8 ==================
9 DCAE Release Notes
10 ==================
11
12 .. contents::
13     :depth: 2
14 ..
15
16
17 ..      ======================================
18 ..      * * *    EL-ALTO  MAINTENANCE  * * *
19 ..      ======================================
20
21
22 Version: 5.0.2
23 ==============
24
25 Abstract
26 ========
27
28 This document provides the release notes for the El-Alto Maintenance release
29
30
31 Summary
32 =======
33
34 This maintenance release is primarily to update expired certificates 
35 from original El-Alto released TLS-init container.
36
37 This patch is not required for Frankfurt release (and beyond) as certificates are dynamically 
38 retrieved from AAF at deployment time for all DCAE components.
39
40 Release Data
41 ============
42
43 +--------------------------------------+--------------------------------------+
44 | **Project**                          | DCAE                                 |
45 |                                      |                                      |
46 +--------------------------------------+--------------------------------------+
47 | **Docker images**                    | onap/org.onap.dcaegen2.deployments   |
48 |                                      |   .tls-init-container:1.0.4          |
49 +--------------------------------------+--------------------------------------+
50 | **Release designation**              | El-Alto  Maintenance Release         |
51 |                                      |                                      |
52 +--------------------------------------+--------------------------------------+
53 | **Release date**                     | 2020/08/24                           |
54 |                                      |                                      |
55 +--------------------------------------+--------------------------------------+
56
57 New features
58 ------------
59
60 None
61
62 **Bug fixes**
63
64 - `DCAEGEN2-2206 <https://jira.onap.org/browse/DCAEGEN2-2206>`_ DCAE TLS Container : Address certificate
65 expiration
66
67 **Known Issues**
68 Same as El-Alto Release
69
70
71
72 ..      ======================================
73 ..      * * *    FRANKFURT  MAINTENANCE  * * *
74 ..      ======================================
75
76
77 Version: 6.0.1
78 ==============
79
80 Abstract
81 ========
82
83 This document provides the release notes for the Frankfurt Maintenance release
84
85
86 Summary
87 =======
88
89 The focus of this release is to correct issues found on Frankfurt release.
90
91 Release Data
92 ============
93
94 +--------------------------------------+--------------------------------------+
95 | **Project**                          | DCAE                                 |
96 |                                      |                                      |
97 +--------------------------------------+--------------------------------------+
98 | **Docker images**                    | onap/org.onap.dcaegen2.services.     |
99 |                                      |   son-handler:2.0.4                  |
100 +--------------------------------------+--------------------------------------+
101 | **Release designation**              | Frankfurt  Maintenance Release 1     |
102 |                                      |                                      |
103 +--------------------------------------+--------------------------------------+
104 | **Release date**                     | 2020/08/17                           |
105 |                                      |                                      |
106 +--------------------------------------+--------------------------------------+
107
108 New features
109 ------------
110
111 None
112
113 **Bug fixes**
114
115 - `DCAEGEN2-2249 <https://jira.onap.org/browse/DCAEGEN2-2249>`_ SON-Handler: Fix networkId issue 
116 while making call to oof
117 - `DCAEGEN2-2216 <https://jira.onap.org/browse/DCAEGEN2-2216>`_ SON-Handler: Change Policy notification 
118  to align with policy component updates
119
120 **Known Issues**
121 Same as Frankfurt Release
122
123
124
125
126 ..      ===========================
127 ..      * * *    FRANKFURT    * * *
128 ..      ===========================
129
130
131 Version: 6.0.0
132 ==============
133
134
135 Abstract
136 --------
137
138 This document provides the release notes for the Frankfurt release.
139
140 Summary
141 -------
142
143 Following DCAE components are available with default ONAP/DCAE installation.
144
145     - Platform components
146
147         - Cloudify Manager (helm chart)
148         - Bootstrap container (helm chart)
149         - Configuration Binding Service (helm chart)
150         - Deployment Handler (helm chart)
151         - Policy Handler (helm chart
152         - Service Change Handler (helm chart)
153         - Inventory API (helm chart)
154         - Dashboard (helm chart)
155
156     - Service components
157
158         - VES Collector
159         - Threshold Crossing Analytics (TCA/CDAP)
160         - HV-VES Collector
161         - PNF-Registration Handler
162         - Docker based Threshold Crossing Analytics (TCA-Gen2)
163         - Holmes Rule Management *
164         - Holmes Engine Management *
165
166     - Additional resources that DCAE utilizes deployed using ONAP common charts:
167     
168         - Postgres Database
169         - Mongo Database
170         - Redis Cluster Database
171         - Consul Cluster 
172
173 Below service components (mS) are available to be deployed on-demand.
174
175         - SNMPTrap Collector
176         - RESTConf Collector
177         - DataFile Collector
178         - PM-Mapper 
179         - BBS-EventProcessor
180         - VES Mapper
181         - Heartbeat mS
182         - SON-Handler
183         - PM-Subscription Handler
184
185     Notes:
186
187         \*  These components are delivered by the Holmes project.
188
189
190
191 Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE platform components are deployed using Helm charts. DCAE service components are deployed using Cloudify blueprints. DCAE provides a Cloudify Manager plugin (k8splugin) that is capable of expanding a Cloudify blueprint node specification for a service component to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
192
193
194 Release Data
195 ------------
196
197 +--------------------------------------+--------------------------------------------------------+
198 | **DCAE Project**                     |                                                        |
199 |                                      |                                                        |
200 +--------------------------------------+--------------------------------------------------------+
201 | **Docker images**                    |Refer :any:`Deliverable <frankfurt_deliverable>`        |
202 |                                      |                                                        |
203 +--------------------------------------+--------------------------------------------------------+
204 | **Release designation**              | 6.0.0 frankfurt                                        |
205 |                                      |                                                        |
206 +--------------------------------------+--------------------------------------------------------+
207 | **Release date**                     | 2020-06-04                                             |
208 |                                      |                                                        |
209 +--------------------------------------+--------------------------------------------------------+
210
211
212 New features
213 ------------
214
215 - DCAE Platform Enhancement
216
217     - Introduction of Microservice and Onboarding Design (MOD) platform 
218     - Policy Notification support for DCAE components
219     - Dynamic AAF certificate creation during component instantiation
220     - Helm chart optimization to control each platform component separate
221     - Dashboard Optimization 
222     - Blueprint generator tool to simplify deployment artifact creation
223    
224
225 - Following new services are delivered this release
226
227     - Event Processors
228     
229         - PM Subscription Handler
230         - DataLake Handlers 
231     - Analytics/RCA
232     
233         - TCA-GEN2
234         
235         - Acumos Adapter (PoC)
236
237 .. _frankfurt_deliverable:
238
239 Deliverables
240 ------------
241
242 Software Deliverables
243
244 .. csv-table::
245    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
246    :widths: auto
247
248    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
249    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
250    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
251    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
252    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
253    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
254    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
255    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
256    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
257    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
258    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
259    "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
260    "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
261    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
262    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
263    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
264    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
265    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
266    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
267    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
268    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
269    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6" 
270    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
271    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
272    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"  
273    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
274    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
275    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
276    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
277    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
278    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
279    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
280    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
281    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
282    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
283    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
284    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
285    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
286    "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
287    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
288         
289
290 Known Limitations, Issues and Workarounds
291 -----------------------------------------
292
293     * Blueprint generator escape char issue (DCAEGEN2-2140)
294     * TCAgen2 Policy configuration support (DCAEGEN2-2198)
295     * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
296
297
298
299 *System Limitations*
300
301 None
302
303 *Known Vulnerabilities*
304
305 None
306
307 *Workarounds*
308
309 Documented under corresponding jira if applicable.
310
311 Security Notes
312 --------------
313
314 *Fixed Security Issues*
315
316     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
317     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
318     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
319     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
320     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
321
322     
323 *Known Security Issues*
324
325         None
326         
327         
328 *Known Vulnerabilities in Used Modules*
329
330         None
331         
332 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
333
334 Test Results
335 ------------
336
337  - `DCAE Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
338  - `DCAE MOD Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
339
340
341 References
342 ----------
343
344 For more information on the ONAP Frankfurt release, please see:
345
346 #. `ONAP Home Page`_
347 #. `ONAP Documentation`_
348 #. `ONAP Release Downloads`_
349 #. `ONAP Wiki Page`_
350
351
352 .. _`ONAP Home Page`: https://www.onap.org
353 .. _`ONAP Wiki Page`: https://wiki.onap.org
354 .. _`ONAP Documentation`: https://docs.onap.org
355 .. _`ONAP Release Downloads`: https://git.onap.org
356
357 Quick Links:
358
359         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
360         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
361
362
363 ..      =========================
364 ..      * * *    EL-ALTO    * * *
365 ..      =========================
366
367
368 Version: 5.0.1
369 ==============
370
371 The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
372
373 Following is summary of updates done for DCAEGEN2
374
375 **Security**
376
377 Following platform components were enabled for HTTPS
378     - ConfigBindingService (CBS)
379       -   CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
380     - Cloudify Manager
381     - InventoryAPI
382     - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
383
384 All components interfacing with platform components were modified to support TLS interface
385
386 **Miscellaneous**
387     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
388     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
389     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
390     - CBS client libraries updated to remove consul service lookup
391     - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
392
393
394
395 With this release, all DCAE platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/DCAE installation.
396     - Platform components
397         - Cloudify Manager (helm chart)
398         - Bootstrap container (helm chart)
399         - Configuration Binding Service (helm chart)
400         - Deployment Handler (helm chart)
401         - Policy Handler (helm chart
402         - Service Change Handler (helm chart)
403         - Inventory API (helm chart)
404         - Dashboard (helm charts)
405     - Service components
406         - VES Collector
407         - SNMP Collector
408         - Threshold Crossing Analytics
409         - HV-VES Collector
410         - PNF-Registration Handler
411         - Holmes Rule Management *
412         - Holmes Engine Management *
413     - Additional resources that DCAE utilizes:
414         - Postgres Database
415         - Redis Cluster Database
416         - Consul Cluster *
417
418     Notes:
419         \*  These components are delivered by external ONAP project.
420
421 DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
422
423     - Collectors
424         - RESTConf collector 
425         - DataFile collector
426     - Event Processors
427         - VES Mapper
428         - 3gpp PM-Mapper
429         - BBS Event processor
430     - Analytics/RCA
431         - SON-Handler
432         - Missing Heartbeat Ms
433
434 - All DCAE components are designed to support platform maturity requirements.
435
436
437 **Source Code**
438
439 Source code of DCAE components are released under the following repositories on gerrit.onap.org; there is no new component introduced for El-Alto Early-drop.
440     - dcaegen2
441     - dcaegen2.analytics.tca
442     - dcaegen2.collectors.snmptrap
443     - dcaegen2.collectors.ves
444     - dcaegen2.collectors.hv-ves
445     - dcaegen2.collectors.datafile
446     - dcaegen2.collectors.restconf
447     - dcaegen2.deployments
448     - dcaegen2.platform.blueprints
449     - dcaegen2.platform.cli
450     - dcaegen2.platform.configbinding
451     - dcaegen2.platform.deployment-handler
452     - dcaegen2.platform.inventory-api
453     - dcaegen2.platform.plugins
454     - dcaegen2.platform.policy-handler
455     - dcaegen2.platform.servicechange-handler
456     - dcaegen2.services.heartbeat
457     - dcaegen2.services.mapper
458     - dcaegen2.services.pm-mapper
459     - dcaegen2.services.prh
460     - dcaegen2.services.son-handler
461     - dcaegen2.services
462     - dcaegen2.services.sdk
463     - dcaegen2.utils
464     - ccsdk.platform.plugins
465     - ccsdk.dashboard
466
467 **Bug Fixes**
468     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
469     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
470
471
472 **Known Issues**
473     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
474
475 **Security Notes**
476
477 *Fixed Security Issues*
478     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
479     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
480     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
481     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
482     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
483
484 *Known Security Issues*
485     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
486     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
487     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
488     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
489     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
490
491 *Known Vulnerabilities in Used Modules*
492
493 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
494
495 Quick Links:
496         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
497
498         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
499
500         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
501
502
503 **Upgrade Notes**
504
505 The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
506     - K8S Bootstrap container:
507        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
508        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
509     - Configuration Binding Service:
510        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
511        - Description: HTTPS support, Image optimization and non-root user
512     - Inventory API
513        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
514        - Description: HTTPS support, container optmization and non-root user
515     - DataFile Collector
516        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
517        - Description : Code optimization, bug fixes, dmaap plugin integration
518     - SON Handler MS
519        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
520        - Description : Image optimization, bug fixes, CBS integration
521     - VES Adapter/Mapper MS
522        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
523        - Description : Image optimization & CBS periodic polling
524     - PRH MS
525        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
526        - Description : Code optimization, bug fixes and SDK alignment
527     - HV-VES MS
528        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
529        - Description : Code optimization, bug fixes and SDK alignment
530
531 Version: 5.0.0
532 ==============
533
534 El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
535
536 Following is summary of updates done for DCAEGEN2
537
538 **Security**
539
540 Following platform components were enabled for HTTPS
541     - ConfigBindingService (CBS)
542       -   CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
543     - Cloudify Manager
544     - InventoryAPI
545
546 All components interfacing with platform components were modified to support TLS interface
547
548 **Miscellaneous**
549     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
550     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
551     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
552     - CBS client libraries updated to remove consul service lookup
553
554
555
556 **Bug Fixes**
557     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
558     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
559
560
561 **Known Issues**
562     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
563
564
565 **Security Notes**
566
567 *Fixed Security Issues*
568
569 *Known Security Issues*
570
571     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
572     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
573     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
574     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
575     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
576     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
577     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
578     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
579     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
580     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
581
582 *Known Vulnerabilities in Used Modules*
583
584 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
585
586 Quick Links:
587         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
588
589         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
590
591         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
592
593
594 **Upgrade Notes**
595
596 The following components are upgraded from Dublin/R4.
597     - Cloudify Manager:
598        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
599        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5. The container was updated to support TLS.
600     - K8S Bootstrap container:
601        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
602        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
603     - Configuration Binding Service:
604        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
605        - Description: HTTPS support, Image optimization and non-root user
606     - Deployment Handler
607        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
608        - Description: Update to node10, uninstall workflow updates
609     - Service Change Handler
610        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
611        - Description: HTTPS inventoryAPI support, container optmization and non-root user
612     - Inventory API
613        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
614        - Description: HTTPS support, container optmization and non-root user
615     - DataFile Collector
616        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
617        - Description : Code optimization, bug fixes, dmaap plugin integration
618     - 3gpp PM-Mapper
619        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
620        - Description: Code optimization, bug fixes, dmaap plugin integration
621
622
623
624 Version: 4.0.0
625 ==============
626
627 :Release Date: 2019-06-06
628
629 **New Features**
630
631 DCAE R4 improves upon previous release with the following new features:
632
633 - DCAE Platform Enhancement
634     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
635     - Support helm chart deployment in DCAE using new Helm cloudify plugin
636     - DCAE Healthcheck enhancement to cover static and dynamic deployments
637     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
638     - Dashboard Integration (UI for deployment/verification)
639     - PolicyHandler Enhancement to support new Policy Lifecycle API’s
640     - Blueprint generator tool to simplify deployment artifact creation
641     - Cloudify Manager resiliency
642
643 - Following new services are delivered with Dublin
644     - Collectors
645         - RESTConf collector 
646     - Event Processors
647         - VES Mapper
648         - 3gpp PM-Mapper
649         - BBS Event processor
650     - Analytics/RCA
651         - SON-Handler
652         - Heartbeat MS
653
654 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
655     - Platform components
656         - Cloudify Manager (helm chart)
657         - Bootstrap container (helm chart)
658         - Configuration Binding Service (helm chart)
659         - Deployment Handler (helm chart)
660         - Policy Handler (helm chart
661         - Service Change Handler (helm chart)
662         - Inventory API (helm chart)
663         - Dashboard (Cloudify Blueprint)
664     - Service components
665         - VES Collector
666         - SNMP Collector
667         - Threshold Crossing Analytics
668         - HV-VES Collector
669         - PNF-Registration Handler
670         - Holmes Rule Management *
671         - Holmes Engine Management *
672     - Additional resources that DCAE utilizes:
673         - Postgres Database
674         - Redis Cluster Database
675         - Consul Cluster *
676
677     Notes:
678         \*  These components are delivered by the Holmes project.
679
680
681 Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE R3 includes enhancement to Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
682
683 - All DCAE components are designed to support platform maturity requirements.
684
685
686 **Source Code**
687
688 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
689     - dcaegen2
690     - dcaegen2.analytics.tca
691     - dcaegen2.collectors.snmptrap
692     - dcaegen2.collectors.ves
693     - dcaegen2.collectors.hv-ves
694     - dcaegen2.collectors.datafile
695     - dcaegen2.collectors.restconf
696     - dcaegen2.deployments
697     - dcaegen2.platform.blueprints
698     - dcaegen2.platform.cli
699     - dcaegen2.platform.configbinding
700     - dcaegen2.platform.deployment-handler
701     - dcaegen2.platform.inventory-api
702     - dcaegen2.platform.plugins
703     - dcaegen2.platform.policy-handler
704     - dcaegen2.platform.servicechange-handler
705     - dcaegen2.services.heartbeat
706     - dcaegen2.services.mapper
707     - dcaegen2.services.pm-mapper
708     - dcaegen2.services.prh
709     - dcaegen2.services.son-handler
710     - dcaegen2.services
711     - dcaegen2.services.sdk
712     - dcaegen2.utils
713     - ccsdk.platform.plugins
714     - ccsdk.dashboard
715
716 **Bug Fixes**
717
718 **Known Issues**
719     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
720
721
722 **Security Notes**
723
724 *Fixed Security Issues*
725
726 *Known Security Issues*
727
728     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
729     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
730     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
731     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
732     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
733     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
734     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
735     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
736     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
737     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
738
739 *Known Vulnerabilities in Used Modules*
740
741 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
742
743 Quick Links:
744         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
745
746         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
747
748         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
749
750
751 **New component Notes**
752 The following components are introduced in R4
753
754     - Dashboard
755        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
756        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
757     - Blueprint generator
758        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
759        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
760     - RESTConf collector 
761        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
762        - Description: Provides RESTConf interfaces to events from external domain controllers
763     - VES/Universal Mapper
764        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
765        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
766     - 3gpp PM-Mapper
767        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
768        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
769     - BBS Event processor
770        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
771        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
772     - SON-Handler
773        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
774        - Description: Supports PC-ANR optimization analysis and generating CL events output
775     - Heartbeat MS
776        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
777        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
778
779
780 **Upgrade Notes**
781
782 The following components are upgraded from R3
783     - Cloudify Manager:
784        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
785        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
786     - K8S Bootstrap container:
787        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
788        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
789     - Configuration Binding Service:
790        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
791        - Description: Code optimization and bug fixes
792     - Deployment Handler
793        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
794        - Include updates for health and service endpoint check and bug fixes
795     - Policy Handler
796        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
797        - Description: Policy Handler supports the new lifecycle API's from Policy framework
798     - Service Change Handler
799        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
800        - Description: No update from R3
801     - Inventory API
802        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
803        - Description: Refactoring and updates for health and service endpoint check
804     - VES Collector
805        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
806        - Description : Authentication enhancement, refactoring and bug-fixes
807     - Threshold Crossing Analytics
808        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
809        - Description: Config updates. Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
810     - DataFile Collector
811        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
812        - Description : Code optimization, bug fixes, logging and performance improvement
813     - PNF Registrator handler
814        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
815        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
816     - HV-VES Collector
817        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
818        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
819     - SNMP Trap Collector
820        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
821        - Description : Code coverage improvements
822
823
824
825
826 Version: 3.0.1
827 ==============
828
829 :Release Date: 2019-01-31
830
831 DCAE R3 Maintenance release includes following fixes
832
833 **Bug Fixes**
834
835 - DataFileCollector
836      - DCAEGEN2-940
837        Larger files of size 100Kb publish to DR
838      - DCAEGEN2-941
839        DFC error after running over 12 hours
840      - DCAEGEN2-1001
841        Multiple Fileready notification not handled
842
843 - HighVolume VES Collector (protobuf/tcp)
844      - DCAEGEN2-976
845        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
846
847 - VESCollector (http)
848      - DCAEGEN2-1035
849        Issue with VES batch event publish
850
851 - Heat deployment
852      - DCAEGEN2-1007
853        Removing obsolete services configuration
854
855
856 The following containers are updated in R3.0.1
857
858     - DataFile Collector
859        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
860     - HV-VES Collector
861        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
862     - VES Collector
863        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
864
865 **Known Issues**
866
867 - An issue related to VESCollector basic authentication was noted and tracked under DCAEGEN2-1130. This configuration is not enabled by default for R3.0.1; and fix will be handled in Dublin
868
869 - Certificates under onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 has expired March'2019 and impacting CL deployment from CLAMP. Follow below workaround to update the certificate
870     kubectl get deployments -n onap | grep deployment-handler
871     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
872     Search and change tag onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 to onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.3
873
874
875
876
877 Version: 3.0.0
878 --------------
879
880 :Release Date: 2018-11-30
881
882 **New Features**
883
884 DCAE R3 improves upon previous release with the following new features:
885
886 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
887     - Platform components
888         - Cloudify Manager
889         - Bootstrap container
890         - Configuration Binding Service
891         - Deployment Handler
892         - Policy Handler
893         - Service Change Handler
894         - Inventory API
895     - Service components
896         - VES Collector
897         - SNMP Collector
898         - Threshold Crossing Analytics
899         - Holmes Rule Management *
900         - Holmes Engine Management *
901     - Additional resources that DCAE utilizes:
902         - Postgres Database
903         - Redis Cluster Database
904         - Consul Cluster
905
906     Notes:
907         \*  These components are delivered by the Holmes project.
908
909 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
910
911     - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
912     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
913
914 - DCAE R3 includes a new Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
915
916 - All DCAE components are designed to support platform maturity requirements.
917
918
919 **Source Code**
920
921 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
922     - dcaegen2
923     - dcaegen2.analytics
924     - dcaegen2.analytics.tca
925     - dcaegen2.collectors
926     - dcaegen2.collectors.snmptrap
927     - dcaegen2.collectors.ves
928     - dcaegen2.collectors.hv-ves
929     - dcaegen2.collectors.datafile
930     - dcaegen2.deployments
931     - dcaegen2.platform
932     - dcaegen2.platform.blueprints
933     - dcaegen2.platform.cli
934     - dcaegen2.platform.configbinding
935     - dcaegen2.platform.deployment-handler
936     - dcaegen2.platform.inventory-api
937     - dcaegen2.platform.plugins
938     - dcaegen2.platform.policy-handler
939     - dcaegen2.platform.servicechange-handler
940     - dcaegen2.services.heartbeat
941     - dcaegen2.services.mapper
942     - dcaegen2.services.prh
943     - dcaegen2.utils
944
945 **Bug Fixes**
946
947 **Known Issues**
948
949 - DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine.  Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image.  DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
950
951 **Security Notes**
952
953 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_.
954
955 Quick Links:
956         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
957
958         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
959
960         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
961
962
963 **New component Notes**
964 The following components are introduced in R3
965
966     - DataFile Collector
967        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
968        - Description : Bulk data file collector to fetch non-realtime PM data
969     - PNF Registrator handler
970        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
971        - Description : Recieves VES registration event and updates AAI and SO
972     - HV-VES Collector
973        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
974        - Description : High Volume VES Collector for fetching real-time PM measurement data
975     - SNMP Trap Collector
976        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
977        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
978
979
980 **Upgrade Notes**
981
982 The following components are upgraded from R2:
983     - Cloudify Manager:
984        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
985        - Description: R3 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.7.23, which is based on Cloudify Manager 4.3.
986     - Bootstrap container:
987        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
988        - Description: R3 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications.  The bootstrap is for OOM (Kubernetes) based deployment.
989     - Configuration Binding Service:
990        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
991        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
992     - Deployment Handler
993        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
994     - Policy Handler
995        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
996        - Description: Policy Handler now supports the new configuration policy format and support for TLS
997     - Service Change Handler
998        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
999        - Description: Refactoring.
1000     - Inventory API
1001        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
1002        - Description: Refactoring.
1003     - VES Collector
1004        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
1005        - Description : Refactoring
1006     - Threshold Crossing Analytics
1007        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1008        - Description: Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
1009
1010
1011
1012
1013 Version: 2.0.0
1014 ==============
1015
1016 :Release Date: 2018-06-07
1017
1018 **New Features**
1019
1020 DCAE R2 improves upon previous release with the following new features:
1021
1022 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
1023     - Platform components
1024         - Cloudify Manager
1025         - Bootstrap container
1026         - Configuration Binding Service
1027         - Deployment Handler
1028         - Policy Handler
1029         - Service Change Handler
1030         - Inventory API
1031     - Service components
1032         - VES Collector
1033         - SNMP Collector
1034         - Threshold Crossing Analytics
1035         - Holmes Rule Management *
1036         - Holmes Engine Management *
1037     - Additional resources that DCAE utilizes:
1038         - Postgres Database
1039         - Redis Cluster Database
1040         - Consul Cluster
1041
1042     Notes:
1043         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
1044
1045 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
1046
1047     - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
1048     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1049
1050 - DCAE R2 includes a new Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
1051
1052 - All DCAE components are designed to support platform maturity requirements.
1053
1054
1055 **Source Code**
1056
1057 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1058     - dcaegen2
1059     - dcaegen2.analytics
1060     - dcaegen2.analytics.tca
1061     - dcaegen2.collectors
1062     - dcaegen2.collectors.snmptrap
1063     - dcaegen2.collectors.ves
1064     - dcaegen2.deployments
1065     - dcaegen2.platform
1066     - dcaegen2.platform.blueprints
1067     - dcaegen2.platform.cli
1068     - dcaegen2.platform.configbinding
1069     - dcaegen2.platform.deployment-handler
1070     - dcaegen2.platform.inventory-api
1071     - dcaegen2.platform.plugins
1072     - dcaegen2.platform.policy-handler
1073     - dcaegen2.platform.servicechange-handler
1074     - dcaegen2.services.heartbeat
1075     - dcaegen2.services.mapper
1076     - dcaegen2.services.prh
1077     - dcaegen2.utils
1078
1079 **Bug Fixes**
1080
1081 **Known Issues**
1082
1083 - DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine.  Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image.  DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
1084
1085 **Security Notes**
1086
1087 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_.
1088
1089 Quick Links:
1090         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1091
1092         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1093
1094         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
1095
1096
1097
1098 **Upgrade Notes**
1099
1100 The following components are upgraded from R1:
1101     - Cloudify Manager:
1102        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
1103        - Description: R2 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.2.28, which is based on Cloudify Manager 4.3.
1104     - Bootstrap container:
1105        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
1106        - Description: R2 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications.  The bootstrap is for OOM (Kubernetes) based deployment.
1107     - Configuration Binding Service:
1108        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
1109        - Description: Configuration Binding Sevice now supports the new configuration policy format.
1110     - Deployment Handler
1111        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
1112     - Policy Handler
1113        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
1114        - Description: Policy Handler now supports the new configuration policy format.
1115     - Service Change Handler
1116        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
1117        - Description: Refactoring.
1118     - Inventory API
1119        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
1120        - Description: Refactoring.
1121     - VES Collector
1122        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
1123     - Threshold Crossing Analytics
1124        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1125        - Description: Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
1126
1127
1128
1129 Version: 1.0.0
1130 ==============
1131
1132 :Release Date: 2017-11-16
1133
1134
1135 **New Features**
1136
1137 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
1138 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
1139 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
1140 vDNS, vCPU, and vVoLTE.
1141
1142 Specifically, DCAE R1 includes the following components:
1143
1144 - Core platform
1145     - Cloudify manager
1146     - Consul cluster
1147 - Extended platform
1148     - Platform component docker host
1149     - Service component docker host
1150     - CDAP cluster
1151     - PostgreSQL database (*)
1152 - Platform docker container components
1153     - Configuration binding service
1154     - Deployment handler
1155     - Service change handler
1156     - Inventory
1157     - Policy handler
1158     - CDAP broker
1159 - Service components
1160     - Docker container components
1161         - VNF Event Streaming (VES) collector
1162         - Holmes (engine and rule management) **
1163     - CDAP analytics component
1164         - Threshold Crossing Analytics (TCA)
1165
1166 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
1167 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
1168 other deployment configurations not used in the R1 demos.)
1169 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
1170 in R1.
1171
1172 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
1173
1174 - dcaegen2
1175 - dcaegen2/analytics
1176 - dcaegen2/analytics/tca
1177 - dcaegen2/collectors
1178 - dcaegen2/collectors/snmptrap
1179 - dcaegen2/collectors/ves
1180 - dcaegen2/deployments
1181 - dcaegen2/platform
1182 - dcaegen2/platform/blueprints
1183 - dcaegen2/platform/cdapbroker
1184 - dcaegen2/platform/cli
1185 - dcaegen2/platform/configbinding
1186 - dcaegen2/platform/deployment-handler
1187 - dcaegen2/platform/inventory-api
1188 - dcaegen2/platform/plugins
1189 - dcaegen2/platform/policy-handler
1190 - dcaegen2/platform/servicechange-handler
1191 - dcaegen2/utils
1192
1193
1194 **Bug Fixes**
1195
1196 This is the initial release.
1197
1198
1199 **Known Issues**
1200
1201 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
1202 - Need to provide a dev configuration DCAE.
1203
1204
1205 **Security Issues**
1206
1207 - The DCAE Bootstrap container needs to have a secret key for accessing VMs that it launches.  This key is currently passed in as a Heat template parameter.  Tracked by JIRA `DCAEGEN2-178 <https://jira.onap.org/browse/DCAEGEN2-178>`_.>`_.
1208 - The RESTful API calls are generally not secure.  That is, they are either over http, or https without certificate verification.  Once there is an ONAP wide solution for handling certificates, DCAE will switch to https.
1209
1210
1211 **Upgrade Notes**
1212
1213 This is the initial release.
1214
1215
1216 **Deprecation Notes**
1217
1218 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
1219 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
1220 following Gerrit repos are voided and already locked as read-only.
1221
1222 - dcae
1223 - dcae/apod
1224 - dcae/apod/analytics
1225 - dcae/apod/buildtools
1226 - dcae/apod/cdap
1227 - dcae/collectors
1228 - dcae/collectors/ves
1229 - dcae/controller
1230 - dcae/controller/analytics
1231 - dcae/dcae-inventory
1232 - dcae/demo
1233 - dcae/demo/startup
1234 - dcae/demo/startup/aaf
1235 - dcae/demo/startup/controller
1236 - dcae/demo/startup/message-router
1237 - dcae/dmaapbc
1238 - dcae/operation
1239 - dcae/operation/utils
1240 - dcae/orch-dispatcher
1241 - dcae/pgaas
1242 - dcae/utils
1243 - dcae/utils/buildtools
1244 - ncomp
1245 - ncomp/cdap
1246 - ncomp/core
1247 - ncomp/docker
1248 - ncomp/maven
1249 - ncomp/openstack
1250 - ncomp/sirius
1251 - ncomp/sirius/manager
1252 - ncomp/utils
1253
1254
1255 **Other**
1256
1257 SNMP trap collector is seed code delivery only.