diff options
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/release-notes.rst | 274 |
2 files changed, 216 insertions, 60 deletions
diff --git a/docs/index.rst b/docs/index.rst index 36eee8e6..64bfd4af 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. _policy-framework-doc: + Policy Framework Architecture ----------------------------- .. toctree:: diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 618ba297..df2961f4 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -5,15 +5,160 @@ Policy Release Notes .. note .. * This Release Notes must be updated each time the team decides to Release new artifacts. -.. * The scope of these Release Notes are for ONAP POLICY. In other words, each ONAP component has its Release Notes. -.. * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of +.. * The scope of these Release Notes are for ONAP POLICY. In other words, each ONAP component has its Release Notes. +.. * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of .. * this Release Notes. -.. * Except the date and the version number, all the other sections are optional but there must be at least -.. * one section describing the purpose of this new release. +.. * Except the date and the version number, all the other sections are optional but there must be at least +.. * one section describing the purpose of this new release. .. * This note must be removed after content has been added. .. ========================== +.. * * * DUBLIN * * * +.. ========================== + +Version: 4.0.0 +-------------- + +:Release Date: 2019-06-06 (Dublin Release) + +**New Features** + +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`_. + + * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base. + - POLICY-1459 PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image + - POLICY-1397 PDP-D: NOOP Endpoints Support to test Operational Policies. + - POLICY-1195 Separate model code from drools-applications into other repositories + - POLICY-1367 Spike - Experimentation for management of Drools templates and Operational Policies + + * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project. + - POLICY-1250 Fix issues reported by sonar in policy modules + - POLICY-1202 policy-engine & apex-pdp are using different version of eclipselink + - POLICY-1368 Remove hibernate from policy repos + - POLICY-1007 Remove Jackson from policy framework components + - POLICY-1457 Use Alpine in base docker images + + * [POLICY-1072] - This epic covers the work to support S3P Performance criteria. + + * [POLICY-1171] - Enhance CLC Facility + - POLICY-1173 High-level specification of coordination directives + + * [POLICY-1220] - This epic covers the work to support S3P Security criteria + - Task POLICY-1538 Upgrade Elasticsearch to 6.4.x to clear security issue + + * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure + - POLICY-1453 Apex PDP Dmaap Deploy/UnDeploy Functionality + - POLICY-1452 Apex PDP Dmaap Register/UnRegister Functionality + - POLICY-1460 Create S3P JMeter Tests for PAP + - POLICY-1458 Create S3P JMeter Tests for Policy API + - POLICY-1462 Create S3P JMeter Tests for Policy SDC Distribution + - POLICY-1461 Create S3P JMeter Tests for Policy XACML Engine (2nd Generation) + - POLICY-1272 Create the S3P JMeter tests for API, PAP, XACML (2nd Gen) + - POLICY-1455 Drools PDP Dmaap Deploy/UnDeploy Functionality + - POLICY-1454 Drools PDP Dmaap Register/UnRegister Functionality + - POLICY-1474 Modifications of Control Loop Operational Policy to support new Policy Lifecycle API + - POLICY-1443 PAP Dmaap PDP Register/UnRegister Main Entry Point + - POLICY-1444 PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point + - POLICY-1542 PAP REST API for PDPGroup Deployment, State Management & Health Check + - POLICY-1541 PAP REST API for PDPGroup Query, Statistics & Delete + - POLICY-1271 PAP RESTful HealthCheck/Statistics Main Entry Point + - POLICY-1471 Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application + - POLICY-1456 Policy Architecture and Roadmap Documentation + - POLICY-1442 Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies + - POLICY-1441 Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types + - POLICY-1447 Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies + - POLICY-1446 Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types + - POLICY-1270 Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point + - POLICY-1273 Policy Type Application Design Requirements + - POLICY-1515 Prototype Policy Lifecycle API Swagger Entry Points + - POLICY-1516 Prototype the Policy Decision API + - POLICY-1451 XACML PDP Dmaap Deploy/UnDeploy Functionality + - POLICY-1449 XACML PDP Dmaap Register/UnRegister Functionality + - POLICY-1440 XACML PDP RESTful Decision API Main Entry Point + - POLICY-1436 XACML PDP RESTful HealthCheck/Statistics Main Entry Point + - POLICY-1445 XACML PDP upgrade to xacml 2.0.0 + + * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee + + * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin + - POLICY-1405 Develop SDNC API for trigger bandwidth + + * [POLICY-1408] - This epic covers the work done with the Casablanca release + - POLICY-1419 Better multi-role support + - POLICY-1427 Controller Logging Feature + - POLICY-1413 Dashboard enhancements + - POLICY-1422 Enhanced encryption + - POLICY-1420 Model enhancement to support embedded JSON + - POLICY-1416 Model enhancements to support CLAMP + - POLICY-1421 New audit data for push/delete + - POLICY-1418 PDP APIs - make ClientAuth optional + - POLICY-1414 Push Policy and DeletePolicy API enhancement + - POLICY-1417 Resiliency improvements + - POLICY-1423 Save original model file + - POLICY-1410 List Policy API + - POLICY-1499 Mdc Filter Feature + - POLICY-1489 PDP-D: Nested JSON Event Filtering support with JsonPath + + * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case + - POLICY-1464 Config related aspects for OOF SON use case + - POLICY-1463 Functional code changes in Policy for OOF SON use case + + * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case. + - POLICY-1278 AAI named-queries are being deprecated and should be replaced with custom-queries + - POLICY-1545 E2E Automation - Parse the newly added model ids from operation policy + + * Additional items delivered with the release. + - POLICY-1266 A&AI Modularity + - POLICY-1274 further improvement in PSSD S3P test + - POLICY-1159 Move expectException to policy-common/utils-test + - POLICY-1465 Support configurable Heap Memory Settings for JVM processes + - POLICY-1176 Work on technical debt introduced by CLC POC + + +**Bug Fixes** + +The following bug fixes have been deployed with this release: + + * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka + * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes + * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component + * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent + * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set + +**Security Notes** + +*Fixed Security Issues* + + * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster. + * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster. + * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster. + * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster. + +*Known Security Issues* + +*Known Vulnerabilities in Used Modules* + +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>`_. + +Quick Links: + - `POLICY project page`_ + - `Passing Badge information for POLICY`_ + - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_ + + +**Known Issues** + +The following known issues will be addressed in a future release: + + * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows + * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content + * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON + * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs. + + + +.. ========================== .. * * * CASABLANCA * * * .. ========================== @@ -31,11 +176,19 @@ The following items were deployed with the Casablanca Maintenance Release: **Security Fixes** * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue - + **License Issues** * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR +**Known Issues** + +The following known issue will be addressed in a future release. + + * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content + +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. + Version: 3.0.1 -------------- @@ -49,7 +202,7 @@ The following items were deployed with the Casablanca Maintenance Release: * [POLICY-1221] - Policy distribution application to support HTTPS communication * [POLICY-1222] - Apex policy PDP to support HTTPS Communication -**Bug Fixes** +**Bug Fixes** * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade @@ -64,29 +217,29 @@ Version: 3.0.0 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). - * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution - + * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution + The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy. - + * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups. - + The policy team did some forward looking spike work towards re-building the Software Architecture. * [POLICY-809] - Maintain and implement performance * [POLICY-814] - 72 hour stability testing (component and platform) - + The policy team made enhancements to the Drools PDP to further support S3P Performance. For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P performance standard and performed 72 hour stability tests. - + * [POLICY-824] - maintain and implement security - + The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues. - - * [POLICY-840] - Flexible control loop coordination facility. + + * [POLICY-840] - Flexible control loop coordination facility. Work towards a POC for control loop coordination policies were implemented. @@ -95,14 +248,14 @@ The Casablanca release for POLICY delivered the following Epics. For a full list Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application. * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements - + Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs. * [POLICY-851] - This epic covers the work to bring in the Apex PDP code - + A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues, sonar issues, and checkstyle. - + * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case. Policy templates changes were submitted that supported the 5G OOF PCI optimization use case. @@ -130,14 +283,12 @@ The following bug fixes have been deployed with this release: 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>`_. Quick Links: - - `POLICY project page <https://wiki.onap.org/display/DW/Policy+Framework+Project>`_ - - - `Passing Badge information for POLICY <https://bestpractices.coreinfrastructure.org/en/projects/1614>`_ - + - `POLICY project page`_ + - `Passing Badge information for POLICY`_ - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_ **Known Issues** - + * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems @@ -227,7 +378,7 @@ The following bug fixes have been deployed with this release: * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling - * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout + * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side @@ -240,11 +391,9 @@ The following bug fixes have been deployed with this release: 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>`_. Quick Links: - - `POLICY project page <https://wiki.onap.org/display/DW/Policy+Framework+Project>`_ - - - `Passing Badge information for POLICY <https://bestpractices.coreinfrastructure.org/en/projects/1614>`_ - - - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_ + - `POLICY project page`_ + - `Passing Badge information for POLICY`_ + - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_ **Known Issues** @@ -290,46 +439,46 @@ The Amsterdam release continued evolving the design driven architecture of and f - POLICY-67 Rainy Day Decision Policy - POLICY-93 Notification API - POLICY-158 policy/engine: SQL injection Mitigation - - POLICY-269 Policy API Support for Rainy Day Decision Policy and Dictionaries + - POLICY-269 Policy API Support for Rainy Day Decision Policy and Dictionaries * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components - - POLICY-40 MSB Integration - - POLICY-124 Integration with oparent - - POLICY-41 OOM Integration - - POLICY-119 PDP-D: noop sinks + - POLICY-40 MSB Integration + - POLICY-124 Integration with oparent + - POLICY-41 OOM Integration + - POLICY-119 PDP-D: noop sinks * [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. - - POLICY-57 VF-C Actor code development - - POLICY-43 Amsterdam Use Case Template - - POLICY-173 Deployment of Operational Policies Documentation + - POLICY-57 VF-C Actor code development + - POLICY-43 Amsterdam Use Case Template + - POLICY-173 Deployment of Operational Policies Documentation * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific. - - POLICY-68 TOSCA Parsing for nested objects for Microservice Policies + - POLICY-68 TOSCA Parsing for nested objects for Microservice Policies * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding. * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design. - - POLICY-64 CLAMP Configuration and Operation Policies for vFW Use Case - - POLICY-65 CLAMP Configuration and Operation Policies for vDNS Use Case - - POLICY-48 CLAMP Configuration and Operation Policies for vCPE Use Case - - POLICY-63 CLAMP Configuration and Operation Policies for VOLTE Use Case + - POLICY-64 CLAMP Configuration and Operation Policies for vFW Use Case + - POLICY-65 CLAMP Configuration and Operation Policies for vDNS Use Case + - POLICY-48 CLAMP Configuration and Operation Policies for vCPE Use Case + - POLICY-63 CLAMP Configuration and Operation Policies for VOLTE Use Case * [POLICY-38] - This epic covers the work required to support service distribution by SDC. * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime. - - POLICY-61 vFW Use Case - Runtime - - POLICY-62 vDNS Use Case - Runtime - - POLICY-59 vCPE Use Case - Runtime - - POLICY-60 VOLTE Use Case - Runtime - - POLICY-51 Runtime Policy Update Support - - POLICY-328 vDNS Use Case - Runtime Testing - - POLICY-324 vFW Use Case - Runtime Testing - - POLICY-320 VOLTE Use Case - Runtime Testing - - POLICY-316 vCPE Use Case - Runtime Testing + - POLICY-61 vFW Use Case - Runtime + - POLICY-62 vDNS Use Case - Runtime + - POLICY-59 vCPE Use Case - Runtime + - POLICY-60 VOLTE Use Case - Runtime + - POLICY-51 Runtime Policy Update Support + - POLICY-328 vDNS Use Case - Runtime Testing + - POLICY-324 vFW Use Case - Runtime Testing + - POLICY-320 VOLTE Use Case - Runtime Testing + - POLICY-316 vCPE Use Case - Runtime Testing * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks. - - POLICY-77 Functional Test case definition for Control Loops - - POLICY-387 Deliver the released policy artifacts + - POLICY-77 Functional Test case definition for Control Loops + - POLICY-387 Deliver the released policy artifacts **Bug Fixes** @@ -356,30 +505,35 @@ The Amsterdam release continued evolving the design driven architecture of and f .. Links to jira release notes +.. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300 +.. Links to Project related pages + +.. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project +.. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614 + .. note .. CHANGE HISTORY +.. 05/16/2019 - Updated for Dublin Release. .. 01/17/2019 - Updated for Casablanca Maintenance Release. .. 11/19/2018 - Updated for Casablanca. Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing. .. Changed version number to use ONAP versions. .. 10/08/2018 - Initial document for Casablanca release. -.. Per Jorge, POLICY-785 did not get done in Casablanca (removed). +.. Per Jorge, POLICY-785 did not get done in Casablanca (removed). .. 05/29/2018 - Information for Beijing release. .. 03/22/2018 - Initial document for Beijing release. .. 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) .. Also, Set up initial information for Beijing. .. Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge. - + End of Release Notes -.. How to notes for SS -.. For initial document: list epic and user stories for each, list user stories with no epics. -.. For Bugs section, list bugs that are not tied to an epic. Remove all items with "Won't Do" resolution. +.. How to notes for SS +.. For initial document: list epic and user stories for each, list user stories with no epics. +.. 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. .. For Known issues, list bugs that are slotted for a future release. - - |