docs/sections/release-notes.rst

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