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