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