docs/sections/version_10.0.0.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ..      ==========================
   5 ..      * * *    JAKARTA    * * *
   6 ..      ==========================
   7
   8
   9 Version: 10.0.0
  10 ===============
  11
  12
  13 Abstract
  14 --------
  15
  16 This document provides the release notes for Jakarta release.
  17
  18 Summary
  19 -------
  20
  21 With DCAE transformation to HELM completed this release, all Cloudify/platform handler components have been retired
  22 and only helm based MS deployment mode is supported.
  23 The following DCAE components are available with default ONAP/DCAE installation:
  24
  25     - Service components
  26         - VES Collector
  27         - HV-VES Collector
  28         - PNF-Registration Handler
  29         - Docker based Threshold Crossing Analytics (TCA-Gen2)
  30         - VES OpenAPI Manager
  31
  32     - Additional resources that DCAE utilizes are deployed using ONAP common charts:
  33
  34         - Postgresql Database
  35         - Mongo Database
  36
  37
  38 These service components (mS) are available to be deployed on-demand via helm:
  39
  40         - SNMPTrap Collector
  41         - RESTConf Collector
  42         - DataFile Collector
  43         - PM-Mapper
  44         - VES Mapper
  45         - Heartbeat mS
  46         - SON-Handler
  47         - PM-Subscription Handler
  48         - DataLake Handler (Admin and Feeder)
  49         - Slice Analysis mS
  50         - DataLake Extraction Service
  51         - KPI-Ms
  52
  53
  54 Under OOM all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into a Kubernetes cluster.
  55
  56 For Helm managed microservices, the dependencies/pre-requisite are identified on each chart individually.
  57 In general, most DCAE microservice rely on Configmap for sourcing configuration updates. Each microservice can be deployed independently and based on the dcaegen2-services-common template, features can be enabled or disabled via a configuration override during deployment.
  58
  59 For a list of supported features in helm, refer to :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
  60
  61
  62 Release Data
  63 ------------
  64
  65 +--------------------------------------+--------------------------------------------------------+
  66 | **DCAE Project**                     |                                                        |
  67 |                                      |                                                        |
  68 +--------------------------------------+--------------------------------------------------------+
  69 | **Docker images**                    | Refer :any:`Deliverable <jakarta_deliverable>`         |
  70 |                                      |                                                        |
  71 +--------------------------------------+--------------------------------------------------------+
  72 | **Release designation**              | 10.0.0 Jakarta                                         |
  73 |                                      |                                                        |
  74 +--------------------------------------+--------------------------------------------------------+
  75 | **Release date**                     | 2022-06-02                                             |
  76 |                                      |                                                        |
  77 +--------------------------------------+--------------------------------------------------------+
  78
  79
  80 New features
  81 ------------
  82
  83 *DCAE Enhancements and Features*
  84
  85 DCAEGEN2-3021 DCAE Impacts for E2E Network Slicing in Jakarta release
  86     - Slice selection taking into consideration resource occupancy levels
  87     - IBN based Closed loop for Network Slicing
  88
  89 DCAEGEN2-3063 CCVPN Jakarta Enhancements for Intent-based Cloud Leased Line and Closed-loop
  90     - Support bandwidth evaluation and CL event generation
  91     - AAI Interface for bandwidth update notification
  92
  93 DCAEGEN2-2773 DCAE Helm Transformation (Phase 3/Final)
  94     - Removed Consul dependency across all DCAE service components.
  95     - All DCAE microservices migrated to use latest CBS SDK library to support configmap/policy retrieval
  96     - Enhancement on DCAE common template for DR Feed pub/sub configuration consistency and disable Consul loader
  97     - DCAEMOD enhanced to support Helm chart generation for onboarded MS/flows
  98     - Cloudify and related Handlers removal from ONAP/DCAE Deployment
  99     - v3 spec introduced for MOD Helm flow support
 100
 101 DCAEGEN2-2906 - Bulk PM / PM Data Control Improvements (PMSH)
 102     - PMSH functional enhancement and support for dynamic filter/subscription change via API
 103
 104 DCAEGEN2-3031 - Topic alignment for DCAE microservices
 105     - Migrate DCAE MS to use standard topics for PM-Mapper, Slice-Analysis, KPI-MS
 106
 107
 108 *Non-Functional*
 109
 110    - DCAEGEN2-2829 - CII Badging improvements
 111    - DCAEGEN2-3006 - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector,RESTConf, VES,Mapper, PM-Mapper, PRH, SON-handler, KPI-MS, Slice-Analysis MS, DCAE-SDK, VES OpenAPI Manager)
 112    - DCAEGEN2-2961/DCAEGEN2-2962/DCAEGEN2-2963 - Removed GPLv3 license from software by switching to onap/integration base images for VESCollector, RESTConf, SliceAnalysis MS
 113    - DCAEGEN2-2958 - STDOUT log compliance for DCAE SNMPTRap collector and Healthcheck container
 114
 115
 116
 117
 118 .. _jakarta_deliverable:
 119
 120 Deliverables
 121 ------------
 122
 123 Software Deliverables
 124
 125 .. csv-table::
 126    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 127    :widths: auto
 128
 129    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.3.2"
 130    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.7.1"
 131    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.10.0"
 132    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.3.2"
 133    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.6"
 134    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.11.0"
 135    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.4.0"
 136    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
 137    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
 138    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
 139    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
 140    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
 141    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
 142    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
 143    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
 144    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.2"
 145    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.7"
 146    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.1.0"
 147    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
 148    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
 149    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
 150    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:2.2.2"
 151    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.1.3"
 152    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.4"
 153    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.3.1"
 154    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.4.0"
 155    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.8.0"
 156    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.8.0"
 157    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.7"
 158    "dcaegen2/platform", "mod2/helm-generator", "Helm Generator 1.0.3 (jar)"
 159    "dcaegen2/services/sdk", "", "DCAE SDK 1.8.8 (jar)"
 160
 161 The following repositories (and containers) have been deprecated with this release.
 162
 163 .. csv-table::
 164    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 165    :widths: auto
 166
 167    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.6.1"
 168    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.1"
 169    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
 170    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.3.5"
 171    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.4"
 172    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
 173    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"
 174    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.3"
 175    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
 176    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.1.1"
 177    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.4"
 178
 179
 180 Known Limitations, Issues and Workarounds
 181 -----------------------------------------
 182
 183 DCAEGEN2-2861 - Topic/feed provisioned through Helm require manual cleanup once the helm deployed service are uninstalled.
 184 Refer following document  :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>` for steps to remove topic/feed provisioned in DMAAP.
 185
 186
 187 *Known Vulnerabilities*
 188
 189 None
 190
 191 *Workarounds*
 192
 193 Documented under corresponding jira if applicable.
 194
 195 Security Notes
 196 --------------
 197
 198 *Fixed Security Issues*
 199
 200     Documented on earlier section
 201
 202 *Known Security Issues*
 203
 204     None
 205
 206 *Known Vulnerabilities in Used Modules*
 207
 208     None
 209
 210 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/display/SV/Jakarta+DCAE>`_.
 211
 212 Test Results
 213 ------------
 214
 215  - `DCAE R10 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Jakarta+Release>`_
 216  - `DCAE R10 Functional Test <https://wiki.onap.org/display/DW/DCAE+R10+Testplan>`_
 217
 218
 219 References
 220 ----------
 221
 222 For more information on the ONAP Jakarta release, please see:
 223
 224 #. `ONAP Home Page`_
 225 #. `ONAP Documentation`_
 226 #. `ONAP Release Downloads`_
 227 #. `ONAP Wiki Page`_
 228
 229
 230 .. _`ONAP Home Page`: https://www.onap.org
 231 .. _`ONAP Wiki Page`: https://wiki.onap.org
 232 .. _`ONAP Documentation`: https://docs.onap.org
 233 .. _`ONAP Release Downloads`: https://git.onap.org
 234
 235 Quick Links:
 236
 237         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 238         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_