blob: e69c65889285fb929a28f131a7be5941dbb2a340 [file] [log] [blame]
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
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
.. * 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.
.. * This note must be removed after content has been added.
.. ==========================
.. * * * CASABLANCA * * *
.. ==========================
Version: 1.3.0
--------------
:Release Date: 2018-11-15 (Casablanca Release)
**New Features**
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-723 Analyze and design the Policy SDC Distribution Application
- POLICY-922 Create application framework for Policy Service SDC Distribution
- POLICY-923 Create code to generate docker images for Policy SDC Service Distribution application
- POLICY-924 Create CSIT test framework for Policy SDC Service Distribution application
- POLICY-925 Create K8S Helm Charts for deployment via OOM project
- POLICY-926 Create code infrastructure for automatic policy forwarding
- POLICY-956 Implement IConfiguration interface to initiate Distribution Client
- POLICY-974 Implement INotificationCallback interface
- POLICY-1094 Refactor reception handler configuration parameter handling
* [POLICY-715] - This epic covers work to harden the policy platform
- POLICY-955 Incorporate changes to amsterdam rules template into casablanca rules template
* [POLICY-718] - This epic covers the work to perform release planning activities.
- POLICY-875 Update Beijing Branch and master branch for Casablanca versions
- POLICY-1040 Copy and clean up Beijing wiki's for Casablanca
* [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
- POLICY-724 Gather requirements and design high-level software architecture
- POLICY-1056 Create Policy API Infrastructure
* [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
- POLICY-874 Spike: Interface Stubbing for Architectual Enhancements
* [POLICY-772] - Enhance casablanca testing abilities between various environments
* [POLICY-803] - All the new repositories must be initialized and setup to work under policy/parent.
- POLICY-804 Setup policy/parent
- POLICY-805 Setup policy/models
- POLICY-806 Setup policy/api
- POLICY-807 Setup policy/apex-pdp
- POLICY-808 Setup ci-management verify/merge jobs
- POLICY-845 Setup policy/core
- POLICY-846 Setup policy/xacml-pdp
- POLICY-847 Setup policy/gui
- POLICY-848 Setup policy/pap
- POLICY-849 Setup policy/pdp
- POLICY-871 Setup policy/distribution
* [POLICY-809] - Maintain and implement performance
- POLICY-888 Performance PDP-D - Policy Decision/Enforcement
* [POLICY-814] - 72 hour stability testing (component and platform)
- POLICY-815 Stability PDP-X
* [POLICY-819] - Maintain and implement resiliency
* [POLICY-824] - maintain and implement security
- POLICY-781 PE Support for AAF Root Certificate in HTTPS communication.
- POLICY-905 Fix apex-engine License and Security issues
- POLICY-913 policy/engine CADI (AAF) Integration
- POLICY-914 policy/drools-pdp CADI (AAF) Integration
- POLICY-918 Policy Portal GUI - upgrade to latest Portal SDK to resolve security issues
- POLICY-942 BRMSGW: HTTPS support for DMaaP/UEB interfaces
- POLICY-946 Investigate what integration of CADI (AAF) integration into the ONAP Policy Platform components really means
- POLICY-982 Update security issues since portal SDK was upgraded
- POLICY-1030 Revisit CLM reports due to new software upgrade
- POLICY-1059 Address the security issues with Severe (and above) Level 4-6
* [POLICY-825] - Maintain and implement scability
* [POLICY-829] - Maintain and implement manageability
* [POLICY-839] - Maintain and implement usability
* [POLICY-840] - Flexible control loop coordination facility.
- POLICY-951 Code placement and development procedures
- POLICY-952 Analyze and design the control loop coordination facility
- POLICY-953 Configure whether a given control loop will be regulated by flexible control loop coordination.
- POLICY-975 Storage of abatement (and other) events in historical database
- POLICY-1109 Add demo code to template.demo
* [POLICY-841] - Covers the work required to support HPA
- POLICY-927 Develop the code that translates HPA requirements into OOF policies
- POLICY-989 HPA Use Case Modeling work to support optimization policies
* [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
- POLICY-962 Change SO Scale Out REST API call to new REST API version that support config parameters
- POLICY-963 Understand and Scope the Guard Policies for Scale Out
- POLICY-964 Modify drools-applications template to check is PROV_STATUS=Active before performing a Scale Out
- POLICY-968 Enforce guard policy for min/max instances of a VNF
- POLICY-1010 Enforce guard policy for waiting a period of time between Scale Outs
- POLICY-1011 Modify drools-applications template to make A&AI query to count number of instances of a VNF
- POLICY-1037 Use A&AI query for getting number of module instances to construct new module instance name
- POLICY-1038 Create new min/max guard policy template in policy engine
- POLICY-1039 Ensure Policy Integration Test wiki is up-to-date for new Scale Out APIs
* [POLICY-851] - This epic covers the work to bring in the Apex PDP code
- POLICY-855 Verify APEX-PDP setup in ONAP
- POLICY-856 Bring in the model code for APEX-PDP into ONAP
- POLICY-857 Bring in the context code for APEX-PDP into ONAP
- POLICY-858 Bring in the core code for APEX-PDP into ONAP
- POLICY-859 Bring in the server service code for APEX-PDP into ONAP
- POLICY-860 Bring in the authoring code for APEX-PDP into ONAP
- POLICY-861 Bring in the domain example code for APEX-PDP into ONAP
- POLICY-862 Bring in the plugin code for APEX-PDP into ONAP
- POLICY-863 Bring in the application code for APEX-PDP into ONAP
- POLICY-864 Bring in the client code for APEX-PDP into ONAP
- POLICY-865 Set up Integration Tests for APEX in ONAP
- POLICY-866 Set up ONAP Policy Framework compliant Docker build for APEX-PDP
- POLICY-867 Bring in APEX-PDP documents
- POLICY-954 APEX: Missing items and configuration problems
- POLICY-1099 Create CSIT test for policy APEX PDP
* [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
* [POLICY-904] - This epic covers the features AT&T is submitting
- POLICY-900 TOSCA model enhancements
- POLICY-901 Guard policy UI enhancements
- POLICY-902 XACML platform enhancements
- POLICY-983 getConfig naming policy implementation
- POLICY-1042 Policy Dashboard Enhancment
* [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
- POLICY-1079 Add support for VF Module Delete recipe
- POLICY-1086 Configuration/policies for OOF PCI use case
- POLICY-1089 Handle recommendation for PCI updates received from PCI-Handler MS
* [POLICY-1182] - Covers the work to support CCVPN use case
**Bug Fixes**
The following bug fixes have been deployed with this release:
* `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
* `[POLICY-1085] <https://jira.onap.org/browse/POLICY-1085>`_ - Stand-alone install will not run
* `[POLICY-1106] <https://jira.onap.org/browse/POLICY-1106>`_ - Checkstyle fixes appear to have broken persistence
* `[POLICY-1117] <https://jira.onap.org/browse/POLICY-1117>`_ - Fixed a bug on import function
* `[POLICY-1118] <https://jira.onap.org/browse/POLICY-1118>`_ - Microservice policies failing to display dynamic fields when selecting any model from GUI
* `[POLICY-1154] <https://jira.onap.org/browse/POLICY-1154>`_ - PE: CONSOLE not working with latest code changes
* `[POLICY-1155] <https://jira.onap.org/browse/POLICY-1155>`_ - PDP-D [APPS] : DRL Templates Compilation Errors
* `[POLICY-1158] <https://jira.onap.org/browse/POLICY-1158>`_ - meet ASDC_AUTHORIZATION_FAILED for client setting
* `[POLICY-1160] <https://jira.onap.org/browse/POLICY-1160>`_ - meet nullPointer exception based on the new schema of HPA capability requirement
* `[POLICY-1192] <https://jira.onap.org/browse/POLICY-1192>`_ - Update portal.properties in PE for AAF integration
* `[POLICY-1193] <https://jira.onap.org/browse/POLICY-1193>`_ - Policy: Heat Installation: policy host in certificate was generated incorrectly
* `[POLICY-1194] <https://jira.onap.org/browse/POLICY-1194>`_ - Policy: Heat installation: reconfigure URLs to point to a DNS hostname that matches the DMaaP certificate
* `[POLICY-1198] <https://jira.onap.org/browse/POLICY-1198>`_ - POLICY: OOM: PAP: cannot talk https directly to PDP-X pod bypassing service
* `[POLICY-1200] <https://jira.onap.org/browse/POLICY-1200>`_ - meet NullPointerException error since the PolicyScope should be set a default value
* `[POLICY-1201] <https://jira.onap.org/browse/POLICY-1201>`_ - Error while forwarding policy from policy-distribution to apex-pdp
* `[POLICY-1204] <https://jira.onap.org/browse/POLICY-1204>`_ - PAPLP: invalid schema database errors
**Security Notes**
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=36964976>`_.
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 (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=36964976>`_
**Known Issues**
The following known issues will be addressed in a future release:
* to be determined ...
.. =======================
.. * * * BEIJING * * *
.. =======================
Version: 1.2.3
--------------
:Release Date: 2018-06-07 (Beijing Release)
**New Features**
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`_.
* [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
- POLICY-238 policy/drools-applications: clean up maven structure
- POLICY-336 Address Technical Debt
- POLICY-338 Address JUnit Code Coverage
- POLICY-377 Policy Create API should validate input matches DCAE microservice template
- POLICY-389 Cleanup Jenkin's CI/CD process's
- POLICY-449 Policy API + Console : Common Policy Validation
- POLICY-568 Integration with org.onap AAF project
- POLICY-610 Support vDNS scale out for multiple times in Beijing release
* [POLICY-391] - This epic covers the work to support Release Planning activities
- POLICY-552 ONAP Licensing Scan - Use Restrictions
* [POLICY-392] - Platform Maturity Requirements - Performance Level 1
- POLICY-529 Platform Maturity Performance - Drools PDP
- POLICY-567 Platform Maturity Performance - PDP-X
* [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.
- POLICY-488 pap should not add rules to official template provided in drools applications
* [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
- POLICY-434 need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
* [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
- POLICY-622 Integrate OOF Policy Model into Policy Platform
* [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
- POLICY-525 Platform Maturity Stability - Drools PDP
- POLICY-526 Platform Maturity Stability - XACML PDP
* [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
- POLICY-527 Platform Maturity Resiliency - Policy Engine GUI and PAP
- POLICY-528 Platform Maturity Resiliency - Drools PDP
- POLICY-569 Platform Maturity Resiliency - BRMS Gateway
- POLICY-585 Platform Maturity Resiliency - XACML PDP
- POLICY-586 Platform Maturity Resiliency - Planning
- POLICY-681 Regression Test Use Cases
* [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
- POLICY-523 Platform Maturity Security - CII Badging - Project Website
* [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
- POLICY-531 Platform Maturity Scalability - XACML PDP
- POLICY-532 Platform Maturity Scalability - Drools PDP
- POLICY-623 Docker image re-design
* [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
- POLICY-533 Platform Maturity Manageability L1 - Logging
- POLICY-534 Platform Maturity Manageability - Instantiation < 1 hour
* [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
- POLICY-535 Platform Maturity Usability - User Guide
- POLICY-536 Platform Maturity Usability - Deployment Documentation
- POLICY-537 Platform Maturity Usability - API Documentation
* [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
**Bug Fixes**
The following bug fixes have been deployed with this release:
* `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
* `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
* `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
* `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
* `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
* `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
* `[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-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
* `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
* `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
**Security Notes**
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>`_
**Known Issues**
The following known issues will be addressed in a future release:
* `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
* `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
* `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
* `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
* `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
* `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
* `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
* `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
Version: 1.1.3
--------------
:Release Date: 2018-01-18 (Amsterdam Maintenance Release)
**Bug Fixes**
The following fixes were deployed with the Amsterdam Maintenance Release:
* `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
Version: 1.1.1
--------------
:Release Date: 2017-11-16 (Amsterdam Release)
**New Features**
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`_.
* [POLICY-31] - Stabilization of Seed Code
- POLICY-25 Replace any remaining openecomp reference by onap
- POLICY-32 JUnit test code coverage
- POLICY-66 PDP-D Feature mechanism enhancements
- 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-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-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-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-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-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-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
**Bug Fixes**
- 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`_.
**Known Issues**
- 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.
- For vLBS Use Case, the following steps are required to setup the service instance:
- Create a Service Instance via VID.
- Create a VNF Instance via VID.
- 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.
- 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.
- Run heatbridge from the Robot VM using ``Vfmodule_`` … as stack name (it is the actual stack name in OpenStack)
- Populate AAI with a dummy VF module for vDNS scaling.
**Security Issues**
- None at this time
**Other**
- None at this time
.. Links to jira release notes
.. _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
.. note
.. CHANGE HISTORY
.. 10/08/2018 - Initial document for Casablanca release.
.. Per Jorge, POLICY-785 did not get done in Casablanca (removed).
.. 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.
.. 05/29/2018 - Information for Beijing release.
.. 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.
.. For Known issues, list bugs that are slotted for a future release.