Merge "Updated policy documentation"

7 files changed, 147 insertions, 11 deletions

diff --git a/docs/platform/PolicyGUI_GuardPolicy.png b/docs/platform/PolicyGUI_GuardPolicy.png
index 13b3e0fe9..f2065e406 100755
--- a/docs/platform/PolicyGUI_GuardPolicy.png
+++ b/docs/platform/PolicyGUI_GuardPolicy.png
diff --git a/docs/platform/deployPDPPAP.rst b/docs/platform/deployPDPPAP.rst
new file mode 100644
index 000000000..2c9b77575
--- /dev/null
+++ b/docs/platform/deployPDPPAP.rst
@@ -0,0 +1,113 @@
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+********************************************
+Testing, Deploying and Debugging the PDP/PAP
+********************************************
+
+.. contents::
+    :depth: 3
+
+PAP (Policy Administration Point)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
+
+Accessing and Starting PAP
+--------------------------
+
+- To access the PAP docker use 
+
+.. code-block:: bash
+
+    docker exec -it -u 0 pap su - policy
+
+- All Policy related software are installed under the policy account, the policy root directory is under *${POLICY_HOME}* environment variable and it may be changed on a per installation basis. It is typically set up under the */opt/app/policy* directory but can be changed during installation. All Policy software runs with non-root privileges as *policy* is a regular user account. 
+
+- Once within the PAP Container the running status can be checked using the following policy status command.
+
+.. code-block:: bash
+
+    policy [--debug] status|start|stop
+
+- To get the current status of Policy use *policy.sh status*
+
+.. code-block:: bash
+
+    policy@pap:~$ policy.sh status
+        pap: UP: running with pid 2114
+        console: UP: running with pid 2135
+        paplp: UP: running with pid 2155
+        3 cron jobs installed.
+
+- To Stop the components use *policy.sh stop*
+
+.. code-block:: bash
+
+    policy@pap:~$ policy.sh stop
+        paplp: STOPPING ..
+        console: STOPPING ..
+        pap: STOPPING ..
+
+- To Start use *policy.sh start* 
+
+.. code-block:: bash
+
+    policy@pap:~$ policy.sh start
+        pap: STARTING ..
+        console: STARTING ..
+        paplp: STARTING ..
+
+Healthcheck
+-----------
+
+- To perform Health check on policy components you can follow the generic procedure documented as below. 
+
+.. code-block:: bash
+
+    # Assuming the healthcheck service credentials have not been changed
+    # post-installation within the drools container
+
+    source /opt/policy/config/drools/feature-healthcheck.conf
+
+    curl --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}" 
+                   -X GET http://localhost:6969/healthcheck | python -m json.tool
+
+- Additional information can be found in the documentation for Testing, Deploying, and debugging on a PDP-D Healthcheck. 
+
+Logs
+----
+
+- Logs for PAP are located at *$POLICY_HOME/servers/pap/logs/* location. The main application logs can be found at *$POLICY_HOME/servers/pap/logs/Policy/ONAP-PAP-REST* location. 
+- Policy PAP uses EELF logging framework for logging and if needed to be modified can be modified at *$POLICY_HOME/servers/pap/webapps/pap/WEB-INF/classes/logback.xml*. This change needs a restart of the PAP component in order to be in effect. 
+- The Logs are divided into separate files and debug logs can be found in *debug.log* and error logs in *error.log* file which are two different files under application logs directory. 
+
+PDP (Policy Decision Point)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
+
+Accessing and Starting PDP
+--------------------------
+
+- To access the PDP docker : 
+
+.. code-block:: bash
+
+    docker exec -it -u 0 pdp su - policy
+
+- To start and stop the PDP components the same procedure can be followed as documented for PAP. 
+
+.. code-block:: bash
+
+    policy [--debug] status|start|stop
+
+Healthcheck / Testing
+---------------------
+
+- The Policy PDP health check can be checked using the generic procedure documented above for PAP which applies to all policy components. 
+- 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. 
+
+
+End of Document
+
+.. SSNote: Wiki page ref.  https://wiki.onap.org/pages/viewpage.action?pageId=16003633
+
diff --git a/docs/platform/guardpolicy.rst b/docs/platform/guardpolicy.rst
index 679723cbc..9dabb3040 100644
--- a/docs/platform/guardpolicy.rst
+++ b/docs/platform/guardpolicy.rst
@@ -129,6 +129,8 @@ A response containing a “PERMIT” or “DENY” in uppercase is returned as f
     }
 
 
-
 End of Document
 
+.. SSNote: Wiki page ref.  https://wiki.onap.org/display/DW/Creating+and+Using+Guard+Policies
+
+
diff --git a/docs/platform/index.rst b/docs/platform/index.rst
index 61725c6fd..19866e24d 100644
--- a/docs/platform/index.rst
+++ b/docs/platform/index.rst
@@ -11,3 +11,4 @@ Policy Engine
    installation.rst
    policygui.rst
    guardpolicy.rst
+   deployPDPPAP.rst
diff --git a/docs/release-notes/bug-fixes.rst b/docs/release-notes/bug-fixes.rst
index 24ec32c42..600ad4d05 100644
--- a/docs/release-notes/bug-fixes.rst
+++ b/docs/release-notes/bug-fixes.rst
@@ -3,10 +3,10 @@
 Bug Fixes
 ---------
 
-ONAP POLICY Framework items for: (Last Updated: 10/23/2017)
+ONAP POLICY Framework items for: (Last Updated: 11/06/2017)
 
 *    **Version**: Amsterdam Release
-*    **Release Date**: 02 November, 2017
+*    **Release Date**: 17 November, 2017
 *    **Description**: R1
 
 Bug
@@ -42,7 +42,7 @@ Bug
     * [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-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
@@ -81,6 +81,22 @@ Bug
     * [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/known-issues.rst b/docs/release-notes/known-issues.rst
index b4ee9540c..e765e1be0 100644
--- a/docs/release-notes/known-issues.rst
+++ b/docs/release-notes/known-issues.rst
@@ -3,10 +3,10 @@
 Known Issues
 ------------
 
-ONAP POLICY Framework items for: (Last Updated: 10/10/2017)
+ONAP POLICY Framework items for: (Last Updated: 11/06/2017)
 
 *    **Version**: Amsterdam Release
-*    **Release Date**: 02 November, 2017
+*    **Release Date**: 17 November, 2017
 *    **Description**: R1
 
 Issues
diff --git a/docs/release-notes/new-features.rst b/docs/release-notes/new-features.rst
index e72f9262c..d400f2dc3 100644
--- a/docs/release-notes/new-features.rst
+++ b/docs/release-notes/new-features.rst
@@ -3,10 +3,10 @@
 New Features
 ------------
 
-ONAP POLICY Framework items for: (Last Updated: 10/23/2017)
+ONAP POLICY Framework items for: (Last Updated: 11/06/2017)
 
 *    **Version**: Amsterdam Release
-*    **Release Date**: 02 November, 2017
+*    **Release Date**: 17 November, 2017
 *    **Description**: R1
 
 .. contents::
@@ -19,10 +19,13 @@ Epic
     * [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
 ^^^^^
 
@@ -49,7 +52,7 @@ Story
     * [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-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
@@ -57,7 +60,7 @@ Story
     * [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
 ^^^^
@@ -128,6 +131,7 @@ Task
     * [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