docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Policy Release Notes
   4 ====================
   5
   6 .. note
   7 ..      * This Release Notes must be updated each time the team decides to Release new artifacts.
   8 ..      * The scope of these Release Notes are for ONAP POLICY. In other words, each ONAP component has its Release Notes.
   9 ..      * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of
  10 ..      * this Release Notes.
  11 ..      * Except the date and the version number, all the other sections are optional but there must be at least
  12 ..      * one section describing the purpose of this new release.
  13 ..      * This note must be removed after content has been added.
  14
  15 ..      ==========================
  16 ..      * * *     EL ALTO    * * *
  17 ..      ==========================
  18
  19 Version: 5.0.1
  20 --------------
  21
  22 :Release Date: 2019-09-30 (El Alto Release)
  23
  24 **New Features**
  25
  26 Artifacts released:
  27
  28 .. csv-table::
  29    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
  30    :widths: 15,10,10
  31
  32    "policy/parent", "3.0.0", ""
  33    "policy/common", "1.5.0", ""
  34    "policy/models", "2.1.2", ""
  35    "policy/api", "2.1.1", "onap/policy-api:2.1.1"
  36    "policy/pap", "2.1.1", "onap/policy-pap:2.1.1"
  37    "policy/drools-pdp", "1.5.1", "onap/policy-drools:1.5.1"
  38    "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
  39    "policy/xacml-pdp", "2.1.1", "onap/policy-xacml-pdp:2.1.1"
  40    "policy/drools-applications", "1.5.1", "onap/policy-pdpd-cl:1.5.1"
  41    "policy/engine", "1.5.1", "onap/policy-pe:1.5.1"
  42    "policy/distribution", "2.2.0", "onap/policy-distribution:2.2.0"
  43    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
  44
  45 The El Alto release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the El Alto release, refer to `JiraPolicyElAlto`_.
  46
  47     * [POLICY-1727] - This epic covers technical debt left over from Dublin
  48         - POLICY-969    Docker improvement in policy framwork modules
  49         - POLICY-1074   Fix checkstyle warnings in every repository
  50         - POLICY-1121   RPM build for Apex
  51         - POLICY-1223   CII Silver Badging Requirements
  52         - POLICY-1600   Clean up hash code equality checks, cloning and copying in policy-models
  53         - POLICY-1646   Replace uses of getCanonicalName() with getName()
  54         - POLICY-1652   Move PapRestServer to policy/common
  55         - POLICY-1732   Enable maven-checkstyle-plugin in apex-pdp
  56         - POLICY-1737   Upgrade oParent 2.0.0 - change daily jobs to staging jobs
  57         - POLICY-1742   Make HTTP return code handling configurable in APEX
  58         - POLICY-1743   Make URL configurable in REST Requestor and REST Client
  59         - POLICY-1744   Remove topic.properties and incorporate into overall properties
  60         - POLICY-1770   PAP REST API for PDPGroup Healthcheck
  61         - POLICY-1771   Boost policy/api JUnit code coverage
  62         - POLICY-1772   Boost policy/xacml-pdp JUnit code coverage
  63         - POLICY-1773   Enhance the policy/xacml-pdp S3P Stability and Performance tests
  64         - POLICY-1784   Better Handling of "version" field value with clients
  65         - POLICY-1785   Deploy same policy with a new version simply adds to the list
  66         - POLICY-1786   Create a simple way to populate the guard database for testing
  67         - POLICY-1791   Address Sonar issues in new policy repos
  68         - POLICY-1795   PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
  69         - POLICY-1800   API|PAP components use different version formats
  70         - POLICY-1805   Build up stability test for api component to follow S3P requirements
  71         - POLICY-1806   Build up S3P performance test for api component
  72         - POLICY-1825   Enhance the policy/drools-pdp S3P Stability and Performance tests
  73         - POLICY-1847   Add control loop coordination as a preloaded policy type
  74         - POLICY-1871   Change policy/distribution to support ToscaPolicyType & ToscaPolicy
  75         - POLICY-1881   Upgrade policy/distribution to latest SDC artifacts
  76         - POLICY-1885   Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
  77         - POLICY-1898   Move apex-pdp & distribution documents to policy/parent
  78         - POLICY-1942   Boost policy/apex-pdp JUnit code coverage
  79         - POLICY-1953   Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
  80
  81     * Additional items delivered with the release.
  82         - POLICY-1637   Remove "version" from PdpGroup
  83         - POLICY-1653   Remove isNullVersion() method
  84         - POLICY-1966   Fix more sonar issues in policy drools
  85         - POLICY-1988   Generate El Alto AAF Certificates
  86
  87     * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
  88         - POLICY-1762   Create CDS API model implementation
  89         - POLICY-1763   Create CDS Actor
  90         - POLICY-1899   Update optimization xacml application to support more flexible Decision API
  91         - POLICY-1911   XACML PDP must be able to retrieve Policy Type from API
  92
  93
  94 **Bug Fixes**
  95
  96 The following bug fixes have been deployed with this release:
  97
  98     * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
  99     * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
 100     * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
 101     * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
 102     * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
 103     * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
 104     * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
 105     * `[POLICY-1807] <https://jira.onap.org/browse/POLICY-1807>`_ - Latest version is always returned when using the endpoint to retrieve all versions of a particular policy
 106     * `[POLICY-1808] <https://jira.onap.org/browse/POLICY-1808>`_ - API|PAP|PDP-X [new] should publish docker images with the following tag X.Y-SNAPSHOT-latest
 107     * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
 108     * `[POLICY-1811] <https://jira.onap.org/browse/POLICY-1811>`_ - The endpoint of retrieving the latest version of TOSCA policy does not return the latest one, especially when there are double-digit versions
 109     * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
 110     * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
 111     * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model  currently needs to be escaped
 112     * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
 113     * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
 114     * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
 115     * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
 116     * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
 117     * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
 118     * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
 119
 120
 121 **Security Notes**
 122
 123 *Fixed Security Issues*
 124
 125 *Known Security Issues*
 126
 127 *Known Vulnerabilities in Used Modules*
 128
 129 POLICY 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 POLICY open Critical security vulnerabilities and their risk assessment have been documented as part of the `project (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_.
 130
 131 Quick Links:
 132     - `POLICY project page`_
 133     - `Passing Badge information for POLICY`_
 134     - `Project Vulnerability Review Table for POLICY (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_
 135
 136 **Known Issues**
 137
 138 The following known issues will be addressed in a future release:
 139
 140     * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
 141     * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
 142     * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
 143     * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
 144     * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
 145     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
 146     * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
 147
 148
 149 ..      ==========================
 150 ..      * * *      DUBLIN    * * *
 151 ..      ==========================
 152
 153 Version: 4.0.0
 154 --------------
 155
 156 :Release Date: 2019-06-26 (Dublin Release)
 157
 158 **New Features**
 159
 160 Artifacts released:
 161
 162 .. csv-table::
 163    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
 164    :widths: 15,10,10
 165
 166    "policy/parent", "2.1.0", ""
 167    "policy/common", "1.4.0", ""
 168    "policy/models", "2.0.2", ""
 169    "policy/api", "2.0.1", "onap/policy-api:2.0.1"
 170    "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
 171    "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
 172    "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
 173    "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
 174    "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
 175    "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
 176    "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
 177    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
 178
 179 The Dublin release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Dublin release, refer to `JiraPolicyDublin`_.
 180
 181     * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
 182         - POLICY-1195   Separate model code from drools-applications into other repositories
 183         - POLICY-1367   Spike - Experimentation for management of Drools templates and Operational Policies
 184         - POLICY-1397   PDP-D: NOOP Endpoints Support to test Operational Policies.
 185         - POLICY-1459   PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
 186
 187     * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
 188         - POLICY-1007   Remove Jackson from policy framework components
 189         - POLICY-1202   policy-engine & apex-pdp are using different version of eclipselink
 190         - POLICY-1250   Fix issues reported by sonar in policy modules
 191         - POLICY-1368   Remove hibernate from policy repos
 192         - POLICY-1457   Use Alpine in base docker images
 193
 194     * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
 195         - S3P Performance related items
 196
 197     * [POLICY-1171] - Enhance CLC Facility
 198         - POLICY-1173   High-level specification of coordination directives
 199
 200     * [POLICY-1220] - This epic covers the work to support S3P Security criteria
 201         - POLICY-1538   Upgrade Elasticsearch to 6.4.x to clear security issue
 202
 203     * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
 204         - POLICY-1270   Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
 205         - POLICY-1271   PAP RESTful HealthCheck/Statistics Main Entry Point
 206         - POLICY-1272   Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
 207         - POLICY-1273   Policy Type Application Design Requirements
 208         - POLICY-1436   XACML PDP RESTful HealthCheck/Statistics Main Entry Point
 209         - POLICY-1440   XACML PDP RESTful Decision API Main Entry Point
 210         - POLICY-1441   Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
 211         - POLICY-1442   Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
 212         - POLICY-1443   PAP Dmaap PDP Register/UnRegister Main Entry Point
 213         - POLICY-1444   PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
 214         - POLICY-1445   XACML PDP upgrade to xacml 2.0.0
 215         - POLICY-1446   Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
 216         - POLICY-1447   Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
 217         - POLICY-1449   XACML PDP Dmaap Register/UnRegister Functionality
 218         - POLICY-1451   XACML PDP Dmaap Deploy/UnDeploy Functionality
 219         - POLICY-1452   Apex PDP Dmaap Register/UnRegister Functionality
 220         - POLICY-1453   Apex PDP Dmaap Deploy/UnDeploy Functionality
 221         - POLICY-1454   Drools PDP Dmaap Register/UnRegister Functionality
 222         - POLICY-1455   Drools PDP Dmaap Deploy/UnDeploy Functionality
 223         - POLICY-1456   Policy Architecture and Roadmap Documentation
 224         - POLICY-1458   Create S3P JMeter Tests for Policy API
 225         - POLICY-1460   Create S3P JMeter Tests for PAP
 226         - POLICY-1461   Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
 227         - POLICY-1462   Create S3P JMeter Tests for Policy SDC Distribution
 228         - POLICY-1471   Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
 229         - POLICY-1474   Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
 230         - POLICY-1515   Prototype Policy Lifecycle API Swagger Entry Points
 231         - POLICY-1516   Prototype the Policy Decision API
 232         - POLICY-1541   PAP REST API for PDPGroup Query, Statistics & Delete
 233         - POLICY-1542   PAP REST API for PDPGroup Deployment, State Management & Health Check
 234
 235     * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
 236         - Model drive control loop related items
 237
 238     * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
 239         - POLICY-1405   Develop SDNC API for trigger bandwidth
 240
 241     * [POLICY-1408] - This epic covers the work done with the Casablanca release
 242         - POLICY-1410   List Policy API
 243         - POLICY-1413   Dashboard enhancements
 244         - POLICY-1414   Push Policy and DeletePolicy API enhancement
 245         - POLICY-1416   Model enhancements to support CLAMP
 246         - POLICY-1417   Resiliency improvements
 247         - POLICY-1418   PDP APIs - make ClientAuth optional
 248         - POLICY-1419   Better multi-role support
 249         - POLICY-1420   Model enhancement to support embedded JSON
 250         - POLICY-1421   New audit data for push/delete
 251         - POLICY-1422   Enhanced encryption
 252         - POLICY-1423   Save original model file
 253         - POLICY-1427   Controller Logging Feature
 254         - POLICY-1489   PDP-D: Nested JSON Event Filtering support with JsonPath
 255         - POLICY-1499   Mdc Filter Feature
 256
 257     * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
 258         - POLICY-1463   Functional code changes in Policy for OOF SON use case
 259         - POLICY-1464   Config related aspects for OOF SON use case
 260
 261     * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
 262         - POLICY-1278   AAI named-queries are being deprecated and should be replaced with custom-queries
 263         - POLICY-1545   E2E Automation - Parse the newly added model ids from operation policy
 264
 265     * Additional items delivered with the release.
 266         - POLICY-1159   Move expectException to policy-common/utils-test
 267         - POLICY-1176   Work on technical debt introduced by CLC POC
 268         - POLICY-1266   A&AI Modularity
 269         - POLICY-1274   further improvement in PSSD S3P test
 270         - POLICY-1401   Build onap.policies.Monitoring TOSCA Policy Template
 271         - POLICY-1465   Support configurable Heap Memory Settings for JVM processes
 272
 273
 274 **Bug Fixes**
 275
 276 The following bug fixes have been deployed with this release:
 277
 278     * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
 279     * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
 280     * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
 281     * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
 282     * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
 283
 284 **Security Notes**
 285
 286 *Fixed Security Issues*
 287
 288     * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
 289     * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
 290     * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
 291     * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
 292
 293 *Known Security Issues*
 294
 295 *Known Vulnerabilities in Used Modules*
 296
 297 POLICY 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 POLICY open Critical security vulnerabilities and their risk assessment have been documented as part of the `project (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_.
 298
 299 Quick Links:
 300     - `POLICY project page`_
 301     - `Passing Badge information for POLICY`_
 302     - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
 303
 304
 305 **Known Issues**
 306
 307 The following known issues will be addressed in a future release:
 308
 309     * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
 310     * `[POLICY-1810] - <https://jira.onap.org/browse/POLICY-1810>`_ API: ensure that the REST APISs (URLs) are supported and consistent regardless the type of policy: operational, guard, tosca-compliant.
 311     * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
 312     * `[POLICY-1378] - <https://jira.onap.org/browse/POLICY-1378>`_ add support to append value into policyScope while one policy could be used by several services
 313     * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
 314     * `[POLICY-1671] - <https://jira.onap.org/browse/POLICY-1671>`_ policy/engine JUnit tests now take over 30 minutes to run
 315     * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
 316     * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
 317     * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
 318     * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
 319     * `[POLICY-1808] - <https://jira.onap.org/browse/POLICY-1808>`_ API|PAP|PDP-X [new] should publish docker images with the following tag X.Y-SNAPSHOT-latest
 320     * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
 321     * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
 322     * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
 323     * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
 324     * `[POLICY-1872] - <https://jira.onap.org/browse/POLICY-1872>`_ brmsgw fails building a jar - trafficgenerator dependency does not exist
 325
 326
 327 ..      ==========================
 328 ..      * * *   CASABLANCA   * * *
 329 ..      ==========================
 330
 331 Version: 3.0.2
 332 --------------
 333
 334 :Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
 335
 336 The following items were deployed with the Casablanca Maintenance Release:
 337
 338 **Bug Fixes**
 339
 340     * [POLICY-1522] - Policy doesn't send "payload" field to APPC
 341
 342 **Security Fixes**
 343
 344     * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
 345
 346 **License Issues**
 347
 348     * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
 349
 350 **Known Issues**
 351
 352 The following known issue will be addressed in a future release.
 353
 354     * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
 355
 356 A workaround for this issue consists in bypassing the Portal UI when accessing the Policy UI.   See `PAP recipes <https://docs.onap.org/en/casablanca/submodules/policy/engine.git/docs/platform/cookbook.html?highlight=policy%20cookbook#id23>`_ for the specific procedure.
 357
 358
 359 Version: 3.0.1
 360 --------------
 361
 362 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
 363
 364 The following items were deployed with the Casablanca Maintenance Release:
 365
 366 **New Features**
 367
 368     * [POLICY-1221] - Policy distribution application to support HTTPS communication
 369     * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
 370
 371 **Bug Fixes**
 372
 373     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
 374     * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
 375
 376
 377 Version: 3.0.0
 378 --------------
 379
 380 :Release Date: 2018-11-30 (Casablanca Release)
 381
 382 **New Features**
 383
 384 The Casablanca release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Casablanca release, refer to `JiraPolicyCasablanca`_ (Note: Jira details can also be viewed from this link).
 385
 386     * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
 387
 388     The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
 389
 390     * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
 391     * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
 392     * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
 393
 394     The policy team did some forward looking spike work towards re-building the Software Architecture.
 395
 396     * [POLICY-809] - Maintain and implement performance
 397     * [POLICY-814] - 72 hour stability testing (component and platform)
 398
 399     The policy team made enhancements to the Drools PDP to further support S3P Performance.
 400     For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
 401     performance standard and performed 72 hour stability tests.
 402
 403     * [POLICY-824] - maintain and implement security
 404
 405     The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
 406     MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
 407
 408     * [POLICY-840] - Flexible control loop coordination facility.
 409
 410     Work towards a POC for control loop coordination policies were implemented.
 411
 412     * [POLICY-841] - Covers the work required to support HPA
 413
 414     Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
 415
 416     * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
 417
 418     Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
 419
 420     * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
 421
 422     A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
 423     sonar issues, and checkstyle.
 424
 425     * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
 426
 427     Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
 428
 429     * [POLICY-1182] - Covers the work to support CCVPN use case
 430
 431     Policy templates changes were submitted that supported the CCVPN use case.
 432
 433 **Bug Fixes**
 434
 435 The following bug fixes have been deployed with this release:
 436
 437     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
 438     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
 439     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
 440     * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
 441     * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
 442     * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
 443     * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
 444     * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
 445
 446
 447 **Security Notes**
 448
 449 POLICY 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 POLICY open Critical security vulnerabilities and their risk assessment have been documented as part of the `project (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_.
 450
 451 Quick Links:
 452     - `POLICY project page`_
 453     - `Passing Badge information for POLICY`_
 454     - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
 455
 456 **Known Issues**
 457
 458     * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
 459     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
 460
 461
 462
 463 ..      =======================
 464 ..      * * *   BEIJING   * * *
 465 ..      =======================
 466
 467 Version: 2.0.0
 468 --------------
 469
 470 :Release Date: 2018-06-07 (Beijing Release)
 471
 472 **New Features**
 473
 474 The Beijing release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Beijing release, refer to `JiraPolicyBeijing`_.
 475
 476     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
 477         - POLICY-238    policy/drools-applications: clean up maven structure
 478         - POLICY-336    Address Technical Debt
 479         - POLICY-338    Address JUnit Code Coverage
 480         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
 481         - POLICY-389    Cleanup Jenkin's CI/CD process's
 482         - POLICY-449    Policy API + Console : Common Policy Validation
 483         - POLICY-568    Integration with org.onap AAF project
 484         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
 485
 486     * [POLICY-391] - This epic covers the work to support Release Planning activities
 487         - POLICY-552    ONAP Licensing Scan - Use Restrictions
 488
 489     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
 490         - POLICY-529    Platform Maturity Performance - Drools PDP
 491         - POLICY-567    Platform Maturity Performance - PDP-X
 492
 493     * [POLICY-394] - This epic covers the work required to support a Policy developer environment in which Policy Developers can create, update policy templates/rules separate from the policy Platform runtime platform.
 494         - POLICY-488    pap should not add rules to official template provided in drools applications
 495
 496     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
 497         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
 498
 499     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
 500         - POLICY-622    Integrate OOF Policy Model into Policy Platform
 501
 502     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
 503         - POLICY-525    Platform Maturity Stability - Drools PDP
 504         - POLICY-526    Platform Maturity Stability - XACML PDP
 505
 506     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
 507         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
 508         - POLICY-528    Platform Maturity Resiliency - Drools PDP
 509         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
 510         - POLICY-585    Platform Maturity Resiliency - XACML PDP
 511         - POLICY-586    Platform Maturity Resiliency - Planning
 512         - POLICY-681    Regression Test Use Cases
 513
 514     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
 515         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
 516
 517     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
 518         - POLICY-531    Platform Maturity Scalability - XACML PDP
 519         - POLICY-532    Platform Maturity Scalability - Drools PDP
 520         - POLICY-623    Docker image re-design
 521
 522     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
 523         - POLICY-533    Platform Maturity Manageability L1 - Logging
 524         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
 525
 526     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
 527         - POLICY-535    Platform Maturity Usability - User Guide
 528         - POLICY-536    Platform Maturity Usability - Deployment Documentation
 529         - POLICY-537    Platform Maturity Usability - API Documentation
 530
 531     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
 532
 533
 534 **Bug Fixes**
 535
 536 The following bug fixes have been deployed with this release:
 537
 538     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
 539     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
 540     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
 541     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
 542     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
 543     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
 544     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
 545     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
 546     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
 547     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
 548     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
 549     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
 550     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
 551     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
 552     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
 553
 554
 555 **Security Notes**
 556
 557 POLICY 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 POLICY open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_.
 558
 559 Quick Links:
 560     - `POLICY project page`_
 561     - `Passing Badge information for POLICY`_
 562     - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
 563
 564 **Known Issues**
 565
 566 The following known issues will be addressed in a future release:
 567
 568     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
 569     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
 570     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
 571     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
 572     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
 573     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
 574     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
 575     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
 576
 577
 578
 579
 580 Version: 1.0.2
 581 --------------
 582
 583 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
 584
 585 **Bug Fixes**
 586
 587 The following fixes were deployed with the Amsterdam Maintenance Release:
 588
 589     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
 590
 591
 592 Version: 1.0.1
 593 --------------
 594
 595 :Release Date: 2017-11-16 (Amsterdam Release)
 596
 597 **New Features**
 598
 599 The Amsterdam release continued evolving the design driven architecture of and functionality for POLICY.  The following is a list of Epics delivered with the release. For a full list of stories and tasks delivered in the Amsterdam release, refer to `JiraPolicyAmsterdam`_.
 600
 601     * [POLICY-31] - Stabilization of Seed Code
 602         - POLICY-25  Replace any remaining openecomp reference by onap
 603         - POLICY-32  JUnit test code coverage
 604         - POLICY-66  PDP-D Feature mechanism enhancements
 605         - POLICY-67  Rainy Day Decision Policy
 606         - POLICY-93  Notification API
 607         - POLICY-158  policy/engine: SQL injection Mitigation
 608         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
 609
 610     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
 611         - POLICY-40  MSB Integration
 612         - POLICY-124  Integration with oparent
 613         - POLICY-41  OOM Integration
 614         - POLICY-119  PDP-D: noop sinks
 615
 616     * [POLICY-34] - This epic covers the work required to support a Policy developer environment in which Policy Developers can create, update policy templates/rules separate from the policy Platform runtime platform.
 617         - POLICY-57  VF-C Actor code development
 618         - POLICY-43  Amsterdam Use Case Template
 619         - POLICY-173  Deployment of Operational Policies Documentation
 620
 621     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
 622         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
 623
 624     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
 625
 626     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
 627         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
 628         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
 629         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
 630         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
 631
 632     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
 633
 634     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
 635         - POLICY-61  vFW Use Case - Runtime
 636         - POLICY-62  vDNS Use Case - Runtime
 637         - POLICY-59  vCPE Use Case - Runtime
 638         - POLICY-60  VOLTE Use Case - Runtime
 639         - POLICY-51  Runtime Policy Update Support
 640         - POLICY-328  vDNS Use Case - Runtime Testing
 641         - POLICY-324  vFW Use Case - Runtime Testing
 642         - POLICY-320  VOLTE Use Case - Runtime Testing
 643         - POLICY-316  vCPE Use Case - Runtime Testing
 644
 645     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
 646         - POLICY-77  Functional Test case definition for Control Loops
 647         - POLICY-387  Deliver the released policy artifacts
 648
 649
 650 **Bug Fixes**
 651     - This is technically the first release of POLICY, previous release was the seed code contribution. As such, the defects fixed in this release were raised during the course of the release. Anything not closed is captured below under Known Issues. For a list of defects fixed in the Amsterdam release, refer to `JiraPolicyAmsterdam`_.
 652
 653
 654 **Known Issues**
 655     - The operational policy template has been tested with the vFW, vCPE, vDNS and VOLTE use cases.  Additional development may/may not be required for other scenarios.
 656
 657     - For vLBS Use Case, the following steps are required to setup the service instance:
 658         -  Create a Service Instance via VID.
 659         -  Create a VNF Instance via VID.
 660         -  Preload SDNC with topology data used for the actual VNF instantiation (both base and DNS scaling modules). NOTE: you may want to set “vlb_name_0” in the base VF module data to something unique. This is the vLB server name that DCAE will pass to Policy during closed loop. If the same name is used multiple times, the Policy name-query to AAI will show multiple entries, one for each occurrence of that vLB VM name in the OpenStack zone. Note that this is not a limitation, typically server names in a domain are supposed to be unique.
 661         -  Instantiate the base VF module (vLB, vPacketGen, and one vDNS) via VID. NOTE: The name of the VF module MUST start with ``Vfmodule_``. The same name MUST appear in the SDNC preload of the base VF module topology. We’ll relax this naming requirement for Beijing Release.
 662         -  Run heatbridge from the Robot VM using ``Vfmodule_`` … as stack name (it is the actual stack name in OpenStack)
 663         -  Populate AAI with a dummy VF module for vDNS scaling.
 664
 665 **Security Issues**
 666     - None at this time
 667
 668 **Other**
 669     - None at this time
 670
 671
 672 .. Links to jira release notes
 673
 674 .. _JiraPolicyElAlto: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10728
 675 .. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
 676 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
 677 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
 678 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
 679
 680 .. Links to Project related pages
 681
 682 .. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
 683 .. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
 684
 685
 686 .. note
 687 ..      CHANGE  HISTORY
 688 ..      09/19/2019 - Updated for El Alto Release.
 689 ..      05/16/2019 - Updated for Dublin Release.
 690 ..      01/17/2019 - Updated for Casablanca Maintenance Release.
 691 ..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
 692 ..              Changed version number to use ONAP versions.
 693 ..      10/08/2018 - Initial document for Casablanca release.
 694 ..      05/29/2018 - Information for Beijing release.
 695 ..      03/22/2018 - Initial document for Beijing release.
 696 ..      01/15/2018 - Added change for version 1.1.3 to the Amsterdam branch.  Also corrected prior version (1.2.0) to (1.1.1)
 697 ..              Also, Set up initial information for Beijing.
 698 ..              Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
 699
 700
 701 End of Release Notes
 702
 703 .. How to notes for SS
 704 ..      For initial document: list epic and user stories for each, list user stories with no epics.
 705 ..      For Bugs section, list bugs where Affected Version is a prior release (Casablanca, Beijing etc), Fixed Version is the current release (Dublin), Resolution is done.
 706 ..      For Known issues, list bugs that are slotted for a future release.