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