summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSaryu Shah <ss3917@att.com>2018-04-27 20:45:25 +0000
committerSaryu Shah <ss3917@att.com>2018-04-27 20:45:25 +0000
commit1c022346cd42f3458816ac1e40d49efac9ae5c6b (patch)
tree870e586b50911560a62d9d7b5efcc82fa0517790
parent3eab022023bd68eee6743e30dd7db21c256bf00b (diff)
Updated policy documentation
Fixed typos, Updated release notes, Deleted old release files ------------------------------------------------------------- Change-Id: I43bb64b7d1829e92b30bfd45ec3f3608a59672cf Issue-ID: POLICY-536 Signed-off-by: Saryu Shah <ss3917@att.com>
-rw-r--r--docs/platform/deployPDPPAP.rst2
-rw-r--r--docs/release-notes.rst6
-rw-r--r--docs/release-notes/bug-fixes.rst102
-rw-r--r--docs/release-notes/deprecation-notes.rst5
-rw-r--r--docs/release-notes/index.rst11
-rw-r--r--docs/release-notes/known-issues.rst17
-rw-r--r--docs/release-notes/new-features.rst144
-rw-r--r--docs/release-notes/other.rst5
-rw-r--r--docs/release-notes/security-issues.rst5
-rw-r--r--docs/release-notes/upgrade-notes.rst5
10 files changed, 6 insertions, 296 deletions
diff --git a/docs/platform/deployPDPPAP.rst b/docs/platform/deployPDPPAP.rst
index a04515899..2ca7b4989 100644
--- a/docs/platform/deployPDPPAP.rst
+++ b/docs/platform/deployPDPPAP.rst
@@ -108,8 +108,6 @@ Healthcheck / Testing
- Apart from the above check PDP also provides the swagger UI from which PDP REST APIs which can be tested and used, this also lets us know the PDP Status. In order to access PDP's swagger UI visit ``http://{PDP_URL}:8081/pdp/swagger-ui.html.``
-- Apart from the above check PDP also provides the swagger UI from which PDP REST APIs which can be tested and used, this also lets us know the PDP Status. ``In order to access PDP's swagger UI visit http://{PDP_URL}:8081/pdp/swagger-ui.html.``
-
- In order to test the Policy components, the swagger UI provided by PDP can be used to test PDP and PAP.
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 1f6943bab..91ec7697f 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -96,6 +96,12 @@ The Beijing release for POLICY delivered the following Epics. For a full list of
* POLICY-684 Fix regex for brmsgw dependency handling
* POLICY-707 ONAO-PAP-REST unit tests fail on first build on clean checkout
* POLICY-717 Fix a bug in checking required fields if the object has include function
+ * POLICY-734 Fix Fortify Header Manipulation Issue
+ * POLICY-743 Fixed data name since its name was changed on server side
+ * POLICY-753 Policy Health Check failed with multi-node cluster
+ * POLICY-763 PDP-D throwing NullPointerException for multiple vDNS and VOLTE messages injected in parallel
+ * POLICY-765 junit test for guard fails intermittently
+
**Security Issues**
diff --git a/docs/release-notes/bug-fixes.rst b/docs/release-notes/bug-fixes.rst
deleted file mode 100644
index 600ad4d05..000000000
--- a/docs/release-notes/bug-fixes.rst
+++ /dev/null
@@ -1,102 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Bug Fixes
----------
-
-ONAP POLICY Framework items for: (Last Updated: 11/06/2017)
-
-* **Version**: Amsterdam Release
-* **Release Date**: 17 November, 2017
-* **Description**: R1
-
-Bug
-^^^
-
- * [POLICY-12] - Clean up warnings in drools-pdp project
- * [POLICY-14] - Fix docker-compose to use onap/* instead of openecomp/*
- * [POLICY-15] - 1.1.0-SNAPSHOT bring up issues
- * [POLICY-16] - correct problems introduced by swagger addition to pdp-d
- * [POLICY-19] - PDP-X getConfig API Authentication error
- * [POLICY-20] - PDP-X getConfig - Configuration Policy not found
- * [POLICY-21] - PDP-D occasionally stuck during shutdown
- * [POLICY-23] - PDP-X getConfig issues
- * [POLICY-24] - PDP-X pushPolicy problems
- * [POLICY-27] - excessive long idle timeouts in DB introduced unnecessarily
- * [POLICY-29] - BRMS GW - client configuration
- * [POLICY-74] - policy-engine build failure
- * [POLICY-75] - KieScanner repeatedly updating Drools container
- * [POLICY-84] - Query Name validation before execution
- * [POLICY-91] - drools-applications - vFW/vDNS dependencies issues
- * [POLICY-92] - brmsgw - vFW/vDNS dependency rename issue
- * [POLICY-94] - Health check failure in R1.1.0 in DFW on Rackspace
- * [POLICY-134] - PolicyLogger.info(Object arg0) executes recursively causing stack overflow error.
- * [POLICY-144] - PAP: console: browser access: 500 code
- * [POLICY-145] - Healthcheck functionality not working
- * [POLICY-146] - brmsgw: vFW/vDNS rules jars not generated
- * [POLICY-165] - Support Backward compatibility for the Policy Interface
- * [POLICY-170] - policy build by vagrant fails
- * [POLICY-175] - 0% Code Coverage in some projects
- * [POLICY-191] - PDP-D: Enhancement: feature session-persistence
- * [POLICY-192] - verify and/or merge job hang running JUnit test
- * [POLICY-194] - policy/drools-applications: fix template to enable JUnits
- * [POLICY-195] - policy/drools-pdp/session-persistence: remove new sonar blocker and criticals
- * [POLICY-197] - drools-applications: logger change breaks junit on drl template
- * [POLICY-199] - Policy UI page displays blank in ONAP
- * [POLICY-203] - Test case testGetPropertiesValue fails if we run test case or build code other than C:
- * [POLICY-205] - policy/engine: missing license files
- * [POLICY-206] - Missing license for drools-applications
- * [POLICY-211] - Policy Fails Robot Health Check
- * [POLICY-213] - remove sonar blocker/criticals introduced by feature-test-transaction
- * [POLICY-221] - Policy GUI Cosmetic Issues
- * [POLICY-223] - PDP Health Check Fail
- * [POLICY-229] - Policy healthcheck failure in RS ORD ONAP 1.1.0
- * [POLICY-234] - PDP-D: drools session remains hung on an update
- * [POLICY-275] - pdp-x: automated pushing of policies shows that some operations failed
- * [POLICY-276] - brmsgw: not generating amsterdam rules jar
- * [POLICY-278] - console: sql injection protection not working properly
- * [POLICY-295] - brmsgw: amsterdam controller rules generation cannot be built
- * [POLICY-296] - pdp-d guard db access causes control loop failures
- * [POLICY-298] - pdp-d: drl template drops messages in clean up rules
- * [POLICY-299] - Policy CSIT tests are running over 15 hours long
- * [POLICY-300] - Use correct format for messages from Policy to APPC_LCM_READ
- * [POLICY-301] - DB sessionpersistence.sessioninfo to mediumblob
- * [POLICY-302] - brmsgw: set up rules should not be generated
- * [POLICY-305] - Policy Guard Deny response
- * [POLICY-306] - vDNS yaml that is pushed should contain "SO" as actor not "MSO"
- * [POLICY-310] - Policy GUI Fixes
- * [POLICY-313] - Update MicroService vCPE Config Policy with new values
- * [POLICY-314] - pdp-d: better handling of unsuccessful AAI responses
- * [POLICY-315] - Change back docker compose version to 2 from 3
- * [POLICY-339] - pdp-d apps aai vdns : update aai interface from v8 to v11
- * [POLICY-340] - console: upgrade to latest portal sdk
- * [POLICY-341] - pdp-d apps vfw: subsequent onsets on same resource not discarded
- * [POLICY-342] - docker push-policies : config and operational policies must use the same control loop name
- * [POLICY-343] - console: displaying corporate logo
- * [POLICY-344] - Operations History Persistence Unit Not Found
- * [POLICY-345] - Operations History Table is not written to
- * [POLICY-350] - pdp-d apps drl: resiliency to exceptions and null values returned/thrown from java models
- * [POLICY-353] - Bug in UebTopicSinkFactory
- * [POLICY-354] - Update the latest Portal Properties
- * [POLICY-356] - pdp-d apps: print networked messages over http interface
- * [POLICY-357] - pdp-d db-migrator when ALL dbs flag is used upgrade not working properly
- * [POLICY-363] - docker pdp-d: set DCAE DMaaP Server default to vm1.mr.simpledemo.openecomp.org
- * [POLICY-364] - Policy template should not reject Event if A&AI lookup fails.
- * [POLICY-365] - MariaDB doesn't come up when an old volume is present
- * [POLICY-369] - Clean up of feature-state-management issues from testing
- * [POLICY-376] - pdp-d apps : control loop generation from archetype fails
- * [POLICY-385] - pdp-d apps : potential null pointer exceptions when logging http response to network log
- * [POLICY-386] - pdp-d: ensure pdp-d shuts down when underlying component is stuck in shutdown sequence
- * [POLICY-401] - Update SO url from v2 to v5
- * [POLICY-402] - pdp-d apps msb build issue when releasing
- * [POLICY-403] - Fixed a bug on view and editor screens
- * [POLICY-404] - pdp-d : clean up parent pom pre-release
- * [POLICY-405] - TOSCA model parser issue in Policy GUI
- * [POLICY-406] - policy/engine: snapshot external dependencies should be removed
- * [POLICY-407] - Rogue Abatement Processing
- * [POLICY-408] - VFC Manager not catching exception generated by NULL VFC URL
- * [POLICY-409] - Closed loop between DCAE and Policy still not working: vnf-name vs vnf-id
- * [POLICY-410] - pdp-d apps : aai rest response not expanded in network.log
- * [POLICY-411] - Resolve Policy Blocker Issues
- * [POLICY-412] - Remove the id value from MicroService Model in db script
-
-
diff --git a/docs/release-notes/deprecation-notes.rst b/docs/release-notes/deprecation-notes.rst
deleted file mode 100644
index e954e8764..000000000
--- a/docs/release-notes/deprecation-notes.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Deprecation Notes
------------------
-
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
deleted file mode 100644
index 0ac56af2f..000000000
--- a/docs/release-notes/index.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Release Notes
-=============
-
-.. toctree::
- :maxdepth: 1
-
- new-features.rst
- bug-fixes.rst
- known-issues.rst
diff --git a/docs/release-notes/known-issues.rst b/docs/release-notes/known-issues.rst
deleted file mode 100644
index e765e1be0..000000000
--- a/docs/release-notes/known-issues.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Known Issues
-------------
-
-ONAP POLICY Framework items for: (Last Updated: 11/06/2017)
-
-* **Version**: Amsterdam Release
-* **Release Date**: 17 November, 2017
-* **Description**: R1
-
-Issues
-^^^^^^
-
-* No known issues at this time
-
-
diff --git a/docs/release-notes/new-features.rst b/docs/release-notes/new-features.rst
deleted file mode 100644
index d400f2dc3..000000000
--- a/docs/release-notes/new-features.rst
+++ /dev/null
@@ -1,144 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-New Features
-------------
-
-ONAP POLICY Framework items for: (Last Updated: 11/06/2017)
-
-* **Version**: Amsterdam Release
-* **Release Date**: 17 November, 2017
-* **Description**: R1
-
-.. contents::
- :depth: 2
-
-Epic
-^^^^
-
- * [POLICY-31] - Stabilization of Seed Code
- * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
- * [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-35] - This epic covers the body of work involved in supporting policy that is platform specific.
- * [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-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-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
-
-
-Story
-^^^^^
-
- * [POLICY-25] - Replace any remaining openecomp reference by onap
- * [POLICY-32] - JUnit test code coverage
- * [POLICY-40] - MSB Integration
- * [POLICY-41] - OOM Integration
- * [POLICY-43] - Amsterdam Use Case Template
- * [POLICY-48] - CLAMP Configuration and Operation Policies for vCPE Use Case
- * [POLICY-51] - Runtime Policy Update Support
- * [POLICY-57] - VF-C Actor code development
- * [POLICY-59] - vCPE Use Case - Runtime
- * [POLICY-60] - VOLTE Use Case - Runtime
- * [POLICY-61] - vFW Use Case - Runtime
- * [POLICY-62] - vDNS Use Case - Runtime
- * [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-66] - PDP-D Feature mechanism enhancements
- * [POLICY-67] - Rainy Day Decision Policy
- * [POLICY-68] - TOSCA Parsing for nested objects for Microservice Policies
- * [POLICY-77] - Functional Test case definition for Control Loops
- * [POLICY-93] - Notification API
- * [POLICY-119] - PDP-D: noop sinks
- * [POLICY-121] - Update POM to inherit from oparent
- * [POLICY-124] - Integration with oparent
- * [POLICY-158] - policy/engine: SQL injection Mitigation
- * [POLICY-161] - Security Event Logging
- * [POLICY-173] - Deployment of Operational Policies Documentation
- * [POLICY-210] - Independent Versioning and Release Process
- * [POLICY-316] - vCPE Use Case - Runtime Testing
- * [POLICY-320] - VOLTE Use Case - Runtime Testing
- * [POLICY-324] - vFW Use Case - Runtime Testing
- * [POLICY-328] - vDNS Use Case - Runtime Testing
- * [POLICY-387] - Deliver the released policy artifacts
-
-Task
-^^^^
-
- * [POLICY-3] - Add appropriate unit tests back into the distribution
- * [POLICY-6] - Updates to License and Trademark in the Policy Source Code
- * [POLICY-8] - Fix PDP-D Sonar Blocker Issues
- * [POLICY-11] - Enhancements to extract fact information for a given Drools Application
- * [POLICY-17] - Removal of ECOMP-SDK-APP dbscripts
- * [POLICY-18] - Enhancement: Add additional feature hooks in Drools PDP
- * [POLICY-22] - drools-applications reorganization and template upgrade
- * [POLICY-26] - PDP-D Telemetry REST CLI
- * [POLICY-30] - PDP-D Logging Enhancements
- * [POLICY-53] - Update drools-application docker scripts to find reorganized pom changes
- * [POLICY-54] - POLICY-54 Add HTTP Proxy Support to docker image builds
- * [POLICY-55] - Ensure drools-application JUnit test works on ONAP JJB using in memory database
- * [POLICY-58] - Update Policy Engine dependencies and use case policies to support the latest drools-application code
- * [POLICY-70] - Add vagrant functionality to build/setup policy
- * [POLICY-78] - Update Drools version to 6.5.0.Final
- * [POLICY-80] - Policy Guard
- * [POLICY-87] - Implement Recommended Fix for Portal
- * [POLICY-88] - Delete the yaml sdk and sdc projects located in policy/engine
- * [POLICY-95] - Fix policy/commons sonar blocker issues with exception of integrity-monitor/audit
- * [POLICY-96] - Fix policy/common integrity-[monitor/audit] sonar blockers
- * [POLICY-97] - Fix policy/engine sonar blockers
- * [POLICY-98] - policy/commons critical sonar issues - NON integrity/monitor related
- * [POLICY-100] - fix policy/common critical sonar items - integrity monitor/audit related
- * [POLICY-105] - Common-Modules changes to RefreshStateAudit
- * [POLICY-111] - policy/drools-applications: sonar blockers
- * [POLICY-113] - policy/engine: sonar critical
- * [POLICY-114] - policy/drools-pdp: sonar critical
- * [POLICY-115] - policy/drools-application: sonar critical
- * [POLICY-116] - Remove MojoHaus Maven plug-in from pom file
- * [POLICY-117] - Resolve Policy Sonar Critical issues
- * [POLICY-122] - Policy GUI Fixes for Dictionary and Dashboard tabs
- * [POLICY-125] - Update Project FOSS Table
- * [POLICY-126] - Identify and outline the set of documentations to be delivered in this Release
- * [POLICY-133] - Addition of policy-persistence feature
- * [POLICY-154] - policy/engine finish eclipse warnings for unused imports/variables
- * [POLICY-155] - Addition of state-management feature
- * [POLICY-156] - Addition of active-standby-management feature
- * [POLICY-163] - Add 'install' and 'uninstall' option to DroolsPDP 'features' script
- * [POLICY-167] - Clean additional pom warnings policy/engine
- * [POLICY-168] - Clean pom warnings policy/drools-applications
- * [POLICY-171] - Update policy/docker README to reflect current project paths
- * [POLICY-176] - policy/drools-applications: convert System.out, System.err to use slf4j/logback
- * [POLICY-177] - test-transaction feature to check on the healthiness of policy controllers
- * [POLICY-178] - policy/common: convert integrity monitor to use slf4j/logback as in drools-pdp
- * [POLICY-180] - Upgrade policy/engine release build to use more memory
- * [POLICY-181] - Policy/common change jenkins job to not ignore JUnit tests for verify job.
- * [POLICY-193] - Created a new cleanup process
- * [POLICY-196] - Enhancement on MS JSON File
- * [POLICY-218] - LF Open Source License Issues
- * [POLICY-228] - Create common object to consolidate AAI response
- * [POLICY-231] - Remove Binary files from Policy Repo
- * [POLICY-237] - Address remaining sonar/critical for policy/common
- * [POLICY-239] - Address sonar major issues
- * [POLICY-247] - Modify docker push-policies to push the Amsterdam Template and latest policies
- * [POLICY-253] - Modify policy/engine pom.xml to remove sonar scan on 3rd party code.
- * [POLICY-261] - policy/drools-pdp last remaining sonar critical
- * [POLICY-266] - feature-state-management JUnit coverage
- * [POLICY-273] - Revert the SDK properties from onap to ecomp
- * [POLICY-274] - .gitignore policy/engine directories/files created after running mvn clean install or mvn test
- * [POLICY-297] - policy/drools-applications stage-site build is failing due to heap space
- * [POLICY-304] - Add ability for Docker scripts to NOT pre-load policies for testing
- * [POLICY-307] - Delete the pre-Amsterdam policy template etc.
- * [POLICY-312] - Change Policy CSIT Integration Tests to utilize the PRELOAD_POLICIES=false
- * [POLICY-335] - Add more documentation details
- * [POLICY-337] - Update CSIT Integration Tests with latest Config/Operational Policies
- * [POLICY-355] - Exclude dependencies for mysql and iText
- * [POLICY-372] - Update the DCAE TCA Model
-
-
-Additional Information
-^^^^^^^^^^^^^^^^^^^^^^
-
-Latest details for Policy Framework Amsterdam Release can be found at `PolicyReleaseNotes`_.
-
-.. _PolicyReleaseNotes: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
-
-
diff --git a/docs/release-notes/other.rst b/docs/release-notes/other.rst
deleted file mode 100644
index 2ce683b5b..000000000
--- a/docs/release-notes/other.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Other
------
-
diff --git a/docs/release-notes/security-issues.rst b/docs/release-notes/security-issues.rst
deleted file mode 100644
index 96e1fe95e..000000000
--- a/docs/release-notes/security-issues.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Security Issues
----------------
-
diff --git a/docs/release-notes/upgrade-notes.rst b/docs/release-notes/upgrade-notes.rst
deleted file mode 100644
index f31c74a69..000000000
--- a/docs/release-notes/upgrade-notes.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Upgrade Notes
--------------
-