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