Merge "Update documentation CBS-Client to support config fetch from a configMap"
[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-2021 AT&T Intellectual Property. All rights reserved.
4 .. Modification Copyright 2021 Nokia Solutions and Networks.
5 .. _release_notes:
6
7
8
9 ==================
10 DCAE Release Notes
11 ==================
12
13 .. contents::
14     :depth: 2
15 ..
16
17
18 ..      ==========================
19 ..      * * *    HONOLULU    * * *
20 ..      ==========================
21
22
23 Version: 8.0.0
24 ==============
25
26
27 Abstract
28 --------
29
30 This document provides the release notes for Honolulu release.
31
32 Summary
33 -------
34
35 Following DCAE components are available with default ONAP/DCAE installation.
36
37     - Platform components
38
39         - Cloudify Manager (helm chart)
40         - Bootstrap container (helm chart)
41         - Configuration Binding Service (helm chart)
42         - Deployment Handler (helm chart)
43         - Policy Handler (helm chart
44         - Service Change Handler (helm chart)
45         - Inventory API (helm chart)
46         - Dashboard (helm chart)
47         - VES OpenAPI Manager (helm chart)
48
49     - Service components
50
51         - VES Collector (helm chart  & cloudify blueprint)
52         - HV-VES Collector (helm chart  & cloudify blueprint)
53         - PNF-Registration Handler  (helm chart  & cloudify blueprint)
54         - Docker based Threshold Crossing Analytics (TCA-Gen2) (helm chart  & cloudify blueprint)
55         - Holmes Rule Management (helm chart  & cloudify blueprint)
56         - Holmes Engine Management (helm chart  & cloudify blueprint)
57
58     - Additional resources that DCAE utilizes deployed using ONAP common charts:
59
60         - Postgres Database
61         - Mongo Database
62         - Consul Cluster
63
64 Below service components (mS) are available to be deployed on-demand (through Cloudify Blueprint)
65
66         - SNMPTrap Collector
67         - RESTConf Collector
68         - DataFile Collector
69         - PM-Mapper 
70         - BBS-EventProcessor
71         - VES Mapper
72         - Heartbeat mS
73         - SON-Handler
74         - PM-Subscription Handler
75         - DataLake Handler (Admin and Feeder)
76         - Slice Analysis mS
77         - DataLake Extraction Service
78         - KPI-Ms
79
80     Notes:
81
82         \*  These components are delivered by the Holmes project.
83
84
85
86 Under OOM (Kubernetes) all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE components are deployed using combination of Helm charts and Cloudify blueprint as noted above. 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.
87
88
89 Release Data
90 ------------
91
92 +--------------------------------------+--------------------------------------------------------+
93 | **DCAE Project**                     |                                                        |
94 |                                      |                                                        |
95 +--------------------------------------+--------------------------------------------------------+
96 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
97 |                                      |                                                        |
98 +--------------------------------------+--------------------------------------------------------+
99 | **Release designation**              | 8.0.0 Honolulu                                         |
100 |                                      |                                                        |
101 +--------------------------------------+--------------------------------------------------------+
102 | **Release date**                     | 2021-04-29                                             |
103 |                                      |                                                        |
104 +--------------------------------------+--------------------------------------------------------+
105
106
107 New features
108 ------------
109
110 *DCAE Enhancements*
111
112
113 Functional Updates
114
115    - New service VES-Openapi-Manager component added to DCAE, allowing to notify of missing openAPI description, at xNF distribution phase (DCAEGEN2-2571) 
116    - Added VES 7.2.1 support in VESCollector (DCAEGEN2-2539, DCAEGEN2-2477)
117    - DCAE MS deployment through helm with introduction of common dcae-service template to standardize charts with migration (DCAEGEN2-2488) 
118    - New service KPI-Computation MS introduced for support for E2E Slicing Usecase (DCAEGEN2-2521)
119    - K8S configMap support through onboarding/design/deployment via DCAE-MOD and DCAE-Platform (DCAEGEN2-2539)
120    - BP-generation Enhancements - support Native-kafka & Config-map through onboarding (DCAEGEN2-2458)
121    - CFY plugin enhancements - support IPV6 service exposure + Config-Map + Cert-Manager's CMPv2 issuer integration (DCAEGEN2-2539, DCAEGEN2-2458, DCAEGEN2-2388)
122    - DCAE SDK enhancement - Dmaap Client update for timeout/retry + CBS client update (DCAEGEN2-1483)
123    - DFC enhancement - support in HTTP/HTTPS/enroll certificate from CMPv2 server (DCAEGEN2-2517)
124
125 Non-Functional
126
127    - DCAE Cloudify py3 upgrade including plugins/bootstrap cli (DCAEGEN2-1546)
128    - CII Badging improvements (DCAEGEN2-2570)
129    - Policy-Handler Py3 upgrade  (DCAEGEN2-2494)
130    - Vulnerability updates for several DCAE MS (DataFile Collector, RESTConf, VESCollector, InventoryAPI, MOD/RuntimeAPI, VES-mapper, PM-Mapper, PRH, SON-Handler) (DCAEGEN2-2551)
131    - Code Coverage improvement (DataFile, SDK, Blueprint-generator, Plugins, Acumos Adapter) (DCAEGEN2-2382)
132    - Documentation/user-guide updates
133
134 Bug Fixes
135
136    - BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
137    - Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
138
139
140 - Following new services are delivered this release
141     - VES OpenAPI Manager
142     - KPI MS (Analytics/RCA)
143
144 .. _honolulu_deliverable:
145
146 Deliverables
147 ------------
148
149 Software Deliverables
150
151 .. csv-table::
152    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
153    :widths: auto
154
155    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
156    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.5.5"
157    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.6.0"
158    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.4"
159    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.4"
160    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.8.0"
161    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.4.2"
162    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.0"
163    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
164    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
165    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
166    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.0"
167    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.5"
168    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
169    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
170    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
171    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
172    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
173    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.2.3"
174    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.4"
175    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.0.4" 
176    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
177    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
178    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"  
179    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.2"
180    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
181    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.0.1"
182    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
183    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
184    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
185    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
186    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.4"
187    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
188    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.0"
189    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
190    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.2.0"
191    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.5.2"
192    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.6"
193    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.3"
194    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.7.3 (jar)"
195    "dcaegen2/services/sdk", "", "DCAE SDK 1.7.0 (jar)"
196    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
197
198
199 Known Limitations, Issues and Workarounds
200 -----------------------------------------
201
202 The new, Helm based installation mechanism for collectors doesn't support yet certain features available with the traditional Cloudify orchestration based mechanisms:
203    - Obtaining X.509 certificates from external CMP v2 server for secure xNF connections
204    - Exposing the Collector port in Dual Stack IPv4/IPv6 networks.
205
206 Such features are available, when the collectors are installed using the Cloudify mechanisms.
207 Refer to collector installation page for more details:
208
209 .. toctree::
210    :maxdepth: 1
211
212    ./services/ves-http/installation.rst
213    ./services/ves-hv/installation.rst
214
215     
216 *Known Vulnerabilities*
217
218 None
219
220 *Workarounds*
221
222 Documented under corresponding jira if applicable.
223
224 Security Notes
225 --------------
226
227 *Fixed Security Issues*
228     
229     Documented on earlier section
230
231 *Known Security Issues*
232     
233     None
234
235 *Known Vulnerabilities in Used Modules*
236     
237     None
238         
239 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>`_.
240
241 Test Results
242 ------------
243
244  - `DCAE R8 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Honolulu+Release>`_
245  - `DCAE R8 Functional Test <https://wiki.onap.org/display/DW/DCAE+R8+Testplan>`_
246
247
248 References
249 ----------
250
251 For more information on the ONAP Honolulu release, please see:
252
253 #. `ONAP Home Page`_
254 #. `ONAP Documentation`_
255 #. `ONAP Release Downloads`_
256 #. `ONAP Wiki Page`_
257
258
259 .. _`ONAP Home Page`: https://www.onap.org
260 .. _`ONAP Wiki Page`: https://wiki.onap.org
261 .. _`ONAP Documentation`: https://docs.onap.org
262 .. _`ONAP Release Downloads`: https://git.onap.org
263
264 Quick Links:
265
266         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
267         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
268
269
270 ..      ===================================
271 ..      * * *    GUILIN  MAINTENANCE  * * *
272 ..      ===================================
273
274
275 Version: 7.0.1
276 ==============
277
278 Abstract
279 --------
280
281 This document provides the release notes for the Guilin Maintenance release
282
283
284 Summary
285 -------
286
287 This maintenance release is primarily to resolve bugs identified during Guilin release testing.
288
289
290 Release Data
291 ------------
292
293 +--------------------------------------+--------------------------------------+
294 | **Project**                          | DCAE                                 |
295 |                                      |                                      |
296 +--------------------------------------+--------------------------------------+
297 | **Docker images**                    | onap/org.onap.dcaegen2.collectors    |
298 |                                      |   .hv-ves.hv-collector-main:1.5.1    |
299 +--------------------------------------+--------------------------------------+
300 | **Release designation**              | Guilin Maintenance Release           |
301 |                                      |                                      |
302 +--------------------------------------+--------------------------------------+
303 | **Release date**                     | 2021/04/19                           |
304 |                                      |                                      |
305 +--------------------------------------+--------------------------------------+
306
307 New features
308 ------------
309
310 None
311
312 **Bug fixes**
313
314 - `DCAEGEN2-2516 <https://jira.onap.org/browse/DCAEGEN2-2516>`_ HV-VES Pod recovery when config-fetch fails
315 - `OOM-2641 <https://jira.onap.org/browse/OOM-2641>`_ Fix DCAEMOD paths based on Guilin ingress template
316
317 **Known Issues**
318
319 Same as Guilin Release
320
321
322 ..      ========================
323 ..      * * *    GUILIN    * * *
324 ..      ========================
325
326
327 Version: 7.0.0
328 ==============
329
330
331 Abstract
332 --------
333
334 This document provides the release notes for Guilin release.
335
336 Summary
337 -------
338
339 Following DCAE components are available with default ONAP/DCAE installation.
340
341     - Platform components
342
343         - Cloudify Manager (helm chart)
344         - Bootstrap container (helm chart)
345         - Configuration Binding Service (helm chart)
346         - Deployment Handler (helm chart)
347         - Policy Handler (helm chart
348         - Service Change Handler (helm chart)
349         - Inventory API (helm chart)
350         - Dashboard (helm chart)
351
352     - Service components
353
354         - VES Collector
355         - HV-VES Collector
356         - PNF-Registration Handler
357         - Docker based Threshold Crossing Analytics (TCA-Gen2)
358         - Holmes Rule Management *
359         - Holmes Engine Management *
360
361     - Additional resources that DCAE utilizes deployed using ONAP common charts:
362     
363         - Postgres Database
364         - Mongo Database
365         - Redis Cluster Database
366         - Consul Cluster 
367
368 Below service components (mS) are available to be deployed on-demand.
369
370         - SNMPTrap Collector
371         - RESTConf Collector
372         - DataFile Collector
373         - PM-Mapper 
374         - BBS-EventProcessor
375         - VES Mapper
376         - Heartbeat mS
377         - SON-Handler
378         - PM-Subscription Handler
379         - DataLake Handler (Admin and Feeder)
380         - Slice Analysis
381         - DataLake Extraction Service
382
383     Notes:
384
385         \*  These components are delivered by the Holmes project.
386
387
388
389 Under OOM (Kubernetes) 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.
390
391
392 Release Data
393 ------------
394
395 +--------------------------------------+--------------------------------------------------------+
396 | **DCAE Project**                     |                                                        |
397 |                                      |                                                        |
398 +--------------------------------------+--------------------------------------------------------+
399 | **Docker images**                    | Refer :any:`Deliverable <guilin_deliverable>`          |
400 |                                      |                                                        |
401 +--------------------------------------+--------------------------------------------------------+
402 | **Release designation**              | 7.0.0 Guilin                                           |
403 |                                      |                                                        |
404 +--------------------------------------+--------------------------------------------------------+
405 | **Release date**                     | 2020-11-19                                             |
406 |                                      |                                                        |
407 +--------------------------------------+--------------------------------------------------------+
408
409
410 New features
411 ------------
412
413 - DCAE Enhancements
414
415     - Cloudify Container upgraded with new base image; plugins load optimized (DCAEGEN2-2236, DCAEGEN2-2207, DCAEGEN2-2262)
416     - Bootstrap container optimization  (DCAEGEN2-1791)
417     - MOD/Runtime â€“ Enable configuration for dynamic topic support (DCAEGEN2-1996)
418     - MOD/OnboardingAPI - Support for offline install (DCAEGEN2-2221)
419     - DCAE Dashboard UI Optimization  and bugfixes (DCAEGEN2-2223, DCAEGEN2-2364,DCAEGEN2-1638,DCAEGEN2-2298, DCAEGEN2-1857)
420     - Blueprint generator tool and K8Splugin enhancement to support External Certificate (DCAEGEN2-2250)
421     - K8S v1.17 support through DCAE Cloudify K8S plugins (DCAEGEN2-2309)
422     - Python 3.8 support enabled for several DCAE components - Heartbeat mS, PMSH mS, MOD/DistriubtorAPI mS, MOD/OnboardingAPI mS, Policy Library (DCAEGEN2-2292)
423     - Java 11 upgrade complete for following modules - RESTConf, PM-Mapper, DFC, VES-Mapper, SON-handler, TCA-gen2, DL-Feeder, InventoryAPI, ServiceChangeHandler, MOD/RuntimeAPI, MOD/Bp-gen (DCAEGEN2-2223)
424     - Hardcoded password removed from OOM charts - Cloudify, Bootstrap, DeploymentHandler, Dashboard; now managed dynamically through K8S secret (DCAEGEN2-1972, DCAEGEN2-1975)
425     - Best practice compliance
426          - STDOUT log compliance for DCAE Containers (DCAEGEN2-2324)
427          - No more than one main process (DCAEGEN2-2327/REQ-365)
428          - Container must crash when failure is noted (DCAEGEN2-2326/REQ-366)
429          - All containers must run as non-root (REQ-362)
430          - Code coverage >55% (DCAEGEN2-2333)
431     - All Vulnerability identified by SECCOM has been resolved (DCAEGEN2-2242)
432  
433
434 - Following new services are delivered this release
435
436     - Event Processors
437         - DataLake Extraction Service 
438        
439     - Analytics/RCA
440         - Slice Analysis MS
441         
442 .. _guilin_deliverable:
443
444 Deliverables
445 ------------
446
447 Software Deliverables
448
449 .. csv-table::
450    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
451    :widths: auto
452
453    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
454    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.4.3"
455    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.5.0"
456    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.2"
457    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
458    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.7.9"
459    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:3.3.4"
460    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
461    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
462    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
463    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
464    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
465    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.3"
466    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
467    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
468    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
469    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
470    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
471    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.1.1"
472    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.3"
473    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:2.1.8" 
474    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
475    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
476    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.1"  
477    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
478    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
479    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
480    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
481    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
482    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
483    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.1"
484    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
485    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
486    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.1.0"
487    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.4.1"
488    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.4"
489    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.2"
490    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.5.2 (jar)"
491    "dcaegen2/services/sdk", "", "DCAE SDK 1.4.3 (jar)"
492    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
493         
494
495 Known Limitations, Issues and Workarounds
496 -----------------------------------------
497
498     * BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
499     * Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
500     * HV-VES - Pod recovery when config-fetch fails (DCAEGEN2-2516)
501     
502
503 *System Limitations*
504
505 None
506
507 *Known Vulnerabilities*
508
509 None
510
511 *Workarounds*
512
513 Documented under corresponding jira if applicable.
514
515 Security Notes
516 --------------
517
518 *Fixed Security Issues*
519     Listed above
520     
521 *Known Security Issues*
522
523         None
524         
525         
526 *Known Vulnerabilities in Used Modules*
527
528         None
529         
530 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>`_.
531
532 Test Results
533 ------------
534
535  - `DCAE R7 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Guilin+Release>`_
536  - `DCAE MOD R7 Test <https://wiki.onap.org/display/DW/DCAE+R7+Testplan>`_
537
538
539 References
540 ----------
541
542 For more information on the ONAP Guilin release, please see:
543
544 #. `ONAP Home Page`_
545 #. `ONAP Documentation`_
546 #. `ONAP Release Downloads`_
547 #. `ONAP Wiki Page`_
548
549
550 .. _`ONAP Home Page`: https://www.onap.org
551 .. _`ONAP Wiki Page`: https://wiki.onap.org
552 .. _`ONAP Documentation`: https://docs.onap.org
553 .. _`ONAP Release Downloads`: https://git.onap.org
554
555 Quick Links:
556
557         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
558         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
559
560
561
562
563 ..      ======================================
564 ..      * * *    EL-ALTO  MAINTENANCE  * * *
565 ..      ======================================
566
567
568 Version: 5.0.2
569 ==============
570
571 Abstract
572 --------
573
574 This document provides the release notes for the El-Alto Maintenance release
575
576
577 Summary
578 -------
579
580 This maintenance release is primarily to update expired certificates 
581 from original El-Alto released TLS-init container.
582
583 This patch is not required for Frankfurt release (and beyond) as certificates are dynamically 
584 retrieved from AAF at deployment time for all DCAE components.
585
586 Release Data
587 ------------
588
589 +--------------------------------------+--------------------------------------+
590 | **Project**                          | DCAE                                 |
591 |                                      |                                      |
592 +--------------------------------------+--------------------------------------+
593 | **Docker images**                    | onap/org.onap.dcaegen2.deployments   |
594 |                                      |   .tls-init-container:1.0.4          |
595 +--------------------------------------+--------------------------------------+
596 | **Release designation**              | El-Alto  Maintenance Release         |
597 |                                      |                                      |
598 +--------------------------------------+--------------------------------------+
599 | **Release date**                     | 2020/08/24                           |
600 |                                      |                                      |
601 +--------------------------------------+--------------------------------------+
602
603 New features
604 ------------
605
606 None
607
608 **Bug fixes**
609
610 - `DCAEGEN2-2206 <https://jira.onap.org/browse/DCAEGEN2-2206>`_ DCAE TLS Container : Address certificate expiration
611
612 **Known Issues**
613 Same as El-Alto Release
614
615
616
617 ..      ======================================
618 ..      * * *    FRANKFURT  MAINTENANCE  * * *
619 ..      ======================================
620
621
622 Version: 6.0.1
623 ==============
624
625 Abstract
626 --------
627
628 This document provides the release notes for the Frankfurt Maintenance release
629
630
631 Summary
632 -------
633
634 The focus of this release is to correct issues found on Frankfurt release.
635
636 Release Data
637 ------------
638
639 +--------------------------------------+--------------------------------------+
640 | **Project**                          | DCAE                                 |
641 |                                      |                                      |
642 +--------------------------------------+--------------------------------------+
643 | **Docker images**                    | onap/org.onap.dcaegen2.services.     |
644 |                                      |   son-handler:2.0.4                  |
645 +--------------------------------------+--------------------------------------+
646 | **Release designation**              | Frankfurt  Maintenance Release 1     |
647 |                                      |                                      |
648 +--------------------------------------+--------------------------------------+
649 | **Release date**                     | 2020/08/17                           |
650 |                                      |                                      |
651 +--------------------------------------+--------------------------------------+
652
653 New features
654 ------------
655
656 None
657
658 **Bug fixes**
659
660 - `DCAEGEN2-2249 <https://jira.onap.org/browse/DCAEGEN2-2249>`_ SON-Handler: Fix networkId issue while making call to oof
661 - `DCAEGEN2-2216 <https://jira.onap.org/browse/DCAEGEN2-2216>`_ SON-Handler: Change Policy notification  to align with policy component updates
662
663 **Known Issues**
664
665 Same as Frankfurt Release
666
667
668
669
670 ..      ===========================
671 ..      * * *    FRANKFURT    * * *
672 ..      ===========================
673
674
675 Version: 6.0.0
676 ==============
677
678
679 Abstract
680 --------
681
682 This document provides the release notes for the Frankfurt release.
683
684 Summary
685 -------
686
687 Following DCAE components are available with default ONAP/DCAE installation.
688
689     - Platform components
690
691         - Cloudify Manager (helm chart)
692         - Bootstrap container (helm chart)
693         - Configuration Binding Service (helm chart)
694         - Deployment Handler (helm chart)
695         - Policy Handler (helm chart
696         - Service Change Handler (helm chart)
697         - Inventory API (helm chart)
698         - Dashboard (helm chart)
699
700     - Service components
701
702         - VES Collector
703         - Threshold Crossing Analytics (TCA/CDAP)
704         - HV-VES Collector
705         - PNF-Registration Handler
706         - Docker based Threshold Crossing Analytics (TCA-Gen2)
707         - Holmes Rule Management *
708         - Holmes Engine Management *
709
710     - Additional resources that DCAE utilizes deployed using ONAP common charts:
711     
712         - Postgres Database
713         - Mongo Database
714         - Redis Cluster Database
715         - Consul Cluster 
716
717 Below service components (mS) are available to be deployed on-demand.
718
719         - SNMPTrap Collector
720         - RESTConf Collector
721         - DataFile Collector
722         - PM-Mapper 
723         - BBS-EventProcessor
724         - VES Mapper
725         - Heartbeat mS
726         - SON-Handler
727         - PM-Subscription Handler
728
729     Notes:
730
731         \*  These components are delivered by the Holmes project.
732
733
734
735 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.
736
737
738 Release Data
739 ------------
740
741 +--------------------------------------+--------------------------------------------------------+
742 | **DCAE Project**                     |                                                        |
743 |                                      |                                                        |
744 +--------------------------------------+--------------------------------------------------------+
745 | **Docker images**                    |Refer :any:`Deliverable <frankfurt_deliverable>`        |
746 |                                      |                                                        |
747 +--------------------------------------+--------------------------------------------------------+
748 | **Release designation**              | 6.0.0 frankfurt                                        |
749 |                                      |                                                        |
750 +--------------------------------------+--------------------------------------------------------+
751 | **Release date**                     | 2020-06-04                                             |
752 |                                      |                                                        |
753 +--------------------------------------+--------------------------------------------------------+
754
755
756 New features
757 ------------
758
759 - DCAE Platform Enhancement
760
761     - Introduction of Microservice and Onboarding Design (MOD) platform 
762     - Policy Notification support for DCAE components
763     - Dynamic AAF certificate creation during component instantiation
764     - Helm chart optimization to control each platform component separate
765     - Dashboard Optimization 
766     - Blueprint generator tool to simplify deployment artifact creation
767    
768
769 - Following new services are delivered this release
770
771     - Event Processors
772     
773         - PM Subscription Handler
774         - DataLake Handlers 
775     - Analytics/RCA
776     
777         - TCA-GEN2
778         
779         - Acumos Adapter (PoC)
780
781 .. _frankfurt_deliverable:
782
783 Deliverables
784 ------------
785
786 Software Deliverables
787
788 .. csv-table::
789    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
790    :widths: auto
791
792    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
793    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
794    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
795    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
796    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
797    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
798    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
799    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
800    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
801    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
802    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
803    "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
804    "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
805    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
806    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
807    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
808    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
809    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
810    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
811    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
812    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
813    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6" 
814    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
815    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
816    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"  
817    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
818    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
819    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
820    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
821    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
822    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
823    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
824    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
825    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
826    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
827    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
828    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
829    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
830    "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
831    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
832         
833
834 Known Limitations, Issues and Workarounds
835 -----------------------------------------
836
837     * Blueprint generator escape char issue (DCAEGEN2-2140)
838     * TCAgen2 Policy configuration support (DCAEGEN2-2198)
839     * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
840
841
842
843 *System Limitations*
844
845 None
846
847 *Known Vulnerabilities*
848
849 None
850
851 *Workarounds*
852
853 Documented under corresponding jira if applicable.
854
855 Security Notes
856 --------------
857
858 *Fixed Security Issues*
859
860     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
861     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
862     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
863     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
864     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
865
866     
867 *Known Security Issues*
868
869         None
870         
871         
872 *Known Vulnerabilities in Used Modules*
873
874         None
875         
876 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>`_.
877
878 Test Results
879 ------------
880
881  - `DCAE R6 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
882  - `DCAE MOD R6 Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
883
884
885 References
886 ----------
887
888 For more information on the ONAP Frankfurt release, please see:
889
890 #. `ONAP Home Page`_
891 #. `ONAP Documentation`_
892 #. `ONAP Release Downloads`_
893 #. `ONAP Wiki Page`_
894
895
896 .. _`ONAP Home Page`: https://www.onap.org
897 .. _`ONAP Wiki Page`: https://wiki.onap.org
898 .. _`ONAP Documentation`: https://docs.onap.org
899 .. _`ONAP Release Downloads`: https://git.onap.org
900
901 Quick Links:
902
903         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
904         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
905
906
907 ..      =========================
908 ..      * * *    EL-ALTO    * * *
909 ..      =========================
910
911
912 Version: 5.0.1
913 ==============
914
915 The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
916
917 Following is summary of updates done for DCAEGEN2
918
919 **Security**
920
921 Following platform components were enabled for HTTPS
922     - ConfigBindingService (CBS)
923       -   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>`_
924     - Cloudify Manager
925     - InventoryAPI
926     - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
927
928 All components interfacing with platform components were modified to support TLS interface
929
930 **Miscellaneous**
931     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
932     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
933     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
934     - CBS client libraries updated to remove consul service lookup
935     - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
936
937
938
939 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.
940     - Platform components
941         - Cloudify Manager (helm chart)
942         - Bootstrap container (helm chart)
943         - Configuration Binding Service (helm chart)
944         - Deployment Handler (helm chart)
945         - Policy Handler (helm chart
946         - Service Change Handler (helm chart)
947         - Inventory API (helm chart)
948         - Dashboard (helm charts)
949     - Service components
950         - VES Collector
951         - SNMP Collector
952         - Threshold Crossing Analytics
953         - HV-VES Collector
954         - PNF-Registration Handler
955         - Holmes Rule Management *
956         - Holmes Engine Management *
957     - Additional resources that DCAE utilizes:
958         - Postgres Database
959         - Redis Cluster Database
960         - Consul Cluster *
961
962     Notes:
963         \*  These components are delivered by external ONAP project.
964
965 DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
966
967     - Collectors
968         - RESTConf collector 
969         - DataFile collector
970     - Event Processors
971         - VES Mapper
972         - 3gpp PM-Mapper
973         - BBS Event processor
974     - Analytics/RCA
975         - SON-Handler
976         - Missing Heartbeat Ms
977
978 - All DCAE components are designed to support platform maturity requirements.
979
980
981 **Source Code**
982
983 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.
984     - dcaegen2
985     - dcaegen2.analytics.tca
986     - dcaegen2.collectors.snmptrap
987     - dcaegen2.collectors.ves
988     - dcaegen2.collectors.hv-ves
989     - dcaegen2.collectors.datafile
990     - dcaegen2.collectors.restconf
991     - dcaegen2.deployments
992     - dcaegen2.platform.blueprints
993     - dcaegen2.platform.cli
994     - dcaegen2.platform.configbinding
995     - dcaegen2.platform.deployment-handler
996     - dcaegen2.platform.inventory-api
997     - dcaegen2.platform.plugins
998     - dcaegen2.platform.policy-handler
999     - dcaegen2.platform.servicechange-handler
1000     - dcaegen2.services.heartbeat
1001     - dcaegen2.services.mapper
1002     - dcaegen2.services.pm-mapper
1003     - dcaegen2.services.prh
1004     - dcaegen2.services.son-handler
1005     - dcaegen2.services
1006     - dcaegen2.services.sdk
1007     - dcaegen2.utils
1008     - ccsdk.platform.plugins
1009     - ccsdk.dashboard
1010
1011 **Bug Fixes**
1012     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
1013     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
1014
1015
1016 **Known Issues**
1017     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1018
1019 **Security Notes**
1020
1021 *Fixed Security Issues*
1022     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1023     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1024     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1025     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1026     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1027
1028 *Known Security Issues*
1029     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1030     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1031     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1032     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1033     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1034
1035 *Known Vulnerabilities in Used Modules*
1036
1037 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>`_.
1038
1039 Quick Links:
1040         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1041
1042         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1043
1044         - `Project Vulnerability Review Table for DCAE (El-Alto Maintenance) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
1045
1046
1047 **Upgrade Notes**
1048
1049 The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
1050     - K8S Bootstrap container:
1051        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
1052        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
1053     - Configuration Binding Service:
1054        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
1055        - Description: HTTPS support, Image optimization and non-root user
1056     - Inventory API
1057        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
1058        - Description: HTTPS support, container optmization and non-root user
1059     - DataFile Collector
1060        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
1061        - Description : Code optimization, bug fixes, dmaap plugin integration
1062     - SON Handler MS
1063        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
1064        - Description : Image optimization, bug fixes, CBS integration
1065     - VES Adapter/Mapper MS
1066        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
1067        - Description : Image optimization & CBS periodic polling
1068     - PRH MS
1069        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
1070        - Description : Code optimization, bug fixes and SDK alignment
1071     - HV-VES MS
1072        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
1073        - Description : Code optimization, bug fixes and SDK alignment
1074
1075 Version: 5.0.0
1076 ==============
1077
1078 El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
1079
1080 Following is summary of updates done for DCAEGEN2
1081
1082 **Security**
1083
1084 Following platform components were enabled for HTTPS
1085     - ConfigBindingService (CBS)
1086       -   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>`_
1087     - Cloudify Manager
1088     - InventoryAPI
1089
1090 All components interfacing with platform components were modified to support TLS interface
1091
1092 **Miscellaneous**
1093     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
1094     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
1095     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
1096     - CBS client libraries updated to remove consul service lookup
1097
1098
1099
1100 **Bug Fixes**
1101     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
1102     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
1103
1104
1105 **Known Issues**
1106     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1107
1108
1109 **Security Notes**
1110
1111 *Fixed Security Issues*
1112
1113 *Known Security Issues*
1114
1115     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1116     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1117     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1118     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1119     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1120     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1121     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1122     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1123     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1124     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1125
1126 *Known Vulnerabilities in Used Modules*
1127
1128 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>`_.
1129
1130 Quick Links:
1131         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1132
1133         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1134
1135         - `Project Vulnerability Review Table for DCAE (El-Alto) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
1136
1137
1138 **Upgrade Notes**
1139
1140 The following components are upgraded from Dublin/R4.
1141     - Cloudify Manager:
1142        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
1143        - 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.
1144     - K8S Bootstrap container:
1145        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
1146        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
1147     - Configuration Binding Service:
1148        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
1149        - Description: HTTPS support, Image optimization and non-root user
1150     - Deployment Handler
1151        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
1152        - Description: Update to node10, uninstall workflow updates
1153     - Service Change Handler
1154        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
1155        - Description: HTTPS inventoryAPI support, container optmization and non-root user
1156     - Inventory API
1157        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
1158        - Description: HTTPS support, container optmization and non-root user
1159     - DataFile Collector
1160        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
1161        - Description : Code optimization, bug fixes, dmaap plugin integration
1162     - 3gpp PM-Mapper
1163        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
1164        - Description: Code optimization, bug fixes, dmaap plugin integration
1165
1166
1167
1168 Version: 4.0.0
1169 ==============
1170
1171 :Release Date: 2019-06-06
1172
1173 **New Features**
1174
1175 DCAE R4 improves upon previous release with the following new features:
1176
1177 - DCAE Platform Enhancement
1178     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
1179     - Support helm chart deployment in DCAE using new Helm cloudify plugin
1180     - DCAE Healthcheck enhancement to cover static and dynamic deployments
1181     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
1182     - Dashboard Integration (UI for deployment/verification)
1183     - PolicyHandler Enhancement to support new Policy Lifecycle API’s
1184     - Blueprint generator tool to simplify deployment artifact creation
1185     - Cloudify Manager resiliency
1186
1187 - Following new services are delivered with Dublin
1188     - Collectors
1189         - RESTConf collector 
1190     - Event Processors
1191         - VES Mapper
1192         - 3gpp PM-Mapper
1193         - BBS Event processor
1194     - Analytics/RCA
1195         - SON-Handler
1196         - Heartbeat MS
1197
1198 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
1199     - Platform components
1200         - Cloudify Manager (helm chart)
1201         - Bootstrap container (helm chart)
1202         - Configuration Binding Service (helm chart)
1203         - Deployment Handler (helm chart)
1204         - Policy Handler (helm chart
1205         - Service Change Handler (helm chart)
1206         - Inventory API (helm chart)
1207         - Dashboard (Cloudify Blueprint)
1208     - Service components
1209         - VES Collector
1210         - SNMP Collector
1211         - Threshold Crossing Analytics
1212         - HV-VES Collector
1213         - PNF-Registration Handler
1214         - Holmes Rule Management *
1215         - Holmes Engine Management *
1216     - Additional resources that DCAE utilizes:
1217         - Postgres Database
1218         - Redis Cluster Database
1219         - Consul Cluster *
1220
1221     Notes:
1222         \*  These components are delivered by the Holmes project.
1223
1224
1225 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.
1226
1227 - All DCAE components are designed to support platform maturity requirements.
1228
1229
1230 **Source Code**
1231
1232 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1233     - dcaegen2
1234     - dcaegen2.analytics.tca
1235     - dcaegen2.collectors.snmptrap
1236     - dcaegen2.collectors.ves
1237     - dcaegen2.collectors.hv-ves
1238     - dcaegen2.collectors.datafile
1239     - dcaegen2.collectors.restconf
1240     - dcaegen2.deployments
1241     - dcaegen2.platform.blueprints
1242     - dcaegen2.platform.cli
1243     - dcaegen2.platform.configbinding
1244     - dcaegen2.platform.deployment-handler
1245     - dcaegen2.platform.inventory-api
1246     - dcaegen2.platform.plugins
1247     - dcaegen2.platform.policy-handler
1248     - dcaegen2.platform.servicechange-handler
1249     - dcaegen2.services.heartbeat
1250     - dcaegen2.services.mapper
1251     - dcaegen2.services.pm-mapper
1252     - dcaegen2.services.prh
1253     - dcaegen2.services.son-handler
1254     - dcaegen2.services
1255     - dcaegen2.services.sdk
1256     - dcaegen2.utils
1257     - ccsdk.platform.plugins
1258     - ccsdk.dashboard
1259
1260 **Bug Fixes**
1261
1262 **Known Issues**
1263     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1264
1265
1266 **Security Notes**
1267
1268 *Fixed Security Issues*
1269
1270 *Known Security Issues*
1271
1272     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1273     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1274     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1275     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1276     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1277     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1278     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1279     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1280     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1281     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1282
1283 *Known Vulnerabilities in Used Modules*
1284
1285 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>`_.
1286
1287 Quick Links:
1288         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1289
1290         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1291
1292         - `Project Vulnerability Review Table for DCAE (Dublin) <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
1293
1294
1295 **New component Notes**
1296 The following components are introduced in R4
1297
1298     - Dashboard
1299        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
1300        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
1301     - Blueprint generator
1302        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
1303        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
1304     - RESTConf collector 
1305        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
1306        - Description: Provides RESTConf interfaces to events from external domain controllers
1307     - VES/Universal Mapper
1308        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
1309        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
1310     - 3gpp PM-Mapper
1311        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
1312        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
1313     - BBS Event processor
1314        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
1315        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
1316     - SON-Handler
1317        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
1318        - Description: Supports PC-ANR optimization analysis and generating CL events output
1319     - Heartbeat MS
1320        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
1321        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
1322
1323
1324 **Upgrade Notes**
1325
1326 The following components are upgraded from R3
1327     - Cloudify Manager:
1328        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
1329        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
1330     - K8S Bootstrap container:
1331        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
1332        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
1333     - Configuration Binding Service:
1334        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
1335        - Description: Code optimization and bug fixes
1336     - Deployment Handler
1337        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
1338        - Include updates for health and service endpoint check and bug fixes
1339     - Policy Handler
1340        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
1341        - Description: Policy Handler supports the new lifecycle API's from Policy framework
1342     - Service Change Handler
1343        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
1344        - Description: No update from R3
1345     - Inventory API
1346        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
1347        - Description: Refactoring and updates for health and service endpoint check
1348     - VES Collector
1349        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
1350        - Description : Authentication enhancement, refactoring and bug-fixes
1351     - Threshold Crossing Analytics
1352        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
1353        - 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.
1354     - DataFile Collector
1355        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
1356        - Description : Code optimization, bug fixes, logging and performance improvement
1357     - PNF Registrator handler
1358        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
1359        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
1360     - HV-VES Collector
1361        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
1362        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
1363     - SNMP Trap Collector
1364        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
1365        - Description : Code coverage improvements
1366
1367
1368
1369
1370 Version: 3.0.1
1371 ==============
1372
1373 :Release Date: 2019-01-31
1374
1375 DCAE R3 Maintenance release includes following fixes
1376
1377 **Bug Fixes**
1378
1379 - DataFileCollector
1380      - DCAEGEN2-940
1381        Larger files of size 100Kb publish to DR
1382      - DCAEGEN2-941
1383        DFC error after running over 12 hours
1384      - DCAEGEN2-1001
1385        Multiple Fileready notification not handled
1386
1387 - HighVolume VES Collector (protobuf/tcp)
1388      - DCAEGEN2-976
1389        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
1390
1391 - VESCollector (http)
1392      - DCAEGEN2-1035
1393        Issue with VES batch event publish
1394
1395 - Heat deployment
1396      - DCAEGEN2-1007
1397        Removing obsolete services configuration
1398
1399
1400 The following containers are updated in R3.0.1
1401
1402     - DataFile Collector
1403        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
1404     - HV-VES Collector
1405        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
1406     - VES Collector
1407        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
1408
1409 **Known Issues**
1410
1411 - 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
1412
1413 - 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
1414     kubectl get deployments -n onap | grep deployment-handler
1415     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
1416     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
1417
1418
1419
1420
1421 Version: 3.0.0
1422 --------------
1423
1424 :Release Date: 2018-11-30
1425
1426 **New Features**
1427
1428 DCAE R3 improves upon previous release with the following new features:
1429
1430 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
1431     - Platform components
1432         - Cloudify Manager
1433         - Bootstrap container
1434         - Configuration Binding Service
1435         - Deployment Handler
1436         - Policy Handler
1437         - Service Change Handler
1438         - Inventory API
1439     - Service components
1440         - VES Collector
1441         - SNMP Collector
1442         - Threshold Crossing Analytics
1443         - Holmes Rule Management *
1444         - Holmes Engine Management *
1445     - Additional resources that DCAE utilizes:
1446         - Postgres Database
1447         - Redis Cluster Database
1448         - Consul Cluster
1449
1450     Notes:
1451         \*  These components are delivered by the Holmes project.
1452
1453 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
1454
1455     - 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".
1456     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1457
1458 - 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.
1459
1460 - All DCAE components are designed to support platform maturity requirements.
1461
1462
1463 **Source Code**
1464
1465 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1466     - dcaegen2
1467     - dcaegen2.analytics
1468     - dcaegen2.analytics.tca
1469     - dcaegen2.collectors
1470     - dcaegen2.collectors.snmptrap
1471     - dcaegen2.collectors.ves
1472     - dcaegen2.collectors.hv-ves
1473     - dcaegen2.collectors.datafile
1474     - dcaegen2.deployments
1475     - dcaegen2.platform
1476     - dcaegen2.platform.blueprints
1477     - dcaegen2.platform.cli
1478     - dcaegen2.platform.configbinding
1479     - dcaegen2.platform.deployment-handler
1480     - dcaegen2.platform.inventory-api
1481     - dcaegen2.platform.plugins
1482     - dcaegen2.platform.policy-handler
1483     - dcaegen2.platform.servicechange-handler
1484     - dcaegen2.services.heartbeat
1485     - dcaegen2.services.mapper
1486     - dcaegen2.services.prh
1487     - dcaegen2.utils
1488
1489 **Bug Fixes**
1490
1491 **Known Issues**
1492
1493 - 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.
1494
1495 **Security Notes**
1496
1497 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>`_.
1498
1499 Quick Links:
1500         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1501
1502         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1503
1504         - `Project Vulnerability Review Table for DCAE (Casablanca) <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
1505
1506
1507 **New component Notes**
1508 The following components are introduced in R3
1509
1510     - DataFile Collector
1511        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
1512        - Description : Bulk data file collector to fetch non-realtime PM data
1513     - PNF Registrator handler
1514        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
1515        - Description : Recieves VES registration event and updates AAI and SO
1516     - HV-VES Collector
1517        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
1518        - Description : High Volume VES Collector for fetching real-time PM measurement data
1519     - SNMP Trap Collector
1520        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
1521        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
1522
1523
1524 **Upgrade Notes**
1525
1526 The following components are upgraded from R2:
1527     - Cloudify Manager:
1528        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
1529        - 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.
1530     - Bootstrap container:
1531        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
1532        - 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.
1533     - Configuration Binding Service:
1534        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
1535        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
1536     - Deployment Handler
1537        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
1538     - Policy Handler
1539        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
1540        - Description: Policy Handler now supports the new configuration policy format and support for TLS
1541     - Service Change Handler
1542        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
1543        - Description: Refactoring.
1544     - Inventory API
1545        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
1546        - Description: Refactoring.
1547     - VES Collector
1548        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
1549        - Description : Refactoring
1550     - Threshold Crossing Analytics
1551        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1552        - 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.
1553
1554
1555
1556
1557 Version: 2.0.0
1558 ==============
1559
1560 :Release Date: 2018-06-07
1561
1562 **New Features**
1563
1564 DCAE R2 improves upon previous release with the following new features:
1565
1566 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
1567     - Platform components
1568         - Cloudify Manager
1569         - Bootstrap container
1570         - Configuration Binding Service
1571         - Deployment Handler
1572         - Policy Handler
1573         - Service Change Handler
1574         - Inventory API
1575     - Service components
1576         - VES Collector
1577         - SNMP Collector
1578         - Threshold Crossing Analytics
1579         - Holmes Rule Management *
1580         - Holmes Engine Management *
1581     - Additional resources that DCAE utilizes:
1582         - Postgres Database
1583         - Redis Cluster Database
1584         - Consul Cluster
1585
1586     Notes:
1587         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
1588
1589 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
1590
1591     - 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".
1592     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1593
1594 - 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.
1595
1596 - All DCAE components are designed to support platform maturity requirements.
1597
1598
1599 **Source Code**
1600
1601 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1602     - dcaegen2
1603     - dcaegen2.analytics
1604     - dcaegen2.analytics.tca
1605     - dcaegen2.collectors
1606     - dcaegen2.collectors.snmptrap
1607     - dcaegen2.collectors.ves
1608     - dcaegen2.deployments
1609     - dcaegen2.platform
1610     - dcaegen2.platform.blueprints
1611     - dcaegen2.platform.cli
1612     - dcaegen2.platform.configbinding
1613     - dcaegen2.platform.deployment-handler
1614     - dcaegen2.platform.inventory-api
1615     - dcaegen2.platform.plugins
1616     - dcaegen2.platform.policy-handler
1617     - dcaegen2.platform.servicechange-handler
1618     - dcaegen2.services.heartbeat
1619     - dcaegen2.services.mapper
1620     - dcaegen2.services.prh
1621     - dcaegen2.utils
1622
1623 **Bug Fixes**
1624
1625 **Known Issues**
1626
1627 - 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.
1628
1629 **Security Notes**
1630
1631 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>`_.
1632
1633 Quick Links:
1634         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1635
1636         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1637
1638         - `Project Vulnerability Review Table for DCAE (Beijing) <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
1639
1640
1641
1642 **Upgrade Notes**
1643
1644 The following components are upgraded from R1:
1645     - Cloudify Manager:
1646        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
1647        - 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.
1648     - Bootstrap container:
1649        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
1650        - 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.
1651     - Configuration Binding Service:
1652        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
1653        - Description: Configuration Binding Sevice now supports the new configuration policy format.
1654     - Deployment Handler
1655        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
1656     - Policy Handler
1657        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
1658        - Description: Policy Handler now supports the new configuration policy format.
1659     - Service Change Handler
1660        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
1661        - Description: Refactoring.
1662     - Inventory API
1663        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
1664        - Description: Refactoring.
1665     - VES Collector
1666        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
1667     - Threshold Crossing Analytics
1668        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1669        - 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.
1670
1671
1672
1673 Version: 1.0.0
1674 ==============
1675
1676 :Release Date: 2017-11-16
1677
1678
1679 **New Features**
1680
1681 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
1682 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
1683 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
1684 vDNS, vCPU, and vVoLTE.
1685
1686 Specifically, DCAE R1 includes the following components:
1687
1688 - Core platform
1689     - Cloudify manager
1690     - Consul cluster
1691 - Extended platform
1692     - Platform component docker host
1693     - Service component docker host
1694     - CDAP cluster
1695     - PostgreSQL database (*)
1696 - Platform docker container components
1697     - Configuration binding service
1698     - Deployment handler
1699     - Service change handler
1700     - Inventory
1701     - Policy handler
1702     - CDAP broker
1703 - Service components
1704     - Docker container components
1705         - VNF Event Streaming (VES) collector
1706         - Holmes (engine and rule management) **
1707     - CDAP analytics component
1708         - Threshold Crossing Analytics (TCA)
1709
1710 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
1711 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
1712 other deployment configurations not used in the R1 demos.)
1713 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
1714 in R1.
1715
1716 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
1717
1718 - dcaegen2
1719 - dcaegen2/analytics
1720 - dcaegen2/analytics/tca
1721 - dcaegen2/collectors
1722 - dcaegen2/collectors/snmptrap
1723 - dcaegen2/collectors/ves
1724 - dcaegen2/deployments
1725 - dcaegen2/platform
1726 - dcaegen2/platform/blueprints
1727 - dcaegen2/platform/cdapbroker
1728 - dcaegen2/platform/cli
1729 - dcaegen2/platform/configbinding
1730 - dcaegen2/platform/deployment-handler
1731 - dcaegen2/platform/inventory-api
1732 - dcaegen2/platform/plugins
1733 - dcaegen2/platform/policy-handler
1734 - dcaegen2/platform/servicechange-handler
1735 - dcaegen2/utils
1736
1737
1738 **Bug Fixes**
1739
1740 This is the initial release.
1741
1742
1743 **Known Issues**
1744
1745 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
1746 - Need to provide a dev configuration DCAE.
1747
1748
1749 **Security Issues**
1750
1751 - 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>`_.>`_.
1752 - 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.
1753
1754
1755 **Upgrade Notes**
1756
1757 This is the initial release.
1758
1759
1760 **Deprecation Notes**
1761
1762 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
1763 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
1764 following Gerrit repos are voided and already locked as read-only.
1765
1766 - dcae
1767 - dcae/apod
1768 - dcae/apod/analytics
1769 - dcae/apod/buildtools
1770 - dcae/apod/cdap
1771 - dcae/collectors
1772 - dcae/collectors/ves
1773 - dcae/controller
1774 - dcae/controller/analytics
1775 - dcae/dcae-inventory
1776 - dcae/demo
1777 - dcae/demo/startup
1778 - dcae/demo/startup/aaf
1779 - dcae/demo/startup/controller
1780 - dcae/demo/startup/message-router
1781 - dcae/dmaapbc
1782 - dcae/operation
1783 - dcae/operation/utils
1784 - dcae/orch-dispatcher
1785 - dcae/pgaas
1786 - dcae/utils
1787 - dcae/utils/buildtools
1788 - ncomp
1789 - ncomp/cdap
1790 - ncomp/core
1791 - ncomp/docker
1792 - ncomp/maven
1793 - ncomp/openstack
1794 - ncomp/sirius
1795 - ncomp/sirius/manager
1796 - ncomp/utils
1797
1798
1799 **Other**
1800
1801 SNMP trap collector is seed code delivery only.