docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   4 .. _release_notes:
   5
   6 Policy Release Notes
   7 ####################
   8
   9 .. note
  10 ..      * This Release Notes must be updated each time the team decides to Release new artifacts.
  11 ..      * The scope of these Release Notes are for ONAP POLICY. In other words, each ONAP component has its Release Notes.
  12 ..      * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of
  13 ..      * this Release Notes.
  14 ..      * Except the date and the version number, all the other sections are optional but there must be at least
  15 ..      * one section describing the purpose of this new release.
  16
  17 ..      ==========================
  18 ..      * * *    JAKARTA     * * *
  19 ..      ==========================
  20
  21 Version: 10.0.0
  22 ---------------
  23
  24 :Release Date: 2022-05-12 (jakarta Release)
  25
  26 Artifacts released:
  27
  28 .. list-table::
  29    :widths: 15 10 10
  30    :header-rows: 1
  31
  32    * - Repository
  33      - Java Artifact
  34      - Docker Image (if applicable)
  35    * - policy/parent
  36      - 3.5.3
  37      - N/A
  38    * - policy/docker
  39      - 2.4.3
  40      - | policy-jre-alpine
  41        | policy-jdk-alpine
  42        | policy-db-migrator
  43    * - policy/common
  44      - 1.10.3
  45      - N/A
  46    * - policy/models
  47      - 2.6.3
  48      - N/A
  49    * - policy/api
  50      - 2.6.3
  51      - policy-api
  52    * - policy/pap
  53      - 2.6.3
  54      - policy-pap
  55    * - policy/apex-pdp
  56      - 2.7.3
  57      - policy-apex-pdp
  58    * - policy/drools-pdp
  59      - 1.10.3
  60      - policy-drools
  61    * - policy/xacml-pdp
  62      - 2.6.3
  63      - policy-xacml-pdp
  64    * - policy/distribution
  65      - 2.7.3
  66      - policy-distribution
  67    * - policy/clamp
  68      - 6.2.3
  69      - | policy-clamp-backend
  70        | policy-clamp-ac-pf-ppnt
  71        | policy-clamp-ac-k8s-ppnt
  72        | policy-clamp-ac-http-ppnt
  73        | policy-clamp-runtime-acm'
  74    * - policy/gui
  75      - 2.2.3
  76      - policy-gui
  77    * - policy/drools-applications
  78      - 1.10.3
  79      - policy-pdpd-cl
  80
  81 Key Updates
  82 ===========
  83
  84 * `REQ-994 <https://jira.onap.org/browse/REQ-994>`_ - Control Loop in TOSCA LCM Improvement
  85   CLAMP (Control Loop Automation Management Platform) functionalities, moved to the Policy project in the Istanbul
  86   release, provides a Control Loop Lifecycle management architecture. A control Loop is a key concept for Automation
  87   and Assurance Use Cases and remains a top priority for ONAP as an automation platform butit is not the only possible
  88   composition of components that is possible to combine to deliver functionality.
  89
  90   This work evolves the Control Loop LCM architecture to provide abstract Automation Composition
  91   Management (ACM) logic with a generic Automation Composition definition, isolating Composition logic logic from ONAP
  92   component logic. It elaborates APIs that allow integrate with other design systems as well as 3PP component integration.
  93
  94   The current PMSH and TCS control loops are migrated to use an Automation Composition approach. Support for Automation
  95   Compositions in SDC is also introduced.
  96
  97 * Metadata Sets for Policy Types.
  98
  99   A Metadata set allows a global set of metadata containing rules or global parameters that all instances of a certain
 100   policy type can use. Metadta sets are introduced in the Policy Framework in the Jakarta release. This means that
 101   different rule set implementations can be associated with a policy type, which can be used in appropriate situations.
 102
 103 * Introduction of Prometheus for monitoring Policy components so that necessary alerts can be easily triggered and
 104   possible outages can be avoided in production systems.
 105
 106   * Expose application level metrics in policy components. An end user can plug in a prometheus instance and start
 107     listening to the metrics exposed by policy components and either raise alerts or show them on a Grafana dashboard
 108     for operations team to keep monitoring the health of the system.
 109
 110   * Provide sample Grafana dashboards for policy metrics.
 111
 112 * Improve the policy/api and policy/pap readiness probes to handle database failures so that the policy/api and
 113   policy/pap kubernetes pods are marked ready only if the policy database pod is ready.
 114
 115 * Migration of Policy Framework components to Springboot to support easier handling, configuration and maintenance.
 116   The migrated components are policy/api, policy/pap, policy/clamp, and policy/gui.
 117
 118 * Enhanced healthchecks on drools pdp to report on stuck applications.  This together with enhanced liveness probes
 119   self-heals the unresponsive pod in such condition by restarting it.
 120
 121 * Drools PDP has been upgraded to the latest available stable version: 7.68.0.Final.
 122
 123 * Extend CDS actor model to decouple VNF handling from the vFirewall use case.
 124
 125 * Policy Framework Database Configurability. Some of the components in the Policy Framework can be configured to use
 126   any JDBC-compliant RDBMS and configuraiton files are supplied for the Postgres RDBMS. MariaDB remains the default
 127   RDBMS for the Policy Framework in ONAP. Further testing will be carried out using Postgres in Kohn and future
 128   releases.
 129
 130 * System Attribute Improvements
 131     - Transaction boundaries on REST calls are implemented per REST call on applications migrated to Spring (policy/api,
 132       policy/pap, and policy/clamp)
 133     - JDBC backend uses Spring and Hibernate rather than Eclipselink
 134     - All GUIs are now included in the policy/gui microservice
 135     - Documentation is retionalized and cleaned up, testing documentation is now complete
 136     - Scripts are added to make release of the Policy Framework easier
 137
 138 Known Limitations, Issues and Workarounds
 139 =========================================
 140
 141 System Limitations
 142 ~~~~~~~~~~~~~~~~~~
 143 N/A
 144
 145 Known Vulnerabilities
 146 ~~~~~~~~~~~~~~~~~~~~~
 147 N/A
 148
 149 Workarounds
 150 ~~~~~~~~~~~
 151 N/A
 152
 153 Security Notes
 154 ==============
 155
 156 | `POLICY-2744 <https://jira.onap.org/browse/POLICY-2744>`_ - Use an account other than healthcheck in API and PAP components for provisioning of policies
 157 | `POLICY-3815 <https://jira.onap.org/browse/POLICY-3815>`_ - Use an account other than healthcheck in API and PAP components for provisioning of policies - OOM Charts
 158 | `POLICY-3862 <https://jira.onap.org/browse/POLICY-3862>`_ - Check all code for Log4J before version 2.15.0 and upgrade if necessary
 159 | `POLICY-4085 <https://jira.onap.org/browse/POLICY-4085>`_ - Remove usage of jackson libraries from clamp runtime
 160
 161
 162 Functional Improvements
 163 =======================
 164 | `POLICY-1837 <https://jira.onap.org/browse/POLICY-1837>`_ - Review transaction boundaries of models
 165 | `POLICY-2715 <https://jira.onap.org/browse/POLICY-2715>`_ - Allow underlying database to be configured: MariaDB or Postgres
 166 | `POLICY-2952 <https://jira.onap.org/browse/POLICY-2952>`_ - R10: TOSCA Control Loop Design Time
 167 | `POLICY-2973 <https://jira.onap.org/browse/POLICY-2973>`_ - Build interaction between SDC and Design Time Catalogue
 168 | `POLICY-3034 <https://jira.onap.org/browse/POLICY-3034>`_ - Support statistics in PDP-X
 169 | `POLICY-3213 <https://jira.onap.org/browse/POLICY-3213>`_ - Persistence Policy Models using JPA/JDBC/Hibernate/MariaDB
 170 | `POLICY-3498 <https://jira.onap.org/browse/POLICY-3498>`_ - Provide API to retrieve policies deployed since a given time
 171 | `POLICY-3579 <https://jira.onap.org/browse/POLICY-3579>`_ - End to End Demo of PMSH usecase
 172 | `POLICY-3582 <https://jira.onap.org/browse/POLICY-3582>`_ - Uber Story: Cover the full scope of LCM for Control Loops: Server Side
 173 | `POLICY-3638 <https://jira.onap.org/browse/POLICY-3638>`_ - Change policy-gui so that all GUIs work in the same jar/JVM
 174 | `POLICY-3745 <https://jira.onap.org/browse/POLICY-3745>`_ - PDP-D: Upgrade drools to the latest 7.x release
 175 | `POLICY-3747 <https://jira.onap.org/browse/POLICY-3747>`_ - Support Readiness and Liveness probes on Control loop helm charts
 176 | `POLICY-3748 <https://jira.onap.org/browse/POLICY-3748>`_ - Enable cluster admin role for k8s participant helm chart in OOM
 177 | `POLICY-3750 <https://jira.onap.org/browse/POLICY-3750>`_ - R10: Improve runtime monitoring capabilities in policy components
 178 | `POLICY-3753 <https://jira.onap.org/browse/POLICY-3753>`_ - Migrate policy-api component to spring boot
 179 | `POLICY-3754 <https://jira.onap.org/browse/POLICY-3754>`_ - Migrate policy-pap component to spring boot
 180 | `POLICY-3755 <https://jira.onap.org/browse/POLICY-3755>`_ - Create a list of application metrics to be exposed in policy framework components
 181 | `POLICY-3756 <https://jira.onap.org/browse/POLICY-3756>`_ - Expose application level metrics in policy-api
 182 | `POLICY-3757 <https://jira.onap.org/browse/POLICY-3757>`_ - Expose application level metrics in policy-pap
 183 | `POLICY-3759 <https://jira.onap.org/browse/POLICY-3759>`_ - Expose application level metrics in policy-distribution
 184 | `POLICY-3760 <https://jira.onap.org/browse/POLICY-3760>`_ - Expose application level metrics in apex-pdp
 185 | `POLICY-3761 <https://jira.onap.org/browse/POLICY-3761>`_ - Expose application level metrics in drools-pdp
 186 | `POLICY-3763 <https://jira.onap.org/browse/POLICY-3763>`_ - Improve policy-api & policy-pap readiness probes to handle db failures
 187 | `POLICY-3777 <https://jira.onap.org/browse/POLICY-3777>`_ - R10: Control Loop in TOSCA LCM improvement
 188 | `POLICY-3781 <https://jira.onap.org/browse/POLICY-3781>`_ - R10: Policy Framework Database Configurability
 189 | `POLICY-3808 <https://jira.onap.org/browse/POLICY-3808>`_ - Commission a Control Loop Type from a Control Loop Type package/service
 190 | `POLICY-3816 <https://jira.onap.org/browse/POLICY-3816>`_ - Support Policy Type Metadata Sets in Policy Framework
 191 | `POLICY-3823 <https://jira.onap.org/browse/POLICY-3823>`_ - Proof of concept of Controlloop design time with SDC
 192 | `POLICY-3835 <https://jira.onap.org/browse/POLICY-3835>`_ - Write scripts to make release of the Policy Framework easier
 193 | `POLICY-3839 <https://jira.onap.org/browse/POLICY-3839>`_ - Migrate controlloop runtime from Eclipselink to Hibernate
 194 | `POLICY-3865 <https://jira.onap.org/browse/POLICY-3865>`_ - PDP-D APPS: extend CDS actor VNF operations support
 195 | `POLICY-3870 <https://jira.onap.org/browse/POLICY-3870>`_ - Add Controlloop design-time components to SDC
 196 | `POLICY-3886 <https://jira.onap.org/browse/POLICY-3886>`_ - Create basic installation & setup for prometheus & grafana
 197 | `POLICY-3889 <https://jira.onap.org/browse/POLICY-3889>`_ - Implement TCS Control Loops using a TOSCA appraoch
 198 | `POLICY-3892 <https://jira.onap.org/browse/POLICY-3892>`_ - Create basic grafana dashboards for monitoring policy framework components
 199 | `POLICY-3896 <https://jira.onap.org/browse/POLICY-3896>`_ - Change Apex Editor to use Spring Boot
 200 | `POLICY-3902 <https://jira.onap.org/browse/POLICY-3902>`_ - Extend PDP-X statistics endpoint to support per application metrics
 201 | `POLICY-3921 <https://jira.onap.org/browse/POLICY-3921>`_ - Align TOSCA Control Loop with Automation Composition
 202 | `POLICY-3938 <https://jira.onap.org/browse/POLICY-3938>`_ - Rename CLAMP "TOSCA Control Loop" feature to CLAMP "Automation Composition Management"
 203 | `POLICY-4040 <https://jira.onap.org/browse/POLICY-4040>`_ - Enable prometheus monitoring on drools-pdp charts
 204
 205 Necessary Improvements and Bug Fixes
 206 ====================================
 207
 208 Necessary Improvements
 209 ~~~~~~~~~~~~~~~~~~~~~~
 210 | `POLICY-1820 <https://jira.onap.org/browse/POLICY-1820>`_ - Transfer APEX model to use policy-models
 211 | `POLICY-2086 <https://jira.onap.org/browse/POLICY-2086>`_ - Remove references to mariadb from resource files
 212 | `POLICY-2587 <https://jira.onap.org/browse/POLICY-2587>`_ - CLC target locking behavior needs to be by-passed for CLC to be effective
 213 | `POLICY-2588 <https://jira.onap.org/browse/POLICY-2588>`_ - Target Locking Implementations should be configurable
 214 | `POLICY-2683 <https://jira.onap.org/browse/POLICY-2683>`_ - REQ-443  improve its CII Badging score by improving input validation and documenting it in their CII Badging site.
 215 | `POLICY-3076 <https://jira.onap.org/browse/POLICY-3076>`_ - Improve code coverage in policy framework repos
 216 | `POLICY-3259 <https://jira.onap.org/browse/POLICY-3259>`_ - Components should not crash at start-up due to dmaap issues
 217 | `POLICY-3269 <https://jira.onap.org/browse/POLICY-3269>`_ - Allow policy to disable guard check in drools-apps
 218 | `POLICY-3358 <https://jira.onap.org/browse/POLICY-3358>`_ - Remove Clamp GUI from Clamp Repo
 219 | `POLICY-3380 <https://jira.onap.org/browse/POLICY-3380>`_ - Archive onap/clamp and remove any jenkins jobs
 220 | `POLICY-3386 <https://jira.onap.org/browse/POLICY-3386>`_ - PDP-D: better liveness checks to recover from stuck sessions
 221 | `POLICY-3540 <https://jira.onap.org/browse/POLICY-3540>`_ - Refactor Participant Interfaces and Tests
 222 | `POLICY-3708 <https://jira.onap.org/browse/POLICY-3708>`_ - Improve Documentation for Jakarta Release
 223 | `POLICY-3710 <https://jira.onap.org/browse/POLICY-3710>`_ - Tidy up the Policy Framework documentation
 224 | `POLICY-3791 <https://jira.onap.org/browse/POLICY-3791>`_ - sphinx-build warnings in policy parent docs
 225 | `POLICY-3804 <https://jira.onap.org/browse/POLICY-3804>`_ - Add gui-clamp coverage info to sonar
 226 | `POLICY-3866 <https://jira.onap.org/browse/POLICY-3866>`_ - Tidy up Policy Framework Documentation
 227 | `POLICY-3885 <https://jira.onap.org/browse/POLICY-3885>`_ - Document metadataSet usage in policy documentation
 228 | `POLICY-3895 <https://jira.onap.org/browse/POLICY-3895>`_ - Improve drools pdp and drools apps logging
 229 | `POLICY-3920 <https://jira.onap.org/browse/POLICY-3920>`_ - Write a User Guide for TOSCA Control Loops in CLAMP
 230 | `POLICY-3927 <https://jira.onap.org/browse/POLICY-3927>`_ - Remove Unused maven dependencies in apex-editor
 231 | `POLICY-3928 <https://jira.onap.org/browse/POLICY-3928>`_ - Remove Unused test resources in apex-editor
 232 | `POLICY-3977 <https://jira.onap.org/browse/POLICY-3977>`_ - PDP-D: enhanced healthchecks for monitoring subcomponents
 233 | `POLICY-3979 <https://jira.onap.org/browse/POLICY-3979>`_ - PDP-D + APPS: investigate configuration to use MySql instead of MariaDB
 234
 235 Bug Fixes
 236 ~~~~~~~~~
 237 | `POLICY-3153 <https://jira.onap.org/browse/POLICY-3153>`_ - Fix Db connection issues in TOSCA control loop
 238 | `POLICY-3589 <https://jira.onap.org/browse/POLICY-3589>`_ - Http participant unable to resolve Intermediary config during startup
 239 | `POLICY-3743 <https://jira.onap.org/browse/POLICY-3743>`_ - APEX-PDP RestClient reports failure when response code!=200
 240 | `POLICY-3749 <https://jira.onap.org/browse/POLICY-3749>`_ - Drools CSITs failing due to version related problem
 241 | `POLICY-3780 <https://jira.onap.org/browse/POLICY-3780>`_ - Update endpoints in xacml-pdp jmx files
 242 | `POLICY-3794 <https://jira.onap.org/browse/POLICY-3794>`_ - Cannot create a new APEX policy on Policy Editor
 243 | `POLICY-3831 <https://jira.onap.org/browse/POLICY-3831>`_ - Camel Integration Tests Failing
 244 | `POLICY-3871 <https://jira.onap.org/browse/POLICY-3871>`_ - Fix issues in existing entity classes in policy-models
 245 | `POLICY-3893 <https://jira.onap.org/browse/POLICY-3893>`_ - apex-pdp intermittent error in build
 246 | `POLICY-3897 <https://jira.onap.org/browse/POLICY-3897>`_ - Fix issue with usage of GeneratedValue in PfGeneratedIdKey
 247 | `POLICY-3905 <https://jira.onap.org/browse/POLICY-3905>`_ - drools pdp merge job failing
 248 | `POLICY-3913 <https://jira.onap.org/browse/POLICY-3913>`_ - Fix issue where some metrics are lost in spring boot
 249 | `POLICY-3914 <https://jira.onap.org/browse/POLICY-3914>`_ - Fix spring configuration for pap csit
 250 | `POLICY-3929 <https://jira.onap.org/browse/POLICY-3929>`_ - Race condition in apex-editor model upload
 251 | `POLICY-3933 <https://jira.onap.org/browse/POLICY-3933>`_ - CLAMP CSIT failing with HTTP 401 unauthorized for URL error
 252 | `POLICY-3978 <https://jira.onap.org/browse/POLICY-3978>`_ - Changing default append on instance name
 253 | `POLICY-3983 <https://jira.onap.org/browse/POLICY-3983>`_ - Policy-API is not using the mounted logback.xml file
 254 | `POLICY-4030 <https://jira.onap.org/browse/POLICY-4030>`_ - PAP/API healthcheck response code not in line with the actual health report
 255 | `POLICY-4039 <https://jira.onap.org/browse/POLICY-4039>`_ - Fix configuration issues causing automation composition issues
 256 | `POLICY-4041 <https://jira.onap.org/browse/POLICY-4041>`_ - Duplicate log entries in policy-gui
 257 | `POLICY-4043 <https://jira.onap.org/browse/POLICY-4043>`_ - Batch deploy/undeploy operations incrementing corresponding apex counter by only 1
 258 | `POLICY-4044 <https://jira.onap.org/browse/POLICY-4044>`_ - APEX-PDP engine metrics remain 0 even after execution of events
 259 | `POLICY-4068 <https://jira.onap.org/browse/POLICY-4068>`_ - PAP consolidated healthcheck returning report with empty url for PAP
 260 | `POLICY-4087 <https://jira.onap.org/browse/POLICY-4087>`_ - Inconsistent behaviour in APEX when PDP STATE changed to PASSIVE and then ACTIVE
 261 | `POLICY-4088 <https://jira.onap.org/browse/POLICY-4088>`_ - PAP shows incorrect deployments counter on parallel deploy/undeploy
 262 | `POLICY-4092 <https://jira.onap.org/browse/POLICY-4092>`_ - Modify Nssi Closed Loop Error
 263 | `POLICY-4095 <https://jira.onap.org/browse/POLICY-4095>`_ - Failures on Daily Master tests onap-policy-clamp-runtime-acm
 264 | `POLICY-4096 <https://jira.onap.org/browse/POLICY-4096>`_ - Policy deployment fails if prometheus operator is not installed
 265 | `POLICY-4104 <https://jira.onap.org/browse/POLICY-4104>`_ - Issue when serialization into JSON Object which brings allot of garbage
 266 | `POLICY-4106 <https://jira.onap.org/browse/POLICY-4106>`_ - PDP-D APPS: Network Slicing: incorrect SO operation
 267
 268 References
 269 ==========
 270
 271 For more information on the ONAP Jakarta release, please see:
 272
 273 #. `ONAP Home Page`_
 274 #. `ONAP Documentation`_
 275 #. `ONAP Release Downloads`_
 276 #. `ONAP Wiki Page`_
 277
 278 .. _`ONAP Home Page`: https://www.onap.org
 279 .. _`ONAP Wiki Page`: https://wiki.onap.org
 280 .. _`ONAP Documentation`: https://docs.onap.org
 281 .. _`ONAP Release Downloads`: https://git.onap.org
 282
 283 Quick Links:
 284     - `POLICY project page`_
 285     - `Passing Badge information for POLICY`_
 286
 287 ..      ==========================
 288 ..      * * *    ISTANBUL    * * *
 289 ..      ==========================
 290
 291 Version: 9.0.1
 292 --------------
 293
 294 :Release Date: 2022-02-17 (Istanbul Maintenance Release #1)
 295
 296 **Artifacts**
 297
 298 Artifacts released:
 299
 300 .. list-table::
 301    :widths: 15 10 10
 302    :header-rows: 1
 303
 304    * - Repository
 305      - Java Artifact
 306      - Docker Image (if applicable)
 307    * - policy/parent
 308      - 3.4.4
 309      - N/A
 310    * - policy/docker
 311      - 2.3.2
 312      - | onap/policy-jdk-alpine:2.3.2
 313        | onap/policy-jre-alpine:2.3.2
 314        | onap/policy-db-migrator:2.3.2
 315    * - policy/common
 316      - 1.9.2
 317      - N/A
 318    * - policy/models
 319      - 2.5.2
 320      - N/A
 321    * - policy/api
 322      - 2.5.2
 323      - onap/policy-api:2.5.2
 324    * - policy/pap
 325      - 2.5.2
 326      - onap/policy-pap:2.5.2
 327    * - policy/drools-pdp
 328      - 1.9.2
 329      - onap/policy-drools:1.9.2
 330    * - policy/apex-pdp
 331      - 2.6.2
 332      - onap/policy-apex-pdp:2.6.2
 333    * - policy/xacml-pdp
 334      - 2.5.2
 335      - onap/policy-xacml-pdp:2.5.2
 336    * - policy/drools-applications
 337      - 1.9.2
 338      - onap/policy-pdpd-cl:1.9.2
 339    * - policy/clamp
 340      - 6.1.4
 341      - | onap/policy-clamp-backend:6.1.4
 342        | onap/policy-clamp-frontend:6.1.4
 343        | onap/policy-clamp-cl-pf-ppnt:6.1.4
 344        | onap/policy-clamp-cl-k8s-ppnt:6.1.4
 345        | onap/policy-clamp-cl-http-ppnt:6.1.4
 346        | onap/policy-clamp-cl-runtime:6.1.4
 347    * - policy/gui
 348      - 2.1.2
 349      - onap/policy-gui:2.1.2
 350    * - policy/distribution
 351      - 2.6.2
 352      - onap/policy-distribution:2.6.2
 353
 354 **Bug Fixes and Necessary Enhancements**
 355
 356     * `[POLICY-3862] <https://jira.onap.org/browse/POLICY-3862>`_
 357       - Check all code for Log4J before version 2.15.0 and upgrade if necessary
 358
 359 Version: 9.0.0
 360 --------------
 361
 362 :Release Date: 2021-11-04 (Istanbul Release)
 363
 364 New features
 365 ============
 366
 367 Artifacts released:
 368
 369 .. list-table::
 370    :widths: 15 10 10
 371    :header-rows: 1
 372
 373    * - Repository
 374      - Java Artifact
 375      - Docker Image (if applicable)
 376    * - policy/parent
 377      - 3.4.3
 378      - N/A
 379    * - policy/docker
 380      - 2.3.1
 381      - | onap/policy-jdk-alpine:2.3.1
 382        | onap/policy-jre-alpine:2.3.1
 383        | onap/policy-db-migrator:2.3.1
 384    * - policy/common
 385      - 1.9.1
 386      - N/A
 387    * - policy/models
 388      - 2.5.1
 389      - N/A
 390    * - policy/api
 391      - 2.5.1
 392      - onap/policy-api:2.5.1
 393    * - policy/pap
 394      - 2.5.1
 395      - onap/policy-pap:2.5.1
 396    * - policy/drools-pdp
 397      - 1.9.1
 398      - onap/policy-drools:1.9.1
 399    * - policy/apex-pdp
 400      - 2.6.1
 401      - onap/policy-apex-pdp:2.6.1
 402    * - policy/xacml-pdp
 403      - 2.5.1
 404      - onap/policy-xacml-pdp:2.5.1
 405    * - policy/drools-applications
 406      - 1.9.1
 407      - onap/policy-pdpd-cl:1.9.1
 408    * - policy/clamp
 409      - 6.1.3
 410      - | onap/policy-clamp-backend:6.1.3
 411        | onap/policy-clamp-frontend:6.1.3
 412        | onap/policy-clamp-cl-pf-ppnt:6.1.3
 413        | onap/policy-clamp-cl-k8s-ppnt:6.1.3
 414        | onap/policy-clamp-cl-http-ppnt:6.1.3
 415        | onap/policy-clamp-cl-runtime:6.1.3
 416    * - policy/gui
 417      - 2.1.1
 418      - onap/policy-gui:2.1.1
 419    * - policy/distribution
 420      - 2.6.1
 421      - onap/policy-distribution:2.6.1
 422
 423 Key Updates
 424 ===========
 425
 426 Clamp -> policy
 427 Control Loop
 428 Database
 429
 430 * `REQ-684 <https://jira.onap.org/browse/REQ-684>`_ - Merge CLAMP functionality into Policy Framework project
 431     - keep CLAMP functions into ONAP
 432     - reduce ONAP footprint
 433     - consolidate the UI (Control loop UI and policy)
 434     - enables code sharing and common handling for REST and TOSCA
 435     - introduces the Spring Framework into the Policy Framework
 436     - see `the CLAMP documentation <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/clamp/clamp.html>`_
 437
 438 * `REQ-716 <https://jira.onap.org/browse/REQ-716>`_ - Control Loop in TOSCA LCM
 439    - Allows Control Loops to be defined and described in Metadata using TOSCA
 440    - Control loops can run on the fly on any component that implements a *participant* API
 441    - Control Loops can be commissioned into Policy/CLAMP, they can be parameterized, initiated on arbitrary
 442      participants, activated and monitored
 443    - See `the CLAMP TOSCA Control Loop documentation
 444      <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/controlloop/controlloop.html>`_
 445
 446 * CLAMP Client Policy and TOSCA Handling
 447     - Push existing policy(tree) into pdp
 448     - Handling of PDP Groups
 449     - Handling of Policy Types
 450     - Handling of TOSCA Service Templates
 451     - Push of Policies to PDPs
 452     - Support multiple PDP Groups per Policy Type
 453     - Tree view in Policies list
 454     - Integration of new TOSCA Control Loop GUI into CLAMP GUI
 455
 456 * Policy Handling Improvements
 457     - Support delta policies in PDPs
 458     - Allow XACML rules to specify EventManagerService
 459     - Sending of notifications to Kafka & Rest in apex-pdp policies
 460     - External configuration of groups other than defaultGroup
 461     - XACML Decision support for Multiple Requests
 462     - Updated query parameter names and support for wildcards in APIs
 463     - Added new APIs for Policy Audit capabilities
 464     - Capability to send multiple output events from a state in APEX-PDP
 465
 466 * System Attribute Improvements
 467     - Support for upgrade and rollback, starting with upgrade from the Honolulu release to the Istanbul release
 468     - Consolidated health check
 469     - Phase 1 of Spring Framework introduction
 470     - Phase 1 of Prometheus introduction, base Prometheus metrics
 471
 472 Known Limitations, Issues and Workarounds
 473 =========================================
 474
 475 System Limitations
 476 ~~~~~~~~~~~~~~~~~~
 477 N/A
 478
 479 Known Vulnerabilities
 480 ~~~~~~~~~~~~~~~~~~~~~
 481 N/A
 482
 483 Workarounds
 484 ~~~~~~~~~~~
 485 N/A
 486
 487 Security Notes
 488 ==============
 489
 490 | `POLICY-3169 <https://jira.onap.org/browse/POLICY-3169>`_ - Remove security issues reported by NEXUS-IQ
 491 | `POLICY-3315 <https://jira.onap.org/browse/POLICY-3315>`_ - Review license scan issues
 492 | `POLICY-3327 <https://jira.onap.org/browse/POLICY-3327>`_ - OOM AAF generated certificates contain invalid SANs entries
 493 | `POLICY-3338 <https://jira.onap.org/browse/POLICY-3338>`_ - Upgrade CDS dependency to the latest version
 494 | `POLICY-3384 <https://jira.onap.org/browse/POLICY-3384>`_ - Use signed certificates in the CSITs
 495 | `POLICY-3431 <https://jira.onap.org/browse/POLICY-3431>`_ - Review license scan issues
 496 | `POLICY-3516 <https://jira.onap.org/browse/POLICY-3516>`_ - Upgrade CDS dependency to the 1.1.5 version
 497 | `POLICY-3590 <https://jira.onap.org/browse/POLICY-3590>`_ - Address security vulnerabilities and License issues in Policy Framework
 498 | `POLICY-3697 <https://jira.onap.org/browse/POLICY-3697>`_ - Review license scan issues
 499
 500
 501 Functional Improvements
 502 =======================
 503 | `REQ-684 <https://jira.onap.org/browse/REQ-684>`_ - Merge CLAMP functionality into Policy Framework project
 504 | `REQ-716 <https://jira.onap.org/browse/REQ-716>`_ - Control Loop in TOSCA LCM
 505 | `POLICY-1787 <https://jira.onap.org/browse/POLICY-1787>`_ - Support mariadb upgrade/rollback functionality
 506 | `POLICY-2535 <https://jira.onap.org/browse/POLICY-2535>`_ - Query deployed policies by regex on the name, for a given policy type
 507 | `POLICY-2618 <https://jira.onap.org/browse/POLICY-2618>`_ - PDP-D make legacy configuration interface (used by brmsgw) an optional feature
 508 | `POLICY-2769 <https://jira.onap.org/browse/POLICY-2769>`_ - Support multiple PAP instances
 509 | `POLICY-2865 <https://jira.onap.org/browse/POLICY-2865>`_ - Add support and documentation on how an application can control what info is returned in Decision API
 510 | `POLICY-2896 <https://jira.onap.org/browse/POLICY-2896>`_ - Improve consolidated health check to include dependencies
 511 | `POLICY-2920 <https://jira.onap.org/browse/POLICY-2920>`_ - policy-clamp ui is capable to push and existing policy(tree) into pdp
 512 | `POLICY-2921 <https://jira.onap.org/browse/POLICY-2921>`_ - use the policy-clamp ui to manage pdp groups
 513 | `POLICY-2923 <https://jira.onap.org/browse/POLICY-2923>`_ - use the policy-clamp ui to manage policy types
 514 | `POLICY-2930 <https://jira.onap.org/browse/POLICY-2930>`_ - clamp-backend rest api to push policies to pdp
 515 | `POLICY-2931 <https://jira.onap.org/browse/POLICY-2931>`_ - clamp GUI to push policy to pdp
 516 | `POLICY-3072 <https://jira.onap.org/browse/POLICY-3072>`_ - clamp ui support multiple pdp group per policy type
 517 | `POLICY-3107 <https://jira.onap.org/browse/POLICY-3107>`_ - Support delta policies in PDPs
 518 | `POLICY-3165 <https://jira.onap.org/browse/POLICY-3165>`_ - Implement tree view in policies list
 519 | `POLICY-3209 <https://jira.onap.org/browse/POLICY-3209>`_ - CLAMP Component Lifecycle Management using Spring Framework
 520 | `POLICY-3218 <https://jira.onap.org/browse/POLICY-3218>`_ - Integrate CLAMP GUIs (Instantiation/Monitoring) in the policy-gui repo
 521 | `POLICY-3227 <https://jira.onap.org/browse/POLICY-3227>`_ - Implementation of context album improvements in apex-pdp
 522 | `POLICY-3228 <https://jira.onap.org/browse/POLICY-3228>`_ - Implement clamp backend part to add policy models api
 523 | `POLICY-3229 <https://jira.onap.org/browse/POLICY-3229>`_ - Implement the front end part to add tosca model
 524 | `POLICY-3230 <https://jira.onap.org/browse/POLICY-3230>`_ - Make default PDP-D and PDP-D-APPS work out of the box
 525 | `POLICY-3260 <https://jira.onap.org/browse/POLICY-3260>`_ - Allow rules to specify EventManagerService
 526 | `POLICY-3324 <https://jira.onap.org/browse/POLICY-3324>`_ - Design a solution for sending notifications to Kafka & Rest in apex-pdp policies
 527 | `POLICY-3331 <https://jira.onap.org/browse/POLICY-3331>`_ - PAP: should allow for external configuration of groups other than defaultGroup
 528 | `POLICY-3340 <https://jira.onap.org/browse/POLICY-3340>`_ - Create REST API's in PAP to fetch the audit information stored in DB
 529 | `POLICY-3514 <https://jira.onap.org/browse/POLICY-3514>`_ - XACML Decision support for Multiple Requests
 530 | `POLICY-3524 <https://jira.onap.org/browse/POLICY-3524>`_ - Explore options to integrate prometheus with policy framework components
 531 | `POLICY-3527 <https://jira.onap.org/browse/POLICY-3527>`_ - Update query parameter names in policy audit api's
 532 | `POLICY-3533 <https://jira.onap.org/browse/POLICY-3533>`_ - PDP-D: make DB port provisionable
 533 | `POLICY-3538 <https://jira.onap.org/browse/POLICY-3538>`_ - Export basic metrics from policy components for prometheus
 534 | `POLICY-3545 <https://jira.onap.org/browse/POLICY-3545>`_ - Use generic create policy url in policy/distribution
 535 | `POLICY-3557 <https://jira.onap.org/browse/POLICY-3557>`_ - Export basic prometheus metrics from clamp
 536
 537 Necessary Improvements and Bug Fixes
 538 ====================================
 539
 540 Necessary Improvements
 541 ~~~~~~~~~~~~~~~~~~~~~~
 542 | `POLICY-2418 <https://jira.onap.org/browse/POLICY-2418>`_ - Refactor XACML PDP POJO's into Bean objects in order to perform validation more simply
 543 | `POLICY-2429 <https://jira.onap.org/browse/POLICY-2429>`_ - Mark policy/engine read-only and remove ci-management jobs for it
 544 | `POLICY-2542 <https://jira.onap.org/browse/POLICY-2542>`_ - Improve the REST parameter validation for PAP api's
 545 | `POLICY-2767 <https://jira.onap.org/browse/POLICY-2767>`_ - Improve error handling of drools-pdp when requestID in onset is not valid UUID
 546 | `POLICY-2899 <https://jira.onap.org/browse/POLICY-2899>`_ - Store basic audit details of deploy/undeploy operations in PAP
 547 | `POLICY-2996 <https://jira.onap.org/browse/POLICY-2996>`_ - Address technical debt left over from Honolulu
 548 | `POLICY-3059 <https://jira.onap.org/browse/POLICY-3059>`_ - Fix name of target-database property in persistence.xml files
 549 | `POLICY-3062 <https://jira.onap.org/browse/POLICY-3062>`_ - Update the ENTRYPOINT in APEX-PDP Dockerfile
 550 | `POLICY-3078 <https://jira.onap.org/browse/POLICY-3078>`_ - Support SSL communication in Kafka IO plugin of Apex-PDP
 551 | `POLICY-3087 <https://jira.onap.org/browse/POLICY-3087>`_ - Use sl4fj instead of EELFLogger
 552 | `POLICY-3089 <https://jira.onap.org/browse/POLICY-3089>`_ - Cleanup logs for success/failure consumers in apex-pdp
 553 | `POLICY-3096 <https://jira.onap.org/browse/POLICY-3096>`_ - Fix intermittent test failures in APEX
 554 | `POLICY-3128 <https://jira.onap.org/browse/POLICY-3128>`_ - Use command command-line handler across policy repos
 555 | `POLICY-3129 <https://jira.onap.org/browse/POLICY-3129>`_ - Refactor command-line handling across policy-repos
 556 | `POLICY-3132 <https://jira.onap.org/browse/POLICY-3132>`_ - Apex-pdp documentation refers to missing logos.png
 557 | `POLICY-3134 <https://jira.onap.org/browse/POLICY-3134>`_ - Use base image for policy-jdk docker images
 558 | `POLICY-3136 <https://jira.onap.org/browse/POLICY-3136>`_ - Ignore jacoco and checkstyle when in eclipse
 559 | `POLICY-3143 <https://jira.onap.org/browse/POLICY-3143>`_ - Remove keystore files from policy repos
 560 | `POLICY-3145 <https://jira.onap.org/browse/POLICY-3145>`_ - HTTPS clients should not allow self-signed certificates
 561 | `POLICY-3147 <https://jira.onap.org/browse/POLICY-3147>`_ - Xacml-pdp should not use RestServerParameters for client parameters
 562 | `POLICY-3155 <https://jira.onap.org/browse/POLICY-3155>`_ - Use python3 for CSITs
 563 | `POLICY-3160 <https://jira.onap.org/browse/POLICY-3160>`_ - Use "sh" instead of "ash" where possible
 564 | `POLICY-3163 <https://jira.onap.org/browse/POLICY-3163>`_ - Remove spaces from xacml file name
 565 | `POLICY-3166 <https://jira.onap.org/browse/POLICY-3166>`_ - Use newer onap base image in clamp
 566 | `POLICY-3171 <https://jira.onap.org/browse/POLICY-3171>`_ - Fix sporadic error in models provider junits
 567 | `POLICY-3175 <https://jira.onap.org/browse/POLICY-3175>`_ - Minor clean-up of drools-apps
 568 | `POLICY-3182 <https://jira.onap.org/browse/POLICY-3182>`_ - Update npm repo
 569 | `POLICY-3189 <https://jira.onap.org/browse/POLICY-3189>`_ - Create a new key class which uses the @GeneratedValue annotation
 570 | `POLICY-3190 <https://jira.onap.org/browse/POLICY-3190>`_ - Investigate handling of context albums in Apex-PDP for failure responses (ex - AAI)
 571 | `POLICY-3198 <https://jira.onap.org/browse/POLICY-3198>`_ - Remove VirtualControlLoopEvent from OperationsHistory classes
 572 | `POLICY-3211 <https://jira.onap.org/browse/POLICY-3211>`_ - Parameter Handling and Parameter Validation
 573 | `POLICY-3214 <https://jira.onap.org/browse/POLICY-3214>`_ - Change Monitoring UI implementation to use React
 574 | `POLICY-3215 <https://jira.onap.org/browse/POLICY-3215>`_ - Update CLAMP Module structure to Multi Module Maven approach
 575 | `POLICY-3221 <https://jira.onap.org/browse/POLICY-3221>`_ - wrong lifecycle state information in INFO.yaml for policy/clamp
 576 | `POLICY-3222 <https://jira.onap.org/browse/POLICY-3222>`_ - Use existing clamp gui to set the parameters during CL instantiation
 577 | `POLICY-3235 <https://jira.onap.org/browse/POLICY-3235>`_ - gui-editor-apex fails to start
 578 | `POLICY-3257 <https://jira.onap.org/browse/POLICY-3257>`_ - Update csit test cases to include policy status & statistics api's
 579 | `POLICY-3261 <https://jira.onap.org/browse/POLICY-3261>`_ - Rules need a way to release locks
 580 | `POLICY-3262 <https://jira.onap.org/browse/POLICY-3262>`_ - Extract more common code from UsecasesEventManager
 581 | `POLICY-3292 <https://jira.onap.org/browse/POLICY-3292>`_ - Update the XACML PDP Tutorial docker compose files to point to release Honolulu images
 582 | `POLICY-3298 <https://jira.onap.org/browse/POLICY-3298>`_ - Add key names to IndexedXxx factory class toString() methods
 583 | `POLICY-3299 <https://jira.onap.org/browse/POLICY-3299>`_ - Merge policy CSITs into docker/csit
 584 | `POLICY-3300 <https://jira.onap.org/browse/POLICY-3300>`_ - PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR ISTANBUL
 585 | `POLICY-3303 <https://jira.onap.org/browse/POLICY-3303>`_ - Update the default logback.xml in APEX to log to STDOUT
 586 | `POLICY-3305 <https://jira.onap.org/browse/POLICY-3305>`_ - Ensure XACML PDP application/translator methods are extendable
 587 | `POLICY-3306 <https://jira.onap.org/browse/POLICY-3306>`_ - Fix issue where apex-pdp test is failing in gitlab
 588 | `POLICY-3307 <https://jira.onap.org/browse/POLICY-3307>`_ - Turn off frankfurt CSITs
 589 | `POLICY-3333 <https://jira.onap.org/browse/POLICY-3333>`_ - bean validator should use SerializedName
 590 | `POLICY-3336 <https://jira.onap.org/browse/POLICY-3336>`_ - APEX CLI/Model: multiple outputs for nextState NULL
 591 | `POLICY-3337 <https://jira.onap.org/browse/POLICY-3337>`_ - Move clamp documentation to policy/parent
 592 | `POLICY-3366 <https://jira.onap.org/browse/POLICY-3366>`_ - PDP-D: support configuration of overarching DMAAP https flag
 593 | `POLICY-3367 <https://jira.onap.org/browse/POLICY-3367>`_ - oom: policy-clamp-create-tables.sql: add IF NOT EXISTS clauses
 594 | `POLICY-3374 <https://jira.onap.org/browse/POLICY-3374>`_ - Docker registry should be defined in the parent pom
 595 | `POLICY-3378 <https://jira.onap.org/browse/POLICY-3378>`_ - Move groovy scripts to separate/common file
 596 | `POLICY-3382 <https://jira.onap.org/browse/POLICY-3382>`_ - Create document for policy chaining in drools-pdp
 597 | `POLICY-3383 <https://jira.onap.org/browse/POLICY-3383>`_ - Standardize policy deployment vs undeployment count in PdpStatistics
 598 | `POLICY-3388 <https://jira.onap.org/browse/POLICY-3388>`_ - policy/gui merge jobs failing
 599 | `POLICY-3389 <https://jira.onap.org/browse/POLICY-3389>`_ - Use lombok annotations instead of hashCode, equals, toString, get, set
 600 | `POLICY-3404 <https://jira.onap.org/browse/POLICY-3404>`_ - Rolling DB errors in log output for API, PAP, and DB components
 601 | `POLICY-3419 <https://jira.onap.org/browse/POLICY-3419>`_ - Remove operationshistory10 DB
 602 | `POLICY-3450 <https://jira.onap.org/browse/POLICY-3450>`_ - PAP should support turning on/off via configuration storing PDP statistics
 603 | `POLICY-3456 <https://jira.onap.org/browse/POLICY-3456>`_ - Use new RestClientParameters class instead of BusTopicParams
 604 | `POLICY-3457 <https://jira.onap.org/browse/POLICY-3457>`_ - Topic source should not go into fast-fail loop when dmaap is unreachable
 605 | `POLICY-3459 <https://jira.onap.org/browse/POLICY-3459>`_ - Document how to turn off collection of PdpStatistics
 606 | `POLICY-3473 <https://jira.onap.org/browse/POLICY-3473>`_ - CSIT for xacml doesn't check dmaap msg status
 607 | `POLICY-3474 <https://jira.onap.org/browse/POLICY-3474>`_ - Delete extra simulators from policy-models
 608 | `POLICY-3486 <https://jira.onap.org/browse/POLICY-3486>`_ - policy-jdk docker image should have at least one up to date image
 609 | `POLICY-3499 <https://jira.onap.org/browse/POLICY-3499>`_ - Improve Apex-PDP logs to avoid printing errors for irrelevant events in multiple policy deployment
 610 | `POLICY-3501 <https://jira.onap.org/browse/POLICY-3501>`_ - Refactor guard actor
 611 | `POLICY-3511 <https://jira.onap.org/browse/POLICY-3511>`_ - Limit statistics record count
 612 | `POLICY-3525 <https://jira.onap.org/browse/POLICY-3525>`_ - Improve policy/pap csit automation test cases
 613 | `POLICY-3528 <https://jira.onap.org/browse/POLICY-3528>`_ - Update documents & postman collection for pdp statistics api's
 614 | `POLICY-3531 <https://jira.onap.org/browse/POLICY-3531>`_ - PDP-X: initialization delays causes liveness checks to be missed under OOM deployment
 615 | `POLICY-3532 <https://jira.onap.org/browse/POLICY-3532>`_ - Add Honolulu Maintenance Release notes to read-the-docs
 616 | `POLICY-3539 <https://jira.onap.org/browse/POLICY-3539>`_ - Use RestServer from policy/common in apex-pdp
 617 | `POLICY-3547 <https://jira.onap.org/browse/POLICY-3547>`_ - METADATA tables for policy/docker db-migrator should be different than counterpart in policy/drools-pdp seed
 618 | `POLICY-3556 <https://jira.onap.org/browse/POLICY-3556>`_ - Document xacml REST server limitations
 619 | `POLICY-3605 <https://jira.onap.org/browse/POLICY-3605>`_ - Enhance dmaap simulator to support ""/topics" endpoint
 620 | `POLICY-3609 <https://jira.onap.org/browse/POLICY-3609>`_ - Add CSIT test case for policy consolidated health check
 621
 622 Bug Fixes
 623 ~~~~~~~~~
 624 | `POLICY-2845 <https://jira.onap.org/browse/POLICY-2845>`_ - Policy dockers contain GPLv3
 625 | `POLICY-3066 <https://jira.onap.org/browse/POLICY-3066>`_ - Stackoverflow error in APEX standalone after changing to onap java image
 626 | `POLICY-3161 <https://jira.onap.org/browse/POLICY-3161>`_ - OOM clamp BE/FE do not start properly when clamp db exists in the cluster
 627 | `POLICY-3174 <https://jira.onap.org/browse/POLICY-3174>`_ - POLICY-APEX  log does not include the DATE in STDOUT
 628 | `POLICY-3176 <https://jira.onap.org/browse/POLICY-3176>`_ - POLICY-DROOLS  log does not include the DATE in STDOUT
 629 | `POLICY-3177 <https://jira.onap.org/browse/POLICY-3177>`_ - POLICY-PAP log does not include the DATE in STDOUT
 630 | `POLICY-3201 <https://jira.onap.org/browse/POLICY-3201>`_ - fix CRITICAL weak-cryptography issues identified in sonarcloud
 631 | `POLICY-3202 <https://jira.onap.org/browse/POLICY-3202>`_ - PDP-D: no locking feature: service loader not locking the no-lock-manager
 632 | `POLICY-3203 <https://jira.onap.org/browse/POLICY-3203>`_ - Update the PDP deployment in policy window failure
 633 | `POLICY-3204 <https://jira.onap.org/browse/POLICY-3204>`_ - Clamp UI does not accept to deploy policy to PDP
 634 | `POLICY-3205 <https://jira.onap.org/browse/POLICY-3205>`_ - The submit operation in Clamp cannot be achieved successfully
 635 | `POLICY-3225 <https://jira.onap.org/browse/POLICY-3225>`_ - Clamp policy UI does not send right pdp command
 636 | `POLICY-3226 <https://jira.onap.org/browse/POLICY-3226>`_ - Clamp policy UI does 2 parallel queries to policy list
 637 | `POLICY-3248 <https://jira.onap.org/browse/POLICY-3248>`_ - PdpHeartbeats are not getting processed by PAP
 638 | `POLICY-3301 <https://jira.onap.org/browse/POLICY-3301>`_ - Apex Avro Event Schemas - Not support for colon ':' character in field names
 639 | `POLICY-3322 <https://jira.onap.org/browse/POLICY-3322>`_ - gui-editor-apex doesn't contain webapp correctly
 640 | `POLICY-3332 <https://jira.onap.org/browse/POLICY-3332>`_ - Issues around delta policy deployment in APEX
 641 | `POLICY-3369 <https://jira.onap.org/browse/POLICY-3369>`_ - Modify NSSI closed loop not running
 642 | `POLICY-3445 <https://jira.onap.org/browse/POLICY-3445>`_ - Version conflicts in spring boot dependency jars in CLAMP
 643 | `POLICY-3454 <https://jira.onap.org/browse/POLICY-3454>`_ - PDP-D CL APPS: swagger mismatched libraries cause telemetry shell to fail
 644 | `POLICY-3468 <https://jira.onap.org/browse/POLICY-3468>`_ - PDPD-CL APPS: Clean up library transitive dependencies conflicts (jackson version) from new CDS libraries
 645 | `POLICY-3507 <https://jira.onap.org/browse/POLICY-3507>`_ - CDS Operation Policy execution runtime error
 646 | `POLICY-3526 <https://jira.onap.org/browse/POLICY-3526>`_ - OOM start of policy-distribution fails (keyStore values)
 647 | `POLICY-3558 <https://jira.onap.org/browse/POLICY-3558>`_ - Delete Instance Properties if Instantiation is Unitialized
 648 | `POLICY-3600 <https://jira.onap.org/browse/POLICY-3600>`_ - Some REST calls in Clamp GUI do not include pathname
 649 | `POLICY-3601 <https://jira.onap.org/browse/POLICY-3601>`_ - Static web resource paths in gui-editor-apex are incorrect
 650 | `POLICY-3602 <https://jira.onap.org/browse/POLICY-3602>`_ - Context schema table is not populated in Apex Editor
 651 | `POLICY-3603 <https://jira.onap.org/browse/POLICY-3603>`_ - gui-pdp-monitoring broken in gui docker image
 652 | `POLICY-3608 <https://jira.onap.org/browse/POLICY-3608>`_ - LASTUPDATE column in pdp table causing Nullpointer Exception in PAP initialization
 653 | `POLICY-3610 <https://jira.onap.org/browse/POLICY-3610>`_ - PDP-D-APPS:  audit and metric logging information is incorrect
 654 | `POLICY-3611 <https://jira.onap.org/browse/POLICY-3611>`_ - "API,PAP: decrease eclipselink verbosity in persistence.xml"
 655 | `POLICY-3625 <https://jira.onap.org/browse/POLICY-3625>`_ - Terminated PDPs are not being removed by PAP
 656 | `POLICY-3637 <https://jira.onap.org/browse/POLICY-3637>`_ - Policy-mariadb connection intermittently fails from PF components
 657 | `POLICY-3639 <https://jira.onap.org/browse/POLICY-3639>`_ - CLAMP_REST_URL environment variable is not needed
 658 | `POLICY-3647 <https://jira.onap.org/browse/POLICY-3647>`_ - Cannot create Instance from Policy GUI
 659 | `POLICY-3649 <https://jira.onap.org/browse/POLICY-3649>`_ - SSL Handshake failure between CL participants and DMaap
 660 | `POLICY-3650 <https://jira.onap.org/browse/POLICY-3650>`_ - Disable apex-editor and pdp-monitoring in gui docker
 661 | `POLICY-3660 <https://jira.onap.org/browse/POLICY-3660>`_ - DB-Migrator job completes even during failed upgrade
 662 | `POLICY-3678 <https://jira.onap.org/browse/POLICY-3678>`_ - K8s participants tests are skipped due to json parsing error.
 663 | `POLICY-3679 <https://jira.onap.org/browse/POLICY-3679>`_ - Modify pdpstatistics to prevent duplicate keys
 664 | `POLICY-3680 <https://jira.onap.org/browse/POLICY-3680>`_ - PDP Monitoring GUI fails to parse JSON from PAP
 665 | `POLICY-3682 <https://jira.onap.org/browse/POLICY-3682>`_ - Unable to list the policies in Policy UI
 666 | `POLICY-3683 <https://jira.onap.org/browse/POLICY-3683>`_ - clamp-fe & policy-gui: useless rolling logs
 667 | `POLICY-3684 <https://jira.onap.org/browse/POLICY-3684>`_ - Unable to select a PDP group & Subgroup when configuring a control loop policy
 668 | `POLICY-3685 <https://jira.onap.org/browse/POLICY-3685>`_ - Fix CL state change issues in runtime and participants
 669 | `POLICY-3686 <https://jira.onap.org/browse/POLICY-3686>`_ - Update Participant Status after Commissioning
 670 | `POLICY-3687 <https://jira.onap.org/browse/POLICY-3687>`_ - Continuous sending CONTROL_LOOP_STATE_CHANGE message
 671 | `POLICY-3688 <https://jira.onap.org/browse/POLICY-3688>`_ - Register participant in ParticipantRegister message
 672 | `POLICY-3689 <https://jira.onap.org/browse/POLICY-3689>`_ - Handle ParticipantRegister
 673 | `POLICY-3691 <https://jira.onap.org/browse/POLICY-3691>`_ - Problems Parsing Service Template
 674 | `POLICY-3695 <https://jira.onap.org/browse/POLICY-3695>`_ - Tosca Constraint "in_range" not supported by policy/models
 675 | `POLICY-3706 <https://jira.onap.org/browse/POLICY-3706>`_ - Telemetry not working in drools-pdp
 676 | `POLICY-3707 <https://jira.onap.org/browse/POLICY-3707>`_ - Cannot delete a loop in design state
 677
 678 References
 679 ==========
 680
 681 For more information on the ONAP Istanbul release, please see:
 682
 683 #. `ONAP Home Page`_
 684 #. `ONAP Documentation`_
 685 #. `ONAP Release Downloads`_
 686 #. `ONAP Wiki Page`_
 687
 688 .. _`ONAP Home Page`: https://www.onap.org
 689 .. _`ONAP Wiki Page`: https://wiki.onap.org
 690 .. _`ONAP Documentation`: https://docs.onap.org
 691 .. _`ONAP Release Downloads`: https://git.onap.org
 692
 693 Quick Links:
 694     - `POLICY project page`_
 695     - `Passing Badge information for POLICY`_
 696
 697 ..      ==========================
 698 ..      * * *    HONOLULU    * * *
 699 ..      ==========================
 700
 701 Version: 8.0.1
 702 --------------
 703
 704 :Release Date: 2021-08-12 (Honolulu Maintenance Release #1)
 705
 706 **Artifacts**
 707
 708 Artifacts released:
 709
 710 .. csv-table::
 711    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
 712    :widths: 15,10,10
 713
 714    "policy/parent", "3.3.2", ""
 715    "policy/common", "1.8.2", ""
 716    "policy/models", "2.4.4", ""
 717    "policy/api", "2.4.4", "onap/policy-api:2.4.4"
 718    "policy/pap", "2.4.5", "onap/policy-pap:2.4.5"
 719    "policy/drools-pdp", "1.8.4", "onap/policy-drools:1.8.4"
 720    "policy/apex-pdp", "2.5.4", "onap/policy-apex-pdp:2.5.4"
 721    "policy/xacml-pdp", "2.4.5", "onap/policy-xacml-pdp:2.4.5"
 722    "policy/drools-applications", "1.8.4", "onap/policy-pdpd-cl:1.8.4"
 723    "policy/distribution", "2.5.4", "onap/policy-distribution:2.5.4"
 724    "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
 725
 726
 727 **Bug Fixes and Necessary Enhancements**
 728
 729
 730     * `[POLICY-3062] <https://jira.onap.org/browse/POLICY-3062>`_ - Update the ENTRYPOINT in APEX-PDP Dockerfile
 731     * `[POLICY-3066] <https://jira.onap.org/browse/POLICY-3066>`_ - Stackoverflow error in APEX standalone after changing to onap java image
 732     * `[POLICY-3078] <https://jira.onap.org/browse/POLICY-3078>`_ - Support SSL communication in Kafka IO plugin of Apex-PDP
 733     * `[POLICY-3173] <https://jira.onap.org/browse/POLICY-3173>`_ - APEX-PDP incorrectly reports successful policy deployment to PAP
 734     * `[POLICY-3202] <https://jira.onap.org/browse/POLICY-3202>`_ - PDP-D: no locking feature: service loader not locking the no-lock-manager
 735     * `[POLICY-3227] <https://jira.onap.org/browse/POLICY-3227>`_ - Implementation of context album improvements in apex-pdp
 736     * `[POLICY-3230] <https://jira.onap.org/browse/POLICY-3230>`_ - Make default PDP-D and PDP-D-APPS work out of the box
 737     * `[POLICY-3248] <https://jira.onap.org/browse/POLICY-3248>`_ - PdpHeartbeats are not getting processed by PAP
 738     * `[POLICY-3301] <https://jira.onap.org/browse/POLICY-3301>`_ - Apex Avro Event Schemas - Not support for colon ':' character in field names
 739     * `[POLICY-3305] <https://jira.onap.org/browse/POLICY-3305>`_ - Ensure XACML PDP application/translator methods are extendable
 740     * `[POLICY-3331] <https://jira.onap.org/browse/POLICY-3331>`_ - PAP: should allow for external configuration of groups other than defaultGroup
 741     * `[POLICY-3338] <https://jira.onap.org/browse/POLICY-3338>`_ - Upgrade CDS dependency to the latest version
 742     * `[POLICY-3366] <https://jira.onap.org/browse/POLICY-3366>`_ - PDP-D: support configuration of overarching DMAAP https flag
 743     * `[POLICY-3450] <https://jira.onap.org/browse/POLICY-3450>`_ - PAP should support turning on/off via configuration storing PDP statistics
 744     * `[POLICY-3454] <https://jira.onap.org/browse/POLICY-3454>`_ - PDP-D CL APPS: swagger mismatched libraries cause telemetry shell to fail
 745     * `[POLICY-3485] <https://jira.onap.org/browse/POLICY-3485>`_ - Limit statistics record count
 746     * `[POLICY-3507] <https://jira.onap.org/browse/POLICY-3507>`_ - CDS Operation Policy execution runtime error
 747     * `[POLICY-3516] <https://jira.onap.org/browse/POLICY-3516>`_ - Upgrade CDS dependency to the 1.1.5 version
 748
 749
 750 Known Limitations
 751 =================
 752
 753 The APIs provided by xacml-pdp (e.g., healthcheck, statistics, decision)
 754 are always active.  While PAP controls which policies are deployed to a
 755 xacml-pdp, it does not control whether or not the APIs are active.
 756 In other words, xacml-pdp will respond to decision requests, regardless
 757 of whether PAP has made it ACTIVE or PASSIVE.
 758
 759
 760 Version: 8.0.0
 761 --------------
 762
 763 :Release Date: 2021-04-29 (Honolulu Release)
 764
 765 New features
 766 ============
 767
 768 Artifacts released:
 769
 770 .. csv-table::
 771    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
 772    :widths: 15,10,10
 773
 774    "policy/parent", "3.3.0", ""
 775    "policy/common", "1.8.0", ""
 776    "policy/models", "2.4.2", ""
 777    "policy/api", "2.4.2", "onap/policy-api:2.4.2"
 778    "policy/pap", "2.4.2", "onap/policy-pap:2.4.2"
 779    "policy/drools-pdp", "1.8.2", "onap/policy-drools:1.8.2"
 780    "policy/apex-pdp", "2.5.2", "onap/policy-apex-pdp:2.5.2"
 781    "policy/xacml-pdp", "2.4.2", "onap/policy-xacml-pdp:2.4.2"
 782    "policy/drools-applications", "1.8.2", "onap/policy-pdpd-cl:1.8.2"
 783    "policy/distribution", "2.5.2", "onap/policy-distribution:2.5.2"
 784    "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
 785
 786 Key Updates
 787 ===========
 788
 789 * Enhanced statistics
 790    - PDPs provide statistics, retrievable via PAP REST API
 791 * PDP deployment status
 792    - Policy deployment API enhanced to reflect actual policy deployment status in PDPs
 793    - Make PAP component stateless
 794 * Policy support
 795    - Upgrade XACML 3.0 code to use new Time Extensions
 796    - Enhancements for interoperability between Native Policies and other policy types
 797    - Support for arbitrary policy types on the Drools PDP
 798    - Improve handling of multiple policies in APEX PDP
 799    - Update policy-models TOSCA handling with Control Loop Entities
 800 * Alternative locking mechanisms
 801    - Support NO locking feature in Drools-PDP
 802 * Security
 803    - Remove credentials in code from the Apex JMS plugin
 804 * Actor enhancements
 805    - Actors should give better warnings than NPE when data is missing
 806    - Remove old event-specific actor code
 807 * PDP functional assignments
 808    - Make PDP type configurable in drools-pdp
 809    - Make PDP type configurable in xacml-pdp
 810 * Performance improvements
 811    - Support policy updates between PAP and the PDPs, phase 1
 812 * Maintainability
 813    - Use ONAP base docker image
 814    - Remove GPLv3 components from docker containers
 815    - Move CSITs to Policy repos
 816    - Deprecate server pool feature in drools-pdp
 817 * PoCs
 818    - Merge CLAMP functionality into Policy Framework project
 819    - TOSCA Defined Control Loop
 820
 821
 822 Known Limitations, Issues and Workarounds
 823 =========================================
 824
 825 System Limitations
 826 ~~~~~~~~~~~~~~~~~~
 827
 828 The policy API component requires a fresh new database when migrating to the honolulu release.
 829 Therefore, upgrades require a fresh new database installation.
 830 Please see the
 831 `Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/honolulu/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
 832
 833 Known Vulnerabilities
 834 ~~~~~~~~~~~~~~~~~~~~~
 835
 836 Workarounds
 837 ~~~~~~~~~~~
 838
 839 * `POLICY-2998 <https://jira.onap.org/browse/POLICY-2998>`_ - Provide a script to periodically purge the statistics table
 840
 841 Security Notes
 842 ==============
 843
 844 * `POLICY-3005 <https://jira.onap.org/browse/POLICY-3005>`_ - Bump direct dependency versions
 845     - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.12
 846     - Upgrade org.eclipse.persistence to 2.7.8
 847     - Upgrade org.glassfish.jersey.containers to 2.33
 848     - Upgrade com.fasterxml.jackson.module to 2.11.3
 849     - Upgrade com.google.re2j to 1.5
 850     - Upgrade org.mariadb.jdbc to 2.7.1
 851     - Upgrade commons-codec to 1.15
 852     - Upgrade com.thoughtworks.xstream to 1.4.15
 853     - Upgrade org.apache.httpcomponents:httpclient to 4.5.13
 854     - Upgrade org.apache.httpcomponents:httpcore to 4.4.14
 855     - Upgrade org.json to 20201115
 856     - Upgrade org.projectlombok to 1.18.16
 857     - Upgrade org.yaml to 1.27
 858     - Upgrade io.cucumber to 6.9.1
 859     - Upgrade org.apache.commons:commons-lang3 to 3.11
 860     - Upgrade commons-io to 2.8.0
 861 * `POLICY-2943 <https://jira.onap.org/browse/POLICY-2943>`_ - Review license scan issues
 862     - Upgrade com.hazelcast to 4.1.1
 863     - Upgrade io.netty to 4.1.58.Final
 864 * `POLICY-2936 <https://jira.onap.org/browse/POLICY-2936>`_ - Upgrade to latest version of CDS API
 865     - Upgrade io.grpc to 1.35.0
 866     - Upgrade com.google.protobuf to 3.14.0
 867
 868
 869 References
 870 ==========
 871
 872 For more information on the ONAP Honolulu release, please see:
 873
 874 #. `ONAP Home Page`_
 875 #. `ONAP Documentation`_
 876 #. `ONAP Release Downloads`_
 877 #. `ONAP Wiki Page`_
 878
 879
 880 .. _`ONAP Home Page`: https://www.onap.org
 881 .. _`ONAP Wiki Page`: https://wiki.onap.org
 882 .. _`ONAP Documentation`: https://docs.onap.org
 883 .. _`ONAP Release Downloads`: https://git.onap.org
 884
 885 Quick Links:
 886     - `POLICY project page`_
 887     - `Passing Badge information for POLICY`_
 888
 889 ..      ========================
 890 ..      * * *    GUILIN    * * *
 891 ..      ========================
 892
 893 Version: 7.0.0
 894 --------------
 895
 896 :Release Date: 2020-12-03 (Guilin Release)
 897
 898 New features
 899 ============
 900
 901 Artifacts released:
 902
 903 .. csv-table::
 904    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
 905    :widths: 15,10,10
 906
 907    "policy/parent", "3.2.0", ""
 908    "policy/common", "1.7.1", ""
 909    "policy/models", "2.3.5", ""
 910    "policy/api", "2.3.3", "onap/policy-api:2.3.3"
 911    "policy/pap", "2.3.3", "onap/policy-pap:2.3.3"
 912    "policy/drools-pdp", "1.7.4", "onap/policy-drools:1.7.4"
 913    "policy/apex-pdp", "2.4.4", "onap/policy-apex-pdp:2.4.4"
 914    "policy/xacml-pdp", "2.3.3", "onap/policy-xacml-pdp:2.3.3"
 915    "policy/drools-applications", "1.7.5", "onap/policy-pdpd-cl:1.7.5"
 916    "policy/distribution", "2.4.3", "onap/policy-distribution:2.4.3"
 917    "policy/docker", "2.1.1", "onap/policy-jdk-alpine:2.1.1, onap/policy-jre-alpine:2.1.1"
 918
 919 Key Updates
 920 ===========
 921
 922 * Kubernetes integration
 923    - All components return with non-zero exit code in case of application failure
 924    - All components log to standard out (i.e., k8s logs) by default
 925    - Continue to write log files inside individual pods, as well
 926 * E2E Network Slicing
 927    - Added ModifyNSSI operation to SO actor
 928 * Consolidated health check
 929    - Indicate failure if there aren’t enough PDPs registered
 930 * Legacy operational policies
 931    - Removed from all components
 932 * OOM helm charts refactoring
 933    - Name standardization
 934    - Automated certificate generation
 935 * Actor Model
 936    - Support various use cases and provide more flexibility to Policy Designers
 937    - Reintroduced the "usecases" controller into drools-pdp, supporting the use cases
 938      under the revised actor architecture
 939 * Guard Application
 940    - Support policy filtering
 941 * Matchable Application
 942   - Support for ONAP or 3rd party components to create matchable policy types out of the box
 943 * Policy Lifecycle & Administration API
 944    - Query/Delete by policy name & version without policy type
 945 * Apex-PDP enhancements
 946    - Support multiple event & response types coming from a single endpoint
 947    - Standalone installation now supports Tosca-based policies
 948    - Legacy policy format has been removed
 949    - Support chaining/handling of gRPC failure responses
 950 * Policy Distribution
 951    - HPA decoders & related classes have been removed
 952 * Policy Engine
 953    - Deprecated
 954
 955 Known Limitations, Issues and Workarounds
 956 =========================================
 957
 958 System Limitations
 959 ~~~~~~~~~~~~~~~~~~
 960
 961 The policy API component requires a fresh new database when migrating to the guilin release.
 962 Therefore, upgrades require a fresh new database installation.
 963 Please see the
 964 `Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/guilin/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
 965
 966 Known Vulnerabilities
 967 ~~~~~~~~~~~~~~~~~~~~~
 968
 969 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
 970
 971 Workarounds
 972 ~~~~~~~~~~~
 973 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Use the stringify method of the execution context
 974
 975 Security Notes
 976 ==============
 977
 978 * `POLICY-2878 <https://jira.onap.org/browse/POLICY-2878>`_ - Dependency upgrades
 979     - Upgrade com.fasterxml.jackson to 2.11.1
 980 * `POLICY-2387 <https://jira.onap.org/browse/POLICY-2387>`_ - Dependency upgrades
 981     - Upgrade org.json to 20200518
 982     - Upgrade com.google.re2j to 1.4
 983     - Upgrade com.thoughtworks.xstream to 1.4.12
 984     - Upgrade org.eclipse.persistence to 2.2.1
 985     - Upgrade org.apache.httpcomponents to 4.5.12
 986     - Upgrade org.projectlombok to 1.18.12
 987     - Upgrade org.slf4j to 1.7.30
 988     - Upgrade org.codehaus.plexus to 3.3.0
 989     - Upgrade com.h2database to 1.4.200
 990     - Upgrade io.cucumber to 6.1.2
 991     - Upgrade org.assertj to 3.16.1
 992     - Upgrade com.openpojo to 0.8.13
 993     - Upgrade org.mockito to 3.3.3
 994     - Upgrade org.awaitility to 4.0.3
 995     - Upgrade org.onap.aaf.authz to 2.1.21
 996 * `POLICY-2668 <https://jira.onap.org/browse/POLICY-2668>`_ - Dependency upgrades
 997     - Upgrade org.java-websocket to 1.5.1
 998 * `POLICY-2623 <https://jira.onap.org/browse/POLICY-2623>`_ - Remove log4j dependency
 999 * `POLICY-1996 <https://jira.onap.org/browse/POLICY-1996>`_ - Dependency upgrades
1000     - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.11
1001
1002
1003 References
1004 ==========
1005
1006 For more information on the ONAP Guilin release, please see:
1007
1008 #. `ONAP Home Page`_
1009 #. `ONAP Documentation`_
1010 #. `ONAP Release Downloads`_
1011 #. `ONAP Wiki Page`_
1012
1013
1014 .. _`ONAP Home Page`: https://www.onap.org
1015 .. _`ONAP Wiki Page`: https://wiki.onap.org
1016 .. _`ONAP Documentation`: https://docs.onap.org
1017 .. _`ONAP Release Downloads`: https://git.onap.org
1018
1019 Quick Links:
1020     - `POLICY project page`_
1021     - `Passing Badge information for POLICY`_
1022
1023
1024 ..      ===========================
1025 ..      * * *    FRANKFURT    * * *
1026 ..      ===========================
1027
1028
1029 Version: 6.0.1
1030 --------------
1031
1032 :Release Date: 2020-08-21 (Frankfurt Maintenance Release #1)
1033
1034 **Artifacts**
1035
1036 Artifacts released:
1037
1038 .. csv-table::
1039    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1040    :widths: 15,10,10
1041
1042    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
1043
1044
1045 **Bug Fixes**
1046
1047
1048     * `[POLICY-2704] <https://jira.onap.org/browse/POLICY-2704>`_ - Legacy PDP-X and PAP stuck in PodIntializing
1049
1050
1051 **Security Notes**
1052
1053 *Fixed Security Issues*
1054
1055
1056     * `[POLICY-2678] <https://jira.onap.org/browse/POLICY-2678>`_ - policy/engine tomcat upgrade for CVE-2020-11996
1057
1058
1059 Version: 6.0.0
1060 --------------
1061
1062 :Release Date: 2020-06-04 (Frankfurt Release)
1063
1064 New features
1065 ============
1066
1067 Artifacts released:
1068
1069 .. csv-table::
1070    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1071    :widths: 15,10,10
1072
1073    "policy/parent", "3.1.3", ""
1074    "policy/common", "1.6.5", ""
1075    "policy/models", "2.2.6", ""
1076    "policy/api", "2.2.4", "onap/policy-api:2.2.4"
1077    "policy/pap", "2.2.3", "onap/policy-pap:2.2.3"
1078    "policy/drools-pdp", "1.6.3", "onap/policy-drools:1.6.3"
1079    "policy/apex-pdp", "2.3.2", "onap/policy-apex-pdp:2.3.2"
1080    "policy/xacml-pdp", "2.2.2", "onap/policy-xacml-pdp:2.2.2"
1081    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
1082    "policy/engine", "1.6.4", "onap/policy-pe:1.6.4"
1083    "policy/distribution", "2.3.2", "onap/policy-distribution:2.3.2"
1084    "policy/docker", "2.0.1", "onap/policy-jdk-alpine:2.0.1, onap/policy-jre-alpine:2.0.1, onap/policy-jdk-debian:2.0.1, onap/policy-jre-debian:2.0.1"
1085
1086 Summary
1087 =======
1088
1089 New features include policy update notifications, native policy support, streamlined health check for the Policy Administration Point (PAP),
1090 configurable pre-loading/pre-deployment of policies, new APIs (e.g. to create one or more Policies with a single call), new experimental PDP monitoring GUI, and enhancements to all three PDPs: XACML, Drools, APEX.
1091
1092 Common changes in all policy components
1093 =======================================
1094
1095 * Upgraded all policy components to Java 11.
1096 * Logback file can be now loaded using OOM configmap.
1097    - If needed, logback file can be loaded as a configmap during the OOM deployment. For this, just put the logback.xml file in corresponding config directory in OOM charts.
1098
1099 * TOSCA changes:
1100    - “tosca_definitions_version” is now “tosca_simple_yaml_1_1_0”
1101    - typeVersion→ type_version, int→integer, bool→boolean, String→string, Map→map, List→list
1102 * SupportedPolicyTypes now removed from pdp status message.
1103    - All PDPs now send PdpGroup to which they belong to in the registration message.
1104    - SupportedPolicyTypes are not sent anymore.
1105
1106 * Native Policy Support
1107    - Each PDP engine has its own native policy language. A new Policy Type **onap.policies.Native** was created and supported for each PDP
1108      engine to support native policy types.
1109
1110
1111 POLICY-PAP
1112 ==========
1113
1114 * Policy Update Notifications
1115    - PAP now generates notifications  via the DMaaP Message Router when policies are successfully or unsuccessfully deployed (or undeployed) from all relevant PDPs.
1116
1117 * PAP API to fetch Policy deployment status
1118    - Clients will be able to poll the PAP API to find out when policies have been successfully or unsuccessfully deployed to the PDP's.
1119
1120 * Removing supportedPolicyTypes from PdpStatus
1121    - PDPs are assigned to a PdpGroup based on what group is mentioned in the heartbeat. Earlier this was done based on the supportedPolicyTypes.
1122
1123 * Support policy types with wild-cards, Preload wildcard supported type in PAP
1124
1125 * PAP should NOT make a PDP passive if it cannot deploy a policy.
1126    - If a PDP fails to deploy one or more policies specified in a PDP-UPDATE message, PAP will undeploy those policies that failed to deploy to the PDP.  This entails removing the policies from the Pdp Group(s), issuing new PDP-UPDATE requests, and updating the notification tracking data.
1127    - Also, re-register pdp if not found in the DB during heartbeat processing.
1128
1129 * Consolidated health check in PAP
1130    - PAP can report the health check for ALL the policy components now. The PDP’s health is tracked based on heartbeats, and other component’s REST API is used for healthcheck.
1131    - “healthCheckRestClientParameters” (REST parameters for API and Distribution healthcheck) are added to the startup config file in PAP.
1132
1133 * PDP statistics from PAP
1134    - All PDPs send statistics data as part of the heartbeat. PAP reads this and saves this data to the database, and this statistics data can be accessed from the monitoring GUI.
1135
1136 * PAP API for Create or Update PdpGroups
1137    - A new API is now available just for creating/updating PDP Groups. Policies cannot be added/updated during PDP Group create/update operations. There is another API for this. So, if provided in the create/update group request, they are ignored. Supported policy types are defined during PDP Group creation. They cannot be updated once they are created. Refer to this for details: https://github.com/onap/policy-parent/blob/master/docs/pap/pap.rst#id8
1138
1139 * PAP API to deploy policies to PdpGroups
1140    - A new API is introduced to deploy policies on specific PDPGroups. Each subgroup includes an "action" property, which is used to indicate that the policies are being added (POST) to the subgroup, deleted (DELETE) from the subgroup, or that the subgroup's entire set of policies is being replaced (PATCH) by a new set of policies.
1141
1142 POLICY-API
1143 ==========
1144
1145 * A new simplified API to create one or more policies in one call.
1146    - This simplified API doesn’t require policy type id & policy type version to be part of the URL.
1147    - The simple URI “policy/api/v1/policies” with a POST input body takes in a ToscaServiceTemplate with the policies in it.
1148
1149 * List of Preloaded policy types are made configurable
1150    - Until El Alto, the list of pre-loaded policy types are hardcoded in the code. Now, this is made configurable, and the list can be specified in the startup config file for the API component under “preloadPolicyTypes”. The list is ignored if the DB already contains one or more policy types.
1151
1152 * Preload default policies for ONAP components
1153    - The ability to configure the preloading of initial default policies into the system upon startup.
1154
1155 * A lot of improvements to the API code and validations corresponding to the changes in policy-models.
1156    - Creating same policyType/policy repeatedly without any change in request body will always be successful with 200 response
1157    - If there is any change in the request body, then that should be a new version. If any change is posted without a version change, then 406 error response is returned.
1158
1159 * Known versioning issues are there in Policy Types handling.
1160    - https://jira.onap.org/browse/POLICY-2377 covers the versioning issues in Policy. Basically, multiple versions of a Policy Type cannot be handled in TOSCA. So, in Frankfurt, the latest version of the policy type is examined. This will be further looked into in Guilin.
1161
1162 * Cascaded GET of PolicyTypes and Policies
1163    - Fetching/GET PolicyType now returns all of the referenced/parent policyTypes and dataTypes as well.
1164    - Fetching/GET Policy allows specifying mode now.
1165    - By default the mode is “BARE”, which returns only the requested Policy in response. If mode is specified as “REFERENCED”, all of the referenced/parent policyTypes and dataTypes are returned as well.
1166
1167 * The /deployed API is removed from policy/api
1168    - This run time administration job to see the deployment status of a policy is now possible via PAP.
1169
1170 * Changes related to design and support of TOSCA Compliant Policy Types for the operational and guard policy models.
1171
1172 POLICY-DISTRIBUTION
1173 ===================
1174
1175 * From Frankfurt release, policy-distribution component uses APIs provided by Policy-API and Policy-PAP for creation of policy types and policies, and deployment of policies.
1176    - Note: If “deployPolicies” field in the startup config file is true, then only the policies are deployed using PAP endpoint.
1177
1178 * Policy/engine & apex-pdp dependencies are removed from policy-distribution.
1179
1180
1181 POLICY-APEX-PDP
1182 ===============
1183
1184 * Changed the JavaScript executor from Nashorn to Rhino as part of Java 11 upgrade.
1185    - There are minor changes in the JavaScript task logic files associated with this Rhino migration. An example for this change can be seen here: https://gerrit.onap.org/r/c/policy/apex-pdp/+/103546/2/examples/examples-onap-bbs/src/main/resources/logic/SdncResourceUpdateTask.js
1186
1187    - There is a known issue in Rhino javascript related to the usage of JSON.stringify. This is captured in this JIRA https://jira.onap.org/browse/POLICY-2463.
1188
1189 * APEX supports multiple policy deployment in Frankfurt.
1190    - Up through El Alto APEX-PDP had the capability to take in only a single ToscaPolicy. When PAP sends a list of Tosca Policies in PdpUpdate, only the first one is taken and only that single Policy is deployed in APEX. This is fixed in Frankfurt. Now, APEX can deploy a list of Tosca Policies altogether into the engine.
1191
1192    - Note: There shouldn’t be any duplicates in the deployed policies (for e.g. same input/output parameter names, or same event/task names etc).
1193
1194    - For example, when 3 policies are deployed and one has duplicates, say same input/task or any such concept is used in the 2nd and 3rd policy, then APEX-PDP ignores the 3rd policy and executes only the 1st and 2nd policies. APEX-PDP also respond back to PAP with the message saying that “only Policy 1 and 2 are deployed. Others failed due to duplicate concept”.
1195
1196 * Context retainment during policy upgrade.
1197    - In APEX-PDP, context is referred by the apex concept ‘contextAlbum’. When there is no major version change in the upgraded policy to be deployed, the existing context of the currently running policy is retained. When the upgraded policy starts running, it will have access to this context as well.
1198
1199    - For example, Policy A v1.1 is currently deployed to APEX. It has a contextAlbum named HeartbeatContext and heartbeats are currently added to the HeartbeatContext based on events coming in to the policy execution. Now, when Policy A v1.2 (with some other changes and same HeartbeatContext) is deployed, Policy Av1.1 is replaced by Policy A1.2 in the APEX engine, but the content in HeartbeatContext is retained for Policy A1.2.
1200
1201 * APEX-PDP now specifies which PdpGroup it belongs to.
1202    - Up through El Alto, PAP assigned each PDP to a PDP group based on the supportedPolicyTypes it sends in the heartbeat. But in Frankfurt, each PDP comes up saying which PdpGroup they belong to, and this is sent to PAP in the heartbeat. PAP then registers the PDP the PdpGroup specified by the PDP. If no group name is specified like this, then PAP assigns the PDP to defaultGroup by default. SupportedPolicyTypes are not sent to PAP by the PDP now.
1203
1204    - In APEX-PDP, this can be specified in the startup config file(OnapPfConfig.json). "pdpGroup": "<groupName>" is added under “pdpStatusParameters” in the config file.
1205
1206 * APEX-PDP now sends PdpStatistics data in heartbeat.
1207    - Apex now sends the PdpStatistics data in every heartbeat sent to PAP. PAP saves this data to the database, and this statistics data can be accessed from the monitoring GUI.
1208
1209 * Removed “content” section from ToscaPolicy properties in APEX.
1210    - Up through El Alto, APEX specific policy information was placed under properties|content in ToscaPolicy. Avoid placing under "content" and keep the information directly under properties. So, the ToscaPolicy structure will have apex specific policy information in properties|engineServiceParameters, properties|eventInputParameters, properties|eventOutputParameters.
1211
1212 * Passing parameters from ApexConfig to policy logic.
1213    - TaskParameters can be used to pass parameters from ApexConfig to the policy logic. Consider a scenario where from CLAMP, serviceId or closedLoopId has to be passed to the policy, and this should be available to perform some logic or action within the policy. In the CLAMP UI, while configuring the APEX Policy, specifying taskParameters with these will enable this.
1214
1215    - More information about the usage of Task Parameters can be found here: https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-User-Manual.html#configure-task-parameters
1216
1217    - In the taskLogic, taskParameters can be accessed as  executor.parameters.get("ParameterKey1"))
1218
1219    - More information can be found here: https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-Policy-Guide.html#accessing-taskparameters
1220
1221 * GRPC support for APEX-CDS interaction.
1222    - APEX-PDP now supports interaction with CDS over gRPC. Up through El Alto, CDS interaction was possible over REST only. A new plugin was developed in APEX for this feature. Refer the link for more details. https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-User-Manual.html#grpc-io
1223
1224 POLICY-XACML-PDP
1225 ================
1226
1227 * Added optional Decision API param to Decision API for monitor decisions that returns abbreviated results.
1228    - Return only an abbreviated list of policies (e.g. metadata Policy Id and Version) without the actual contents of the policies (e.g. the Properties).
1229
1230 * XACML PDP now support PASSIVE_MODE.
1231 * Added support to return status and error if pdp-x failed to load a policy.
1232 * Changed optimization Decision API application to support "closest matches" algorithm.
1233 * Changed Xacml-pdp to report the pdp group defined in XacmlPdpParameters config file as part of heartbeat. Also, removed supportedPolicyType from pdpStatus message.
1234 * Design the TOSCA policy model for SDNC naming policies and implement an application that translates it to a working policy and is available for decision API.
1235 * XACML pdp support for Control Loop Coordination
1236    - Added policies for SON and PCI to support each blocking the other, with test cases and appropriate requests
1237
1238 * Extend PDP-X capabilities so that it can load in and enforce the native XACML policies deployed from PAP.
1239
1240 POLICY-DROOLS-PDP
1241 =================
1242
1243 * Support for PDP-D in offline mode to support locked deployments.   This is the default ONAP installation.
1244 * Parameterize maven repository URLs for easier CI/CD integration.
1245 * Support for Tosca Compliant Operational Policies.
1246 * Support for TOSCA Compliant Native Policies that allows creation and deployment of new drools-applications.
1247 * Validation of Operational and Native Policies against their policy type.
1248 * Support for a generic Drools-PDP docker image to host any type of application.
1249 * Experimental Server Pool feature that supports multiple active Drools PDP hosts.
1250
1251 POLICY-DROOLS-APPLICATIONS
1252 ==========================
1253
1254 * Removal of DCAE ONSET alarm duplicates (with different request IDs).
1255 * Support of a new controller (frankfurt) that supports the ONAP use cases under the new actor architecture.
1256 * Deprecated the "usecases" controller supporting the use cases under the legacy actor architecture.
1257 * Deleted the unsupported "amsterdam" controller related projects.
1258
1259
1260 Known Limitations, Issues and Workarounds
1261 =========================================
1262
1263 System Limitations
1264 ~~~~~~~~~~~~~~~~~~
1265
1266 The policy API component requires a fresh new database when migrating to the frankfurt release.
1267 Therefore, upgrades require a fresh new database installation.
1268 Please see the
1269 `Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
1270
1271 Known Vulnerabilities
1272 ~~~~~~~~~~~~~~~~~~~~~
1273
1274 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
1275 * `POLICY-2487 <https://jira.onap.org/browse/POLICY-2487>`_ - policy/api hangs in loop if preload policy does not exist
1276
1277 Workarounds
1278 ~~~~~~~~~~~
1279 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Parse incoming object using JSON.Parse() or cast the object to a String
1280
1281 Security Notes
1282 ==============
1283
1284 * `POLICY-2221 <https://jira.onap.org/browse/POLICY-2221>`_ - Password removal from helm charts
1285 * `POLICY-2064 <https://jira.onap.org/browse/POLICY-2064>`_ - Allow overriding of keystore and truststore in policy helm charts
1286 * `POLICY-2381 <https://jira.onap.org/browse/POLICY-2381>`_ - Dependency upgrades
1287     - Upgrade drools 7.33.0
1288     - Upgrade jquery to 3.4.1 in jquery-ui
1289     - Upgrade snakeyaml to 1.26
1290     - Upgrade org.infinispan infinispan-core 10.1.5.Final
1291     - upgrade io.netty 4.1.48.Final
1292     - exclude org.glassfish.jersey.media jersey-media-jaxb artifact
1293     - Upgrade com.fasterxml.jackson.core 2.10.0.pr3
1294     - Upgrade org.org.jgroups 4.1.5.Final
1295     - Upgrade commons-codec 20041127.091804
1296     - Upgrade com.github.ben-manes.caffeine 2.8.0
1297
1298 ..      ==========================
1299 ..      * * *     EL ALTO    * * *
1300 ..      ==========================
1301
1302 Version: 5.0.2
1303 --------------
1304
1305 :Release Date: 2020-08-24 (El Alto Maintenance Release #1)
1306
1307 **New Features**
1308
1309 Artifacts released:
1310
1311 .. csv-table::
1312    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1313    :widths: 15,10,10
1314
1315    "policy/api", "2.1.3", "onap/policy-api:2.1.3"
1316    "policy/pap", "2.1.3", "onap/policy-pap:2.1.3"
1317    "policy/drools-pdp", "1.5.3", "onap/policy-drools:1.5.3"
1318    "policy/apex-pdp", "2.2.3", "onap/policy-apex-pdp:2.2.3"
1319    "policy/xacml-pdp", "2.1.3", "onap/policy-xacml-pdp:2.1.3"
1320    "policy/drools-applications", "1.5.4", "onap/policy-pdpd-cl:1.5.4"
1321    "policy/engine", "1.5.3", "onap/policy-pe:1.5.3"
1322    "policy/distribution", "2.2.2", "onap/policy-distribution:2.2.2"
1323    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0, onap/policy/base-alpine:1.4.0"
1324
1325
1326 **Bug Fixes**
1327
1328
1329     * `[PORTAL-760]  <https://jira.onap.org/browse/PORTAL-760>`_  - Access to Policy portal is impossible
1330     * `[POLICY-2107] <https://jira.onap.org/browse/POLICY-2107>`_ - policy/distribution license issue in resource needs to be removed
1331     * `[POLICY-2169] <https://jira.onap.org/browse/POLICY-2169>`_ - SDC client interface change caused compile error in policy distribution
1332     * `[POLICY-2171] <https://jira.onap.org/browse/POLICY-2171>`_ - Upgrade elalto branch models and drools-applications
1333     * `[POLICY-1509] <https://jira.onap.org/browse/POLICY-1509>`_ - Investigate Apex org.python.jython-standalone.2.7.1
1334     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
1335
1336
1337 **Security Notes**
1338
1339 *Fixed Security Issues*
1340
1341
1342     * `[POLICY-2475] <https://jira.onap.org/browse/POLICY-2475>`_ - Update El Alto component certificates
1343
1344 Version: 5.0.1
1345 --------------
1346
1347 :Release Date: 2019-10-24 (El Alto Release)
1348
1349 **New Features**
1350
1351 Artifacts released:
1352
1353 .. csv-table::
1354    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1355    :widths: 15,10,10
1356
1357    "policy/parent", "3.0.1", ""
1358    "policy/common", "1.5.2", ""
1359    "policy/models", "2.1.4", ""
1360    "policy/api", "2.1.2", "onap/policy-api:2.1.2"
1361    "policy/pap", "2.1.2", "onap/policy-pap:2.1.2"
1362    "policy/drools-pdp", "1.5.2", "onap/policy-drools:1.5.2"
1363    "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
1364    "policy/xacml-pdp", "2.1.2", "onap/policy-xacml-pdp:2.1.2"
1365    "policy/drools-applications", "1.5.3", "onap/policy-pdpd-cl:1.5.3"
1366    "policy/engine", "1.5.2", "onap/policy-pe:1.5.2"
1367    "policy/distribution", "2.2.1", "onap/policy-distribution:2.2.1"
1368    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
1369
1370 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`_.
1371
1372     * [POLICY-1727] - This epic covers technical debt left over from Dublin
1373
1374     - POLICY-969    Docker improvement in policy framwork modules
1375     - POLICY-1074   Fix checkstyle warnings in every repository
1376     - POLICY-1121   RPM build for Apex
1377     - POLICY-1223   CII Silver Badging Requirements
1378     - POLICY-1600   Clean up hash code equality checks, cloning and copying in policy-models
1379     - POLICY-1646   Replace uses of getCanonicalName() with getName()
1380     - POLICY-1652   Move PapRestServer to policy/common
1381     - POLICY-1732   Enable maven-checkstyle-plugin in apex-pdp
1382     - POLICY-1737   Upgrade oParent 2.0.0 - change daily jobs to staging jobs
1383     - POLICY-1742   Make HTTP return code handling configurable in APEX
1384     - POLICY-1743   Make URL configurable in REST Requestor and REST Client
1385     - POLICY-1744   Remove topic.properties and incorporate into overall properties
1386     - POLICY-1770   PAP REST API for PDPGroup Healthcheck
1387     - POLICY-1771   Boost policy/api JUnit code coverage
1388     - POLICY-1772   Boost policy/xacml-pdp JUnit code coverage
1389     - POLICY-1773   Enhance the policy/xacml-pdp S3P Stability and Performance tests
1390     - POLICY-1784   Better Handling of "version" field value with clients
1391     - POLICY-1785   Deploy same policy with a new version simply adds to the list
1392     - POLICY-1786   Create a simple way to populate the guard database for testing
1393     - POLICY-1791   Address Sonar issues in new policy repos
1394     - POLICY-1795   PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
1395     - POLICY-1800   API|PAP components use different version formats
1396     - POLICY-1805   Build up stability test for api component to follow S3P requirements
1397     - POLICY-1806   Build up S3P performance test for api component
1398     - POLICY-1847   Add control loop coordination as a preloaded policy type
1399     - POLICY-1871   Change policy/distribution to support ToscaPolicyType & ToscaPolicy
1400     - POLICY-1881   Upgrade policy/distribution to latest SDC artifacts
1401     - POLICY-1885   Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
1402     - POLICY-1898   Move apex-pdp & distribution documents to policy/parent
1403     - POLICY-1942   Boost policy/apex-pdp JUnit code coverage
1404     - POLICY-1953   Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
1405
1406     * Additional items delivered with the release.
1407
1408     - POLICY-1637   Remove "version" from PdpGroup
1409     - POLICY-1653   Remove isNullVersion() method
1410     - POLICY-1966   Fix more sonar issues in policy drools
1411     - POLICY-1988   Generate El Alto AAF Certificates
1412
1413     * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
1414
1415     - POLICY-1762   Create CDS API model implementation
1416     - POLICY-1763   Create CDS Actor
1417     - POLICY-1899   Update optimization xacml application to support more flexible Decision API
1418     - POLICY-1911   XACML PDP must be able to retrieve Policy Type from API
1419
1420
1421 **Bug Fixes**
1422
1423 The following bug fixes have been deployed with this release:
1424
1425     * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
1426     * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
1427     * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
1428     * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
1429     * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
1430     * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
1431     * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
1432     * `[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
1433     * `[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
1434     * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
1435     * `[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
1436     * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
1437     * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
1438     * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model  currently needs to be escaped
1439     * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
1440     * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
1441     * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
1442     * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
1443     * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
1444     * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
1445     * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
1446     * `[POLICY-2156] <https://jira.onap.org/browse/POLICY-2156>`_ - missing field in create VF module request to SO
1447
1448
1449 **Security Notes**
1450
1451 *Fixed Security Issues*
1452
1453
1454     * `[POLICY-2115] <https://jira.onap.org/browse/POLICY-2115>`_ - Upgrade org.jgroups : jgroups : 4.0.12.Final
1455     * `[POLICY-2084] <https://jira.onap.org/browse/POLICY-2084>`_ - Investigate pip (py2.py3-none-any) 9.0.1 (.whl) in apex-pdp
1456     * `[POLICY-2072] <https://jira.onap.org/browse/POLICY-2072>`_ - Upgrade io.netty : netty-codec-http2 and netty-common to 4.1.39.Final
1457     * `[POLICY-2005] <https://jira.onap.org/browse/POLICY-2005>`_ - Upgrade elastic search to 6.8.2
1458     * `[POLICY-2001] <https://jira.onap.org/browse/POLICY-2001>`_ - Upgrade com.thoughtworks.xstream to 1.4.11.1
1459     * `[POLICY-2000] <https://jira.onap.org/browse/POLICY-2000>`_ - Upgrade oparent 2.1.0-SNAPSHOT - to pull in jetty server to 9.4.20.v20190813
1460     * `[POLICY-1999] <https://jira.onap.org/browse/POLICY-1999>`_ - Upgrade to httpcomponents httpclient 4.5.9
1461     * `[POLICY-1598] <https://jira.onap.org/browse/POLICY-1598>`_ - mariadb container is outdated
1462     * `[POLICY-1597] <https://jira.onap.org/browse/POLICY-1597>`_ - nexus container is outdated
1463
1464 *Known Security Issues*
1465
1466 *Known Vulnerabilities in Used Modules*
1467
1468 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>`_.
1469
1470 Quick Links:
1471     - `POLICY project page`_
1472     - `Passing Badge information for POLICY`_
1473     - `Project Vulnerability Review Table for POLICY (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_
1474
1475 **Known Issues**
1476
1477 The following known issues will be addressed in a future release:
1478
1479     * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
1480     * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
1481     * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
1482     * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
1483     * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
1484     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
1485     * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
1486     * `[POLICY-2111] <https://jira.onap.org/browse/POLICY-2111>`_ - PDP-D APPS: AAF Cadi conflicts with Aether libraries
1487     * `[POLICY-2158] <https://jira.onap.org/browse/POLICY-2158>`_ - PAP loses synchronization with PDPs
1488     * `[POLICY-2159] <https://jira.onap.org/browse/POLICY-2159>`_ - PAP console (legacy): cannot edit policies with GUI
1489
1490
1491 ..      ==========================
1492 ..      * * *      DUBLIN    * * *
1493 ..      ==========================
1494
1495 Version: 4.0.0
1496 --------------
1497
1498 :Release Date: 2019-06-26 (Dublin Release)
1499
1500 **New Features**
1501
1502 Artifacts released:
1503
1504 .. csv-table::
1505    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1506    :widths: 15,10,10
1507
1508    "policy/parent", "2.1.0", ""
1509    "policy/common", "1.4.0", ""
1510    "policy/models", "2.0.2", ""
1511    "policy/api", "2.0.1", "onap/policy-api:2.0.1"
1512    "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
1513    "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
1514    "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
1515    "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
1516    "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
1517    "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
1518    "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
1519    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
1520
1521 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`_.
1522
1523     * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
1524         - POLICY-1195   Separate model code from drools-applications into other repositories
1525         - POLICY-1367   Spike - Experimentation for management of Drools templates and Operational Policies
1526         - POLICY-1397   PDP-D: NOOP Endpoints Support to test Operational Policies.
1527         - POLICY-1459   PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
1528
1529     * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
1530         - POLICY-1007   Remove Jackson from policy framework components
1531         - POLICY-1202   policy-engine & apex-pdp are using different version of eclipselink
1532         - POLICY-1250   Fix issues reported by sonar in policy modules
1533         - POLICY-1368   Remove hibernate from policy repos
1534         - POLICY-1457   Use Alpine in base docker images
1535
1536     * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
1537         - S3P Performance related items
1538
1539     * [POLICY-1171] - Enhance CLC Facility
1540         - POLICY-1173   High-level specification of coordination directives
1541
1542     * [POLICY-1220] - This epic covers the work to support S3P Security criteria
1543         - POLICY-1538   Upgrade Elasticsearch to 6.4.x to clear security issue
1544
1545     * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
1546         - POLICY-1270   Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
1547         - POLICY-1271   PAP RESTful HealthCheck/Statistics Main Entry Point
1548         - POLICY-1272   Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
1549         - POLICY-1273   Policy Type Application Design Requirements
1550         - POLICY-1436   XACML PDP RESTful HealthCheck/Statistics Main Entry Point
1551         - POLICY-1440   XACML PDP RESTful Decision API Main Entry Point
1552         - POLICY-1441   Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
1553         - POLICY-1442   Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
1554         - POLICY-1443   PAP Dmaap PDP Register/UnRegister Main Entry Point
1555         - POLICY-1444   PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
1556         - POLICY-1445   XACML PDP upgrade to xacml 2.0.0
1557         - POLICY-1446   Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
1558         - POLICY-1447   Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
1559         - POLICY-1449   XACML PDP Dmaap Register/UnRegister Functionality
1560         - POLICY-1451   XACML PDP Dmaap Deploy/UnDeploy Functionality
1561         - POLICY-1452   Apex PDP Dmaap Register/UnRegister Functionality
1562         - POLICY-1453   Apex PDP Dmaap Deploy/UnDeploy Functionality
1563         - POLICY-1454   Drools PDP Dmaap Register/UnRegister Functionality
1564         - POLICY-1455   Drools PDP Dmaap Deploy/UnDeploy Functionality
1565         - POLICY-1456   Policy Architecture and Roadmap Documentation
1566         - POLICY-1458   Create S3P JMeter Tests for Policy API
1567         - POLICY-1460   Create S3P JMeter Tests for PAP
1568         - POLICY-1461   Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
1569         - POLICY-1462   Create S3P JMeter Tests for Policy SDC Distribution
1570         - POLICY-1471   Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
1571         - POLICY-1474   Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
1572         - POLICY-1515   Prototype Policy Lifecycle API Swagger Entry Points
1573         - POLICY-1516   Prototype the Policy Decision API
1574         - POLICY-1541   PAP REST API for PDPGroup Query, Statistics & Delete
1575         - POLICY-1542   PAP REST API for PDPGroup Deployment, State Management & Health Check
1576
1577     * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
1578         - Model drive control loop related items
1579
1580     * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
1581         - POLICY-1405   Develop SDNC API for trigger bandwidth
1582
1583     * [POLICY-1408] - This epic covers the work done with the Casablanca release
1584         - POLICY-1410   List Policy API
1585         - POLICY-1413   Dashboard enhancements
1586         - POLICY-1414   Push Policy and DeletePolicy API enhancement
1587         - POLICY-1416   Model enhancements to support CLAMP
1588         - POLICY-1417   Resiliency improvements
1589         - POLICY-1418   PDP APIs - make ClientAuth optional
1590         - POLICY-1419   Better multi-role support
1591         - POLICY-1420   Model enhancement to support embedded JSON
1592         - POLICY-1421   New audit data for push/delete
1593         - POLICY-1422   Enhanced encryption
1594         - POLICY-1423   Save original model file
1595         - POLICY-1427   Controller Logging Feature
1596         - POLICY-1489   PDP-D: Nested JSON Event Filtering support with JsonPath
1597         - POLICY-1499   Mdc Filter Feature
1598
1599     * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
1600         - POLICY-1463   Functional code changes in Policy for OOF SON use case
1601         - POLICY-1464   Config related aspects for OOF SON use case
1602
1603     * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
1604         - POLICY-1278   AAI named-queries are being deprecated and should be replaced with custom-queries
1605         - POLICY-1545   E2E Automation - Parse the newly added model ids from operation policy
1606
1607     * Additional items delivered with the release.
1608         - POLICY-1159   Move expectException to policy-common/utils-test
1609         - POLICY-1176   Work on technical debt introduced by CLC POC
1610         - POLICY-1266   A&AI Modularity
1611         - POLICY-1274   further improvement in PSSD S3P test
1612         - POLICY-1401   Build onap.policies.Monitoring TOSCA Policy Template
1613         - POLICY-1465   Support configurable Heap Memory Settings for JVM processes
1614
1615
1616 **Bug Fixes**
1617
1618 The following bug fixes have been deployed with this release:
1619
1620     * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
1621     * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
1622     * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
1623     * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
1624     * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
1625
1626 **Security Notes**
1627
1628 *Fixed Security Issues*
1629
1630     * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
1631     * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
1632     * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
1633     * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
1634
1635 *Known Security Issues*
1636
1637 *Known Vulnerabilities in Used Modules*
1638
1639 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>`_.
1640
1641 Quick Links:
1642     - `POLICY project page`_
1643     - `Passing Badge information for POLICY`_
1644     - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
1645
1646
1647 **Known Issues**
1648
1649 The following known issues will be addressed in a future release:
1650
1651     * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
1652     * `[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.
1653     * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
1654     * `[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
1655     * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
1656     * `[POLICY-1671] - <https://jira.onap.org/browse/POLICY-1671>`_ policy/engine JUnit tests now take over 30 minutes to run
1657     * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
1658     * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
1659     * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
1660     * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
1661     * `[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
1662     * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
1663     * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
1664     * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
1665     * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
1666     * `[POLICY-1872] - <https://jira.onap.org/browse/POLICY-1872>`_ brmsgw fails building a jar - trafficgenerator dependency does not exist
1667
1668
1669 ..      ==========================
1670 ..      * * *   CASABLANCA   * * *
1671 ..      ==========================
1672
1673 Version: 3.0.2
1674 --------------
1675
1676 :Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
1677
1678 The following items were deployed with the Casablanca Maintenance Release:
1679
1680 **Bug Fixes**
1681
1682     * [POLICY-1522] - Policy doesn't send "payload" field to APPC
1683
1684 **Security Fixes**
1685
1686     * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
1687
1688 **License Issues**
1689
1690     * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
1691
1692 **Known Issues**
1693
1694 The following known issue will be addressed in a future release.
1695
1696     * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
1697
1698 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.
1699
1700
1701 Version: 3.0.1
1702 --------------
1703
1704 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
1705
1706 The following items were deployed with the Casablanca Maintenance Release:
1707
1708 **New Features**
1709
1710     * [POLICY-1221] - Policy distribution application to support HTTPS communication
1711     * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
1712
1713 **Bug Fixes**
1714
1715     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
1716     * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
1717
1718
1719 Version: 3.0.0
1720 --------------
1721
1722 :Release Date: 2018-11-30 (Casablanca Release)
1723
1724 **New Features**
1725
1726 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).
1727
1728     * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
1729
1730     The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
1731
1732     * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
1733     * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
1734     * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
1735
1736     The policy team did some forward looking spike work towards re-building the Software Architecture.
1737
1738     * [POLICY-809] - Maintain and implement performance
1739     * [POLICY-814] - 72 hour stability testing (component and platform)
1740
1741     The policy team made enhancements to the Drools PDP to further support S3P Performance.
1742     For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
1743     performance standard and performed 72 hour stability tests.
1744
1745     * [POLICY-824] - maintain and implement security
1746
1747     The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
1748     MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
1749
1750     * [POLICY-840] - Flexible control loop coordination facility.
1751
1752     Work towards a POC for control loop coordination policies were implemented.
1753
1754     * [POLICY-841] - Covers the work required to support HPA
1755
1756     Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
1757
1758     * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
1759
1760     Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
1761
1762     * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
1763
1764     A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
1765     sonar issues, and checkstyle.
1766
1767     * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
1768
1769     Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
1770
1771     * [POLICY-1182] - Covers the work to support CCVPN use case
1772
1773     Policy templates changes were submitted that supported the CCVPN use case.
1774
1775 **Bug Fixes**
1776
1777 The following bug fixes have been deployed with this release:
1778
1779     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
1780     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
1781     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
1782     * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
1783     * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
1784     * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
1785     * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
1786     * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
1787
1788
1789 **Security Notes**
1790
1791 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>`_.
1792
1793 Quick Links:
1794     - `POLICY project page`_
1795     - `Passing Badge information for POLICY`_
1796     - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
1797
1798 **Known Issues**
1799
1800     * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
1801     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
1802
1803
1804
1805 ..      =======================
1806 ..      * * *   BEIJING   * * *
1807 ..      =======================
1808
1809 Version: 2.0.0
1810 --------------
1811
1812 :Release Date: 2018-06-07 (Beijing Release)
1813
1814 **New Features**
1815
1816 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`_.
1817
1818     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
1819         - POLICY-238    policy/drools-applications: clean up maven structure
1820         - POLICY-336    Address Technical Debt
1821         - POLICY-338    Address JUnit Code Coverage
1822         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
1823         - POLICY-389    Cleanup Jenkin's CI/CD process's
1824         - POLICY-449    Policy API + Console : Common Policy Validation
1825         - POLICY-568    Integration with org.onap AAF project
1826         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
1827
1828     * [POLICY-391] - This epic covers the work to support Release Planning activities
1829         - POLICY-552    ONAP Licensing Scan - Use Restrictions
1830
1831     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
1832         - POLICY-529    Platform Maturity Performance - Drools PDP
1833         - POLICY-567    Platform Maturity Performance - PDP-X
1834
1835     * [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.
1836         - POLICY-488    pap should not add rules to official template provided in drools applications
1837
1838     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
1839         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
1840
1841     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
1842         - POLICY-622    Integrate OOF Policy Model into Policy Platform
1843
1844     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
1845         - POLICY-525    Platform Maturity Stability - Drools PDP
1846         - POLICY-526    Platform Maturity Stability - XACML PDP
1847
1848     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
1849         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
1850         - POLICY-528    Platform Maturity Resiliency - Drools PDP
1851         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
1852         - POLICY-585    Platform Maturity Resiliency - XACML PDP
1853         - POLICY-586    Platform Maturity Resiliency - Planning
1854         - POLICY-681    Regression Test Use Cases
1855
1856     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
1857         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
1858
1859     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
1860         - POLICY-531    Platform Maturity Scalability - XACML PDP
1861         - POLICY-532    Platform Maturity Scalability - Drools PDP
1862         - POLICY-623    Docker image re-design
1863
1864     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
1865         - POLICY-533    Platform Maturity Manageability L1 - Logging
1866         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
1867
1868     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
1869         - POLICY-535    Platform Maturity Usability - User Guide
1870         - POLICY-536    Platform Maturity Usability - Deployment Documentation
1871         - POLICY-537    Platform Maturity Usability - API Documentation
1872
1873     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
1874
1875
1876 **Bug Fixes**
1877
1878 The following bug fixes have been deployed with this release:
1879
1880     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
1881     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
1882     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
1883     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
1884     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
1885     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
1886     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
1887     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
1888     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
1889     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
1890     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
1891     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
1892     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
1893     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
1894     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
1895
1896
1897 **Security Notes**
1898
1899 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>`_.
1900
1901 Quick Links:
1902     - `POLICY project page`_
1903     - `Passing Badge information for POLICY`_
1904     - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
1905
1906 **Known Issues**
1907
1908 The following known issues will be addressed in a future release:
1909
1910     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
1911     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
1912     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
1913     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
1914     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
1915     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
1916     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
1917     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
1918
1919
1920
1921
1922 Version: 1.0.2
1923 --------------
1924
1925 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
1926
1927 **Bug Fixes**
1928
1929 The following fixes were deployed with the Amsterdam Maintenance Release:
1930
1931     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
1932
1933
1934 Version: 1.0.1
1935 --------------
1936
1937 :Release Date: 2017-11-16 (Amsterdam Release)
1938
1939 **New Features**
1940
1941 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`_.
1942
1943     * [POLICY-31] - Stabilization of Seed Code
1944         - POLICY-25  Replace any remaining openecomp reference by onap
1945         - POLICY-32  JUnit test code coverage
1946         - POLICY-66  PDP-D Feature mechanism enhancements
1947         - POLICY-67  Rainy Day Decision Policy
1948         - POLICY-93  Notification API
1949         - POLICY-158  policy/engine: SQL injection Mitigation
1950         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
1951
1952     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
1953         - POLICY-40  MSB Integration
1954         - POLICY-124  Integration with oparent
1955         - POLICY-41  OOM Integration
1956         - POLICY-119  PDP-D: noop sinks
1957
1958     * [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.
1959         - POLICY-57  VF-C Actor code development
1960         - POLICY-43  Amsterdam Use Case Template
1961         - POLICY-173  Deployment of Operational Policies Documentation
1962
1963     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
1964         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
1965
1966     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
1967
1968     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
1969         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
1970         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
1971         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
1972         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
1973
1974     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
1975
1976     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
1977         - POLICY-61  vFW Use Case - Runtime
1978         - POLICY-62  vDNS Use Case - Runtime
1979         - POLICY-59  vCPE Use Case - Runtime
1980         - POLICY-60  VOLTE Use Case - Runtime
1981         - POLICY-51  Runtime Policy Update Support
1982         - POLICY-328  vDNS Use Case - Runtime Testing
1983         - POLICY-324  vFW Use Case - Runtime Testing
1984         - POLICY-320  VOLTE Use Case - Runtime Testing
1985         - POLICY-316  vCPE Use Case - Runtime Testing
1986
1987     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
1988         - POLICY-77  Functional Test case definition for Control Loops
1989         - POLICY-387  Deliver the released policy artifacts
1990
1991
1992 **Bug Fixes**
1993     - 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`_.
1994
1995
1996 **Known Issues**
1997     - 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.
1998
1999     - For vLBS Use Case, the following steps are required to setup the service instance:
2000         -  Create a Service Instance via VID.
2001         -  Create a VNF Instance via VID.
2002         -  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.
2003         -  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.
2004         -  Run heatbridge from the Robot VM using ``Vfmodule_`` _ as stack name (it is the actual stack name in OpenStack)
2005         -  Populate AAI with a dummy VF module for vDNS scaling.
2006
2007 **Security Issues**
2008     - None at this time
2009
2010 **Other**
2011     - None at this time
2012
2013
2014 .. Links to jira release notes
2015
2016 .. _JiraPolicyElAlto: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10728
2017 .. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
2018 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
2019 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
2020 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
2021
2022 .. Links to Project related pages
2023
2024 .. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
2025 .. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
2026
2027
2028 .. note
2029 ..      CHANGE  HISTORY
2030 ..  09/19/2019 - Updated for El Alto Release.
2031 ..  05/16/2019 - Updated for Dublin Release.
2032 ..      01/17/2019 - Updated for Casablanca Maintenance Release.
2033 ..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
2034 ..      Changed version number to use ONAP versions.
2035 ..      10/08/2018 - Initial document for Casablanca release.
2036 ..  05/29/2018 - Information for Beijing release.
2037 ..      03/22/2018 - Initial document for Beijing release.
2038 ..      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)
2039 ..      Also, Set up initial information for Beijing.
2040 ..      Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
2041
2042
2043 End of Release Notes
2044
2045 .. How to notes for SS
2046 ..  For initial document: list epic and user stories for each, list user stories with no epics.
2047 ..      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.
2048 ..      For Known issues, list bugs that are slotted for a future release.