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