docs/platform/deployPDPPAP.rst

   1
   2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4
   5 ********************************************
   6 Testing, Deploying and Debugging the PDP/PAP
   7 ********************************************
   8
   9 .. contents::
  10     :depth: 3
  11
  12 PAP (Policy Administration Point)
  13 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  14
  15 Accessing and Starting PAP
  16 --------------------------
  17
  18 - To access the PAP docker use
  19
  20 .. code-block:: bash
  21
  22     docker exec -it -u 0 pap su - policy
  23
  24 - 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.
  25
  26 - Once within the PAP Container the running status can be checked using the following policy status command.
  27
  28 .. code-block:: bash
  29
  30     policy [--debug] status|start|stop
  31
  32 - To get the current status of Policy use *policy.sh status*
  33
  34 .. code-block:: bash
  35
  36     policy@pap:~$ policy.sh status
  37         pap: UP: running with pid 2114
  38         console: UP: running with pid 2135
  39         paplp: UP: running with pid 2155
  40         3 cron jobs installed.
  41
  42 - To Stop the components use *policy.sh stop*
  43
  44 .. code-block:: bash
  45
  46     policy@pap:~$ policy.sh stop
  47         paplp: STOPPING ..
  48         console: STOPPING ..
  49         pap: STOPPING ..
  50
  51 - To Start use *policy.sh start*
  52
  53 .. code-block:: bash
  54
  55     policy@pap:~$ policy.sh start
  56         pap: STARTING ..
  57         console: STARTING ..
  58         paplp: STARTING ..
  59
  60 Healthcheck
  61 -----------
  62
  63 - To perform Health check on policy components you can follow the generic procedure documented as below.
  64
  65 .. code-block:: bash
  66
  67     # Assuming the healthcheck service credentials have not been changed
  68     # post-installation within the drools container
  69
  70     source /opt/policy/config/drools/feature-healthcheck.conf
  71
  72     curl --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}"
  73                    -X GET http://localhost:6969/healthcheck | python -m json.tool
  74
  75 - Additional information can be found in the documentation for Testing, Deploying, and debugging on a PDP-D Healthcheck.
  76
  77 Logs
  78 ----
  79
  80 - 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.
  81 - 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.
  82 - 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.
  83
  84 PDP (Policy Decision Point)
  85 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  86
  87 Accessing and Starting PDP
  88 --------------------------
  89
  90 - To access the PDP docker :
  91
  92 .. code-block:: bash
  93
  94     docker exec -it -u 0 pdp su - policy
  95
  96 - To start and stop the PDP components the same procedure can be followed as documented for PAP.
  97
  98 .. code-block:: bash
  99
 100     policy [--debug] status|start|stop
 101
 102 Healthcheck / Testing
 103 ---------------------
 104
 105 - The Policy PDP health check can be checked using the generic procedure documented above for PAP which applies to all policy components.
 106 - 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
 107 - In order to test the Policy components, the swagger UI provided by PDP can be used to test PDP and PAP.
 108
 109
 110 End of Document
 111
 112 .. SSNote: Wiki page ref.  https://wiki.onap.org/pages/viewpage.action?pageId=16003633
 113