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