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 ..      * This note must be removed after content has been added.
  17
  18 ..      ===========================
  19 ..      * * *    FRANKFURT    * * *
  20 ..      ===========================
  21
  22
  23 Version: 6.0.1
  24 --------------
  25
  26 :Release Date: 2020-08-21 (Frankfurt Maintenance Release #1)
  27
  28 **Artifacts**
  29
  30 Artifacts released:
  31
  32 .. csv-table::
  33    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
  34    :widths: 15,10,10
  35
  36    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
  37
  38
  39 **Bug Fixes**
  40
  41
  42     * `[POLICY-2704] <https://jira.onap.org/browse/POLICY-2704>`_ - Legacy PDP-X and PAP stuck in PodIntializing
  43
  44
  45 **Security Notes**
  46
  47 *Fixed Security Issues*
  48
  49
  50     * `[POLICY-2678] <https://jira.onap.org/browse/POLICY-2678>`_ - policy/engine tomcat upgrade for CVE-2020-11996
  51
  52
  53 Version: 6.0.0
  54 --------------
  55
  56 :Release Date: 2020-06-04 (Frankfurt Release)
  57
  58 New features
  59 ------------
  60
  61 Artifacts released:
  62
  63 .. csv-table::
  64    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
  65    :widths: 15,10,10
  66
  67    "policy/parent", "3.1.3", ""
  68    "policy/common", "1.6.5", ""
  69    "policy/models", "2.2.6", ""
  70    "policy/api", "2.2.4", "onap/policy-api:2.2.4"
  71    "policy/pap", "2.2.3", "onap/policy-pap:2.2.3"
  72    "policy/drools-pdp", "1.6.3", "onap/policy-drools:1.6.3"
  73    "policy/apex-pdp", "2.3.2", "onap/policy-apex-pdp:2.3.2"
  74    "policy/xacml-pdp", "2.2.2", "onap/policy-xacml-pdp:2.2.2"
  75    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
  76    "policy/engine", "1.6.4", "onap/policy-pe:1.6.4"
  77    "policy/distribution", "2.3.2", "onap/policy-distribution:2.3.2"
  78    "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"
  79
  80 Summary
  81 =======
  82
  83 New features include policy update notifications, native policy support, streamlined health check for the Policy Administration Point (PAP),
  84 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.
  85
  86 Common changes in all policy components
  87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88 * Upgraded all policy components to Java 11.
  89 * Logback file can be now loaded using OOM configmap.
  90   - 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.
  91
  92 * TOSCA changes:
  93   - “tosca_definitions_version” is now “tosca_simple_yaml_1_1_0”
  94   - typeVersion→ type_version, int→integer, bool→boolean, String→string, Map→map, List→list
  95 * SupportedPolicyTypes now removed from pdp status message.
  96   - All PDPs now send PdpGroup to which they belong to in the registration message.
  97   - SupportedPolicyTypes are not sent anymore.
  98
  99 * Native Policy Support
 100   - Each PDP engine has its own native policy language. A new Policy Type **onap.policies.Native** was created and supported for each PDP
 101   engine to support native policy types.
 102
 103
 104 POLICY-PAP
 105 ~~~~~~~~~~
 106 * Policy Update Notifications
 107   - PAP now generates notifications  via the DMaaP Message Router when policies are successfully or unsuccessfully deployed (or undeployed) from all relevant PDPs.
 108
 109 * PAP API to fetch Policy deployment status
 110   - Clients will be able to poll the PAP API to find out when policies have been successfully or unsuccessfully deployed to the PDP's.
 111
 112 * Removing supportedPolicyTypes from PdpStatus
 113   - PDPs are assigned to a PdpGroup based on what group is mentioned in the heartbeat. Earlier this was done based on the supportedPolicyTypes.
 114
 115 * Support policy types with wild-cards, Preload wildcard supported type in PAP
 116
 117 * PAP should NOT make a PDP passive if it cannot deploy a policy.
 118   - 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.
 119   - Also, re-register pdp if not found in the DB during heartbeat processing.
 120
 121 * Consolidated health check in PAP
 122   - 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.
 123   - “healthCheckRestClientParameters” (REST parameters for API and Distribution healthcheck) are added to the startup config file in PAP.
 124
 125 * PDP statistics from PAP
 126  - 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.
 127
 128 * PAP API for Create or Update PdpGroups
 129  - 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
 130
 131 * PAP API to deploy policies to PdpGroups
 132  - 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.
 133
 134 POLICY-API
 135 ~~~~~~~~~~
 136
 137 * A new simplified API to create one or more policies in one call.
 138   - This simplified API doesn’t require policy type id & policy type version to be part of the URL.
 139   - The simple URI “policy/api/v1/policies” with a POST input body takes in a ToscaServiceTemplate with the policies in it.
 140
 141 * List of Preloaded policy types are made configurable
 142   - 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.
 143
 144 * Preload default policies for ONAP components
 145   - The ability to configure the preloading of initial default policies into the system upon startup.
 146
 147 * A lot of improvements to the API code and validations corresponding to the changes in policy-models.
 148   - Creating same policyType/policy repeatedly without any change in request body will always be successful with 200 response
 149   - 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.
 150
 151 * Known versioning issues are there in Policy Types handling.
 152   - 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.
 153
 154 * Cascaded GET of PolicyTypes and Policies
 155   - Fetching/GET PolicyType now returns all of the referenced/parent policyTypes and dataTypes as well.
 156   - Fetching/GET Policy allows specifying mode now.
 157   - 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.
 158
 159 * The /deployed API is removed from policy/api
 160   - This run time administration job to see the deployment status of a policy is now possible via PAP.
 161
 162 * Changes related to design and support of TOSCA Compliant Policy Types for the operational and guard policy models.
 163
 164 POLICY-DISTRIBUTION
 165 ~~~~~~~~~~~~~~~~~~~
 166
 167 * 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.
 168   - Note: If “deployPolicies” field in the startup config file is true, then only the policies are deployed using PAP endpoint.
 169
 170 * Policy/engine & apex-pdp dependencies are removed from policy-distribution.
 171
 172
 173 APEX-PDP
 174 ~~~~~~~~
 175
 176 * Changed the JavaScript executor from Nashorn to Rhino as part of Java 11 upgrade.
 177   - 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
 178
 179   - 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.
 180
 181 * APEX supports multiple policy deployment in Frankfurt.
 182   - 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.
 183
 184   - 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).
 185
 186   - 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”.
 187
 188 * Context retainment during policy upgrade.
 189   - 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.
 190
 191   - 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.
 192
 193 * APEX-PDP now specifies which PdpGroup it belongs to.
 194   - 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.
 195
 196   - In APEX-PDP, this can be specified in the startup config file(OnapPfConfig.json). "pdpGroup": "<groupName>" is added under “pdpStatusParameters” in the config file.
 197
 198 * APEX-PDP now sends PdpStatistics data in heartbeat.
 199   - 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.
 200
 201 * Removed “content” section from ToscaPolicy properties in APEX.
 202   - 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.
 203
 204 * Passing parameters from ApexConfig to policy logic.
 205   - 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.
 206
 207   - More information about the usage of Task Parameters can be found here: https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-User-Manual.html#configure-task-parameters
 208
 209   - In the taskLogic, taskParameters can be accessed as  executor.parameters.get("ParameterKey1"))
 210
 211   - More information can be found here: https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-Policy-Guide.html#accessing-taskparameters
 212
 213 * GRPC support for APEX-CDS interaction.
 214   - 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://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-User-Manual.html#grpc-io
 215
 216 POLICY-XACML
 217 ~~~~~~~~~~~~
 218
 219 * Added optional Decision API param to Decision API for monitor decisions that returns abbreviated results.
 220   - 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).
 221
 222 * XACML PDP now support PASSIVE_MODE.
 223 * Added support to return status and error if pdp-x failed to load a policy.
 224 * Changed optimization Decision API application to support "closest matches" algorithm.
 225 * Changed Xacml-pdp to report the pdp group defined in XacmlPdpParameters config file as part of heartbeat. Also, removed supportedPolicyType from pdpStatus message.
 226 * 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.
 227 * XACML pdp support for Control Loop Coordination
 228   - Added policies for SON and PCI to support each blocking the other, with test cases and appropriate requests
 229
 230 * Extend PDP-X capabilities so that it can load in and enforce the native XACML policies deployed from PAP.
 231
 232 POLICY-DROOLS-PDP
 233 ~~~~~~~~~~~~~~~~~
 234
 235 * Support for PDP-D in offline mode to support locked deployments.   This is the default ONAP installation.
 236 * Parameterize maven repository URLs for easier CI/CD integration.
 237 * Support for Tosca Compliant Operational Policies.
 238 * Support for TOSCA Compliant Native Policies that allows creation and deployment of new drools-applications.
 239 * Validation of Operational and Native Policies against their policy type.
 240 * Support for a generic Drools-PDP docker image to host any type of application.
 241 * Experimental Server Pool feature that supports multiple active Drools PDP hosts.
 242
 243 POLICY-DROOLS-APPLICATIONS
 244 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 245
 246 * Removal of DCAE ONSET alarm duplicates (with different request IDs).
 247 * Support of a new controller (frankfurt) that supports the ONAP use cases under the new actor architecture.
 248 * Deprecated the "usecases" controller supporting the use cases under the legacy actor architecture.
 249 * Deleted the unsupported "amsterdam" controller related projects.
 250
 251 Known Limitations, Issues and Workarounds
 252 =========================================
 253
 254 System Limitations
 255 ------------------
 256
 257 The policy API component requires a fresh new database when migrating to the frankfurt release.
 258 Therefore, upgrades require a fresh new database installation.
 259 Please see the
 260 `Installing or Upgrading Policy <https://onap.readthedocs.io/en/frankfurt/submodules/policy/parent.git/docs/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
 261
 262 For an operational policy targeted towards VNF, the CDS actor always requires "vserver" information to query A&AI while processing ONSET events.
 263
 264 Known Vulnerabilities
 265 ---------------------
 266
 267 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
 268 * `POLICY-2487 <https://jira.onap.org/browse/POLICY-2487>`_ - policy/api hangs in loop if preload policy does not exist
 269
 270 Workarounds
 271 -----------
 272 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Parse incoming object using JSON.Parse() or cast the object to a String
 273
 274 Security Notes
 275 --------------
 276
 277 * `POLICY-2221 <https://jira.onap.org/browse/POLICY-2221>`_ - Password removal from helm charts
 278 * `POLICY-2064 <https://jira.onap.org/browse/POLICY-2064>`_ - Allow overriding of keystore and truststore in policy helm charts
 279 * `POLICY-2381 <https://jira.onap.org/browse/POLICY-2381>`_ - Dependency upgrades
 280     - Upgrade drools 7.33.0
 281     - Upgrade jquery to 3.4.1 in jquery-ui
 282     - Upgrade snakeyaml to 1.26
 283     - Upgrade org.infinispan infinispan-core 10.1.5.Final
 284     - upgrade io.netty 4.1.48.Final
 285     - exclude org.glassfish.jersey.media jersey-media-jaxb artifact
 286     - Upgrade com.fasterxml.jackson.core 2.10.0.pr3
 287     - Upgrade org.org.jgroups 4.1.5.Final
 288     - Upgrade commons-codec 20041127.091804
 289     - Upgrade com.github.ben-manes.caffeine 2.8.0
 290
 291
 292 References
 293 ==========
 294
 295 For more information on the ONAP Frankfurt release, please see:
 296
 297 #. `ONAP Home Page`_
 298 #. `ONAP Documentation`_
 299 #. `ONAP Release Downloads`_
 300 #. `ONAP Wiki Page`_
 301
 302
 303 .. _`ONAP Home Page`: https://www.onap.org
 304 .. _`ONAP Wiki Page`: https://wiki.onap.org
 305 .. _`ONAP Documentation`: https://docs.onap.org
 306 .. _`ONAP Release Downloads`: https://git.onap.org
 307
 308 Quick Links:
 309     - `POLICY project page`_
 310     - `Passing Badge information for POLICY`_
 311
 312 ..      ==========================
 313 ..      * * *     EL ALTO    * * *
 314 ..      ==========================
 315
 316 Version: 5.0.2
 317 --------------
 318
 319 :Release Date: 2020-08-24 (El Alto Maintenance Release #1)
 320
 321 **New Features**
 322
 323 Artifacts released:
 324
 325 .. csv-table::
 326    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
 327    :widths: 15,10,10
 328
 329    "policy/api", "2.1.3", "onap/policy-api:2.1.3"
 330    "policy/pap", "2.1.3", "onap/policy-pap:2.1.3"
 331    "policy/drools-pdp", "1.5.3", "onap/policy-drools:1.5.3"
 332    "policy/apex-pdp", "2.2.3", "onap/policy-apex-pdp:2.2.3"
 333    "policy/xacml-pdp", "2.1.3", "onap/policy-xacml-pdp:2.1.3"
 334    "policy/drools-applications", "1.5.4", "onap/policy-pdpd-cl:1.5.4"
 335    "policy/engine", "1.5.3", "onap/policy-pe:1.5.3"
 336    "policy/distribution", "2.2.2", "onap/policy-distribution:2.2.2"
 337    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0, onap/policy/base-alpine:1.4.0"
 338
 339
 340 **Bug Fixes**
 341
 342
 343     * `[PORTAL-760]  <https://jira.onap.org/browse/PORTAL-760>`_  - Access to Policy portal is impossible
 344     * `[POLICY-2107] <https://jira.onap.org/browse/POLICY-2107>`_ - policy/distribution license issue in resource needs to be removed
 345     * `[POLICY-2169] <https://jira.onap.org/browse/POLICY-2169>`_ - SDC client interface change caused compile error in policy distribution
 346     * `[POLICY-2171] <https://jira.onap.org/browse/POLICY-2171>`_ - Upgrade elalto branch models and drools-applications
 347     * `[POLICY-1509] <https://jira.onap.org/browse/POLICY-1509>`_ - Investigate Apex org.python.jython-standalone.2.7.1
 348     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
 349
 350
 351 **Security Notes**
 352
 353 *Fixed Security Issues*
 354
 355
 356     * `[POLICY-2475] <https://jira.onap.org/browse/POLICY-2475>`_ - Update El Alto component certificates
 357
 358 Version: 5.0.1
 359 --------------
 360
 361 :Release Date: 2019-10-24 (El Alto Release)
 362
 363 **New Features**
 364
 365 Artifacts released:
 366
 367 .. csv-table::
 368    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
 369    :widths: 15,10,10
 370
 371    "policy/parent", "3.0.1", ""
 372    "policy/common", "1.5.2", ""
 373    "policy/models", "2.1.4", ""
 374    "policy/api", "2.1.2", "onap/policy-api:2.1.2"
 375    "policy/pap", "2.1.2", "onap/policy-pap:2.1.2"
 376    "policy/drools-pdp", "1.5.2", "onap/policy-drools:1.5.2"
 377    "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
 378    "policy/xacml-pdp", "2.1.2", "onap/policy-xacml-pdp:2.1.2"
 379    "policy/drools-applications", "1.5.3", "onap/policy-pdpd-cl:1.5.3"
 380    "policy/engine", "1.5.2", "onap/policy-pe:1.5.2"
 381    "policy/distribution", "2.2.1", "onap/policy-distribution:2.2.1"
 382    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
 383
 384 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`_.
 385
 386     * [POLICY-1727] - This epic covers technical debt left over from Dublin
 387     - POLICY-969    Docker improvement in policy framwork modules
 388     - POLICY-1074   Fix checkstyle warnings in every repository
 389     - POLICY-1121   RPM build for Apex
 390     - POLICY-1223   CII Silver Badging Requirements
 391     - POLICY-1600   Clean up hash code equality checks, cloning and copying in policy-models
 392     - POLICY-1646   Replace uses of getCanonicalName() with getName()
 393     - POLICY-1652   Move PapRestServer to policy/common
 394     - POLICY-1732   Enable maven-checkstyle-plugin in apex-pdp
 395     - POLICY-1737   Upgrade oParent 2.0.0 - change daily jobs to staging jobs
 396     - POLICY-1742   Make HTTP return code handling configurable in APEX
 397     - POLICY-1743   Make URL configurable in REST Requestor and REST Client
 398     - POLICY-1744   Remove topic.properties and incorporate into overall properties
 399     - POLICY-1770   PAP REST API for PDPGroup Healthcheck
 400     - POLICY-1771   Boost policy/api JUnit code coverage
 401     - POLICY-1772   Boost policy/xacml-pdp JUnit code coverage
 402     - POLICY-1773   Enhance the policy/xacml-pdp S3P Stability and Performance tests
 403     - POLICY-1784   Better Handling of "version" field value with clients
 404     - POLICY-1785   Deploy same policy with a new version simply adds to the list
 405     - POLICY-1786   Create a simple way to populate the guard database for testing
 406     - POLICY-1791   Address Sonar issues in new policy repos
 407     - POLICY-1795   PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
 408     - POLICY-1800   API|PAP components use different version formats
 409     - POLICY-1805   Build up stability test for api component to follow S3P requirements
 410     - POLICY-1806   Build up S3P performance test for api component
 411     - POLICY-1847   Add control loop coordination as a preloaded policy type
 412     - POLICY-1871   Change policy/distribution to support ToscaPolicyType & ToscaPolicy
 413     - POLICY-1881   Upgrade policy/distribution to latest SDC artifacts
 414     - POLICY-1885   Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
 415     - POLICY-1898   Move apex-pdp & distribution documents to policy/parent
 416     - POLICY-1942   Boost policy/apex-pdp JUnit code coverage
 417     - POLICY-1953   Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
 418
 419     * Additional items delivered with the release.
 420     - POLICY-1637   Remove "version" from PdpGroup
 421     - POLICY-1653   Remove isNullVersion() method
 422     - POLICY-1966   Fix more sonar issues in policy drools
 423     - POLICY-1988   Generate El Alto AAF Certificates
 424
 425     * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
 426     - POLICY-1762   Create CDS API model implementation
 427     - POLICY-1763   Create CDS Actor
 428     - POLICY-1899   Update optimization xacml application to support more flexible Decision API
 429     - POLICY-1911   XACML PDP must be able to retrieve Policy Type from API
 430
 431
 432 **Bug Fixes**
 433
 434 The following bug fixes have been deployed with this release:
 435
 436     * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
 437     * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
 438     * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
 439     * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
 440     * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
 441     * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
 442     * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
 443     * `[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
 444     * `[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
 445     * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
 446     * `[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
 447     * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
 448     * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
 449     * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model  currently needs to be escaped
 450     * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
 451     * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
 452     * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
 453     * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
 454     * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
 455     * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
 456     * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
 457     * `[POLICY-2156] <https://jira.onap.org/browse/POLICY-2156>`_ - missing field in create VF module request to SO
 458
 459
 460 **Security Notes**
 461
 462 *Fixed Security Issues*
 463
 464
 465     * `[POLICY-2115] <https://jira.onap.org/browse/POLICY-2115>`_ - Upgrade org.jgroups : jgroups : 4.0.12.Final
 466     * `[POLICY-2084] <https://jira.onap.org/browse/POLICY-2084>`_ - Investigate pip (py2.py3-none-any) 9.0.1 (.whl) in apex-pdp
 467     * `[POLICY-2072] <https://jira.onap.org/browse/POLICY-2072>`_ - Upgrade io.netty : netty-codec-http2 and netty-common to 4.1.39.Final
 468     * `[POLICY-2005] <https://jira.onap.org/browse/POLICY-2005>`_ - Upgrade elastic search to 6.8.2
 469     * `[POLICY-2001] <https://jira.onap.org/browse/POLICY-2001>`_ - Upgrade com.thoughtworks.xstream to 1.4.11.1
 470     * `[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
 471     * `[POLICY-1999] <https://jira.onap.org/browse/POLICY-1999>`_ - Upgrade to httpcomponents httpclient 4.5.9
 472     * `[POLICY-1598] <https://jira.onap.org/browse/POLICY-1598>`_ - mariadb container is outdated
 473     * `[POLICY-1597] <https://jira.onap.org/browse/POLICY-1597>`_ - nexus container is outdated
 474
 475 *Known Security Issues*
 476
 477 *Known Vulnerabilities in Used Modules*
 478
 479 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>`_.
 480
 481 Quick Links:
 482     - `POLICY project page`_
 483     - `Passing Badge information for POLICY`_
 484     - `Project Vulnerability Review Table for POLICY (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_
 485
 486 **Known Issues**
 487
 488 The following known issues will be addressed in a future release:
 489
 490     * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
 491     * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
 492     * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
 493     * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
 494     * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
 495     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
 496     * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
 497     * `[POLICY-2111] <https://jira.onap.org/browse/POLICY-2111>`_ - PDP-D APPS: AAF Cadi conflicts with Aether libraries
 498     * `[POLICY-2158] <https://jira.onap.org/browse/POLICY-2158>`_ - PAP loses synchronization with PDPs
 499     * `[POLICY-2159] <https://jira.onap.org/browse/POLICY-2159>`_ - PAP console (legacy): cannot edit policies with GUI
 500
 501
 502 ..      ==========================
 503 ..      * * *      DUBLIN    * * *
 504 ..      ==========================
 505
 506 Version: 4.0.0
 507 --------------
 508
 509 :Release Date: 2019-06-26 (Dublin Release)
 510
 511 **New Features**
 512
 513 Artifacts released:
 514
 515 .. csv-table::
 516    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
 517    :widths: 15,10,10
 518
 519    "policy/parent", "2.1.0", ""
 520    "policy/common", "1.4.0", ""
 521    "policy/models", "2.0.2", ""
 522    "policy/api", "2.0.1", "onap/policy-api:2.0.1"
 523    "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
 524    "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
 525    "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
 526    "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
 527    "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
 528    "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
 529    "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
 530    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
 531
 532 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`_.
 533
 534     * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
 535         - POLICY-1195   Separate model code from drools-applications into other repositories
 536         - POLICY-1367   Spike - Experimentation for management of Drools templates and Operational Policies
 537         - POLICY-1397   PDP-D: NOOP Endpoints Support to test Operational Policies.
 538         - POLICY-1459   PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
 539
 540     * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
 541         - POLICY-1007   Remove Jackson from policy framework components
 542         - POLICY-1202   policy-engine & apex-pdp are using different version of eclipselink
 543         - POLICY-1250   Fix issues reported by sonar in policy modules
 544         - POLICY-1368   Remove hibernate from policy repos
 545         - POLICY-1457   Use Alpine in base docker images
 546
 547     * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
 548         - S3P Performance related items
 549
 550     * [POLICY-1171] - Enhance CLC Facility
 551         - POLICY-1173   High-level specification of coordination directives
 552
 553     * [POLICY-1220] - This epic covers the work to support S3P Security criteria
 554         - POLICY-1538   Upgrade Elasticsearch to 6.4.x to clear security issue
 555
 556     * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
 557         - POLICY-1270   Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
 558         - POLICY-1271   PAP RESTful HealthCheck/Statistics Main Entry Point
 559         - POLICY-1272   Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
 560         - POLICY-1273   Policy Type Application Design Requirements
 561         - POLICY-1436   XACML PDP RESTful HealthCheck/Statistics Main Entry Point
 562         - POLICY-1440   XACML PDP RESTful Decision API Main Entry Point
 563         - POLICY-1441   Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
 564         - POLICY-1442   Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
 565         - POLICY-1443   PAP Dmaap PDP Register/UnRegister Main Entry Point
 566         - POLICY-1444   PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
 567         - POLICY-1445   XACML PDP upgrade to xacml 2.0.0
 568         - POLICY-1446   Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
 569         - POLICY-1447   Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
 570         - POLICY-1449   XACML PDP Dmaap Register/UnRegister Functionality
 571         - POLICY-1451   XACML PDP Dmaap Deploy/UnDeploy Functionality
 572         - POLICY-1452   Apex PDP Dmaap Register/UnRegister Functionality
 573         - POLICY-1453   Apex PDP Dmaap Deploy/UnDeploy Functionality
 574         - POLICY-1454   Drools PDP Dmaap Register/UnRegister Functionality
 575         - POLICY-1455   Drools PDP Dmaap Deploy/UnDeploy Functionality
 576         - POLICY-1456   Policy Architecture and Roadmap Documentation
 577         - POLICY-1458   Create S3P JMeter Tests for Policy API
 578         - POLICY-1460   Create S3P JMeter Tests for PAP
 579         - POLICY-1461   Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
 580         - POLICY-1462   Create S3P JMeter Tests for Policy SDC Distribution
 581         - POLICY-1471   Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
 582         - POLICY-1474   Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
 583         - POLICY-1515   Prototype Policy Lifecycle API Swagger Entry Points
 584         - POLICY-1516   Prototype the Policy Decision API
 585         - POLICY-1541   PAP REST API for PDPGroup Query, Statistics & Delete
 586         - POLICY-1542   PAP REST API for PDPGroup Deployment, State Management & Health Check
 587
 588     * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
 589         - Model drive control loop related items
 590
 591     * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
 592         - POLICY-1405   Develop SDNC API for trigger bandwidth
 593
 594     * [POLICY-1408] - This epic covers the work done with the Casablanca release
 595         - POLICY-1410   List Policy API
 596         - POLICY-1413   Dashboard enhancements
 597         - POLICY-1414   Push Policy and DeletePolicy API enhancement
 598         - POLICY-1416   Model enhancements to support CLAMP
 599         - POLICY-1417   Resiliency improvements
 600         - POLICY-1418   PDP APIs - make ClientAuth optional
 601         - POLICY-1419   Better multi-role support
 602         - POLICY-1420   Model enhancement to support embedded JSON
 603         - POLICY-1421   New audit data for push/delete
 604         - POLICY-1422   Enhanced encryption
 605         - POLICY-1423   Save original model file
 606         - POLICY-1427   Controller Logging Feature
 607         - POLICY-1489   PDP-D: Nested JSON Event Filtering support with JsonPath
 608         - POLICY-1499   Mdc Filter Feature
 609
 610     * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
 611         - POLICY-1463   Functional code changes in Policy for OOF SON use case
 612         - POLICY-1464   Config related aspects for OOF SON use case
 613
 614     * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
 615         - POLICY-1278   AAI named-queries are being deprecated and should be replaced with custom-queries
 616         - POLICY-1545   E2E Automation - Parse the newly added model ids from operation policy
 617
 618     * Additional items delivered with the release.
 619         - POLICY-1159   Move expectException to policy-common/utils-test
 620         - POLICY-1176   Work on technical debt introduced by CLC POC
 621         - POLICY-1266   A&AI Modularity
 622         - POLICY-1274   further improvement in PSSD S3P test
 623         - POLICY-1401   Build onap.policies.Monitoring TOSCA Policy Template
 624         - POLICY-1465   Support configurable Heap Memory Settings for JVM processes
 625
 626
 627 **Bug Fixes**
 628
 629 The following bug fixes have been deployed with this release:
 630
 631     * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
 632     * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
 633     * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
 634     * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
 635     * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
 636
 637 **Security Notes**
 638
 639 *Fixed Security Issues*
 640
 641     * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
 642     * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
 643     * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
 644     * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
 645
 646 *Known Security Issues*
 647
 648 *Known Vulnerabilities in Used Modules*
 649
 650 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>`_.
 651
 652 Quick Links:
 653     - `POLICY project page`_
 654     - `Passing Badge information for POLICY`_
 655     - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
 656
 657
 658 **Known Issues**
 659
 660 The following known issues will be addressed in a future release:
 661
 662     * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
 663     * `[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.
 664     * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
 665     * `[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
 666     * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
 667     * `[POLICY-1671] - <https://jira.onap.org/browse/POLICY-1671>`_ policy/engine JUnit tests now take over 30 minutes to run
 668     * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
 669     * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
 670     * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
 671     * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
 672     * `[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
 673     * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
 674     * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
 675     * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
 676     * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
 677     * `[POLICY-1872] - <https://jira.onap.org/browse/POLICY-1872>`_ brmsgw fails building a jar - trafficgenerator dependency does not exist
 678
 679
 680 ..      ==========================
 681 ..      * * *   CASABLANCA   * * *
 682 ..      ==========================
 683
 684 Version: 3.0.2
 685 --------------
 686
 687 :Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
 688
 689 The following items were deployed with the Casablanca Maintenance Release:
 690
 691 **Bug Fixes**
 692
 693     * [POLICY-1522] - Policy doesn't send "payload" field to APPC
 694
 695 **Security Fixes**
 696
 697     * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
 698
 699 **License Issues**
 700
 701     * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
 702
 703 **Known Issues**
 704
 705 The following known issue will be addressed in a future release.
 706
 707     * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
 708
 709 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.
 710
 711
 712 Version: 3.0.1
 713 --------------
 714
 715 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
 716
 717 The following items were deployed with the Casablanca Maintenance Release:
 718
 719 **New Features**
 720
 721     * [POLICY-1221] - Policy distribution application to support HTTPS communication
 722     * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
 723
 724 **Bug Fixes**
 725
 726     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
 727     * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
 728
 729
 730 Version: 3.0.0
 731 --------------
 732
 733 :Release Date: 2018-11-30 (Casablanca Release)
 734
 735 **New Features**
 736
 737 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).
 738
 739     * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
 740
 741     The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
 742
 743     * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
 744     * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
 745     * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
 746
 747     The policy team did some forward looking spike work towards re-building the Software Architecture.
 748
 749     * [POLICY-809] - Maintain and implement performance
 750     * [POLICY-814] - 72 hour stability testing (component and platform)
 751
 752     The policy team made enhancements to the Drools PDP to further support S3P Performance.
 753     For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
 754     performance standard and performed 72 hour stability tests.
 755
 756     * [POLICY-824] - maintain and implement security
 757
 758     The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
 759     MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
 760
 761     * [POLICY-840] - Flexible control loop coordination facility.
 762
 763     Work towards a POC for control loop coordination policies were implemented.
 764
 765     * [POLICY-841] - Covers the work required to support HPA
 766
 767     Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
 768
 769     * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
 770
 771     Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
 772
 773     * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
 774
 775     A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
 776     sonar issues, and checkstyle.
 777
 778     * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
 779
 780     Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
 781
 782     * [POLICY-1182] - Covers the work to support CCVPN use case
 783
 784     Policy templates changes were submitted that supported the CCVPN use case.
 785
 786 **Bug Fixes**
 787
 788 The following bug fixes have been deployed with this release:
 789
 790     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
 791     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
 792     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
 793     * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
 794     * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
 795     * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
 796     * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
 797     * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
 798
 799
 800 **Security Notes**
 801
 802 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>`_.
 803
 804 Quick Links:
 805     - `POLICY project page`_
 806     - `Passing Badge information for POLICY`_
 807     - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
 808
 809 **Known Issues**
 810
 811     * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
 812     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
 813
 814
 815
 816 ..      =======================
 817 ..      * * *   BEIJING   * * *
 818 ..      =======================
 819
 820 Version: 2.0.0
 821 --------------
 822
 823 :Release Date: 2018-06-07 (Beijing Release)
 824
 825 **New Features**
 826
 827 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`_.
 828
 829     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
 830         - POLICY-238    policy/drools-applications: clean up maven structure
 831         - POLICY-336    Address Technical Debt
 832         - POLICY-338    Address JUnit Code Coverage
 833         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
 834         - POLICY-389    Cleanup Jenkin's CI/CD process's
 835         - POLICY-449    Policy API + Console : Common Policy Validation
 836         - POLICY-568    Integration with org.onap AAF project
 837         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
 838
 839     * [POLICY-391] - This epic covers the work to support Release Planning activities
 840         - POLICY-552    ONAP Licensing Scan - Use Restrictions
 841
 842     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
 843         - POLICY-529    Platform Maturity Performance - Drools PDP
 844         - POLICY-567    Platform Maturity Performance - PDP-X
 845
 846     * [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.
 847         - POLICY-488    pap should not add rules to official template provided in drools applications
 848
 849     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
 850         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
 851
 852     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
 853         - POLICY-622    Integrate OOF Policy Model into Policy Platform
 854
 855     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
 856         - POLICY-525    Platform Maturity Stability - Drools PDP
 857         - POLICY-526    Platform Maturity Stability - XACML PDP
 858
 859     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
 860         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
 861         - POLICY-528    Platform Maturity Resiliency - Drools PDP
 862         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
 863         - POLICY-585    Platform Maturity Resiliency - XACML PDP
 864         - POLICY-586    Platform Maturity Resiliency - Planning
 865         - POLICY-681    Regression Test Use Cases
 866
 867     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
 868         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
 869
 870     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
 871         - POLICY-531    Platform Maturity Scalability - XACML PDP
 872         - POLICY-532    Platform Maturity Scalability - Drools PDP
 873         - POLICY-623    Docker image re-design
 874
 875     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
 876         - POLICY-533    Platform Maturity Manageability L1 - Logging
 877         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
 878
 879     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
 880         - POLICY-535    Platform Maturity Usability - User Guide
 881         - POLICY-536    Platform Maturity Usability - Deployment Documentation
 882         - POLICY-537    Platform Maturity Usability - API Documentation
 883
 884     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
 885
 886
 887 **Bug Fixes**
 888
 889 The following bug fixes have been deployed with this release:
 890
 891     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
 892     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
 893     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
 894     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
 895     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
 896     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
 897     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
 898     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
 899     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
 900     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
 901     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
 902     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
 903     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
 904     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
 905     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
 906
 907
 908 **Security Notes**
 909
 910 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>`_.
 911
 912 Quick Links:
 913     - `POLICY project page`_
 914     - `Passing Badge information for POLICY`_
 915     - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
 916
 917 **Known Issues**
 918
 919 The following known issues will be addressed in a future release:
 920
 921     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
 922     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
 923     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
 924     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
 925     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
 926     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
 927     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
 928     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
 929
 930
 931
 932
 933 Version: 1.0.2
 934 --------------
 935
 936 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
 937
 938 **Bug Fixes**
 939
 940 The following fixes were deployed with the Amsterdam Maintenance Release:
 941
 942     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
 943
 944
 945 Version: 1.0.1
 946 --------------
 947
 948 :Release Date: 2017-11-16 (Amsterdam Release)
 949
 950 **New Features**
 951
 952 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`_.
 953
 954     * [POLICY-31] - Stabilization of Seed Code
 955         - POLICY-25  Replace any remaining openecomp reference by onap
 956         - POLICY-32  JUnit test code coverage
 957         - POLICY-66  PDP-D Feature mechanism enhancements
 958         - POLICY-67  Rainy Day Decision Policy
 959         - POLICY-93  Notification API
 960         - POLICY-158  policy/engine: SQL injection Mitigation
 961         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
 962
 963     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
 964         - POLICY-40  MSB Integration
 965         - POLICY-124  Integration with oparent
 966         - POLICY-41  OOM Integration
 967         - POLICY-119  PDP-D: noop sinks
 968
 969     * [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.
 970         - POLICY-57  VF-C Actor code development
 971         - POLICY-43  Amsterdam Use Case Template
 972         - POLICY-173  Deployment of Operational Policies Documentation
 973
 974     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
 975         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
 976
 977     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
 978
 979     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
 980         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
 981         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
 982         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
 983         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
 984
 985     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
 986
 987     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
 988         - POLICY-61  vFW Use Case - Runtime
 989         - POLICY-62  vDNS Use Case - Runtime
 990         - POLICY-59  vCPE Use Case - Runtime
 991         - POLICY-60  VOLTE Use Case - Runtime
 992         - POLICY-51  Runtime Policy Update Support
 993         - POLICY-328  vDNS Use Case - Runtime Testing
 994         - POLICY-324  vFW Use Case - Runtime Testing
 995         - POLICY-320  VOLTE Use Case - Runtime Testing
 996         - POLICY-316  vCPE Use Case - Runtime Testing
 997
 998     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
 999         - POLICY-77  Functional Test case definition for Control Loops
1000         - POLICY-387  Deliver the released policy artifacts
1001
1002
1003 **Bug Fixes**
1004     - 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`_.
1005
1006
1007 **Known Issues**
1008     - 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.
1009
1010     - For vLBS Use Case, the following steps are required to setup the service instance:
1011         -  Create a Service Instance via VID.
1012         -  Create a VNF Instance via VID.
1013         -  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.
1014         -  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.
1015         -  Run heatbridge from the Robot VM using ``Vfmodule_`` _ as stack name (it is the actual stack name in OpenStack)
1016         -  Populate AAI with a dummy VF module for vDNS scaling.
1017
1018 **Security Issues**
1019     - None at this time
1020
1021 **Other**
1022     - None at this time
1023
1024
1025 .. Links to jira release notes
1026
1027 .. _JiraPolicyElAlto: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10728
1028 .. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
1029 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
1030 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
1031 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
1032
1033 .. Links to Project related pages
1034
1035 .. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
1036 .. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
1037
1038
1039 .. note
1040 ..      CHANGE  HISTORY
1041 ..  09/19/2019 - Updated for El Alto Release.
1042 ..  05/16/2019 - Updated for Dublin Release.
1043 ..      01/17/2019 - Updated for Casablanca Maintenance Release.
1044 ..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
1045 ..      Changed version number to use ONAP versions.
1046 ..      10/08/2018 - Initial document for Casablanca release.
1047 ..  05/29/2018 - Information for Beijing release.
1048 ..      03/22/2018 - Initial document for Beijing release.
1049 ..      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)
1050 ..      Also, Set up initial information for Beijing.
1051 ..      Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
1052
1053
1054 End of Release Notes
1055
1056 .. How to notes for SS
1057 ..  For initial document: list epic and user stories for each, list user stories with no epics.
1058 ..      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.
1059 ..      For Known issues, list bugs that are slotted for a future release.