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-X/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.sh [--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 - The Healthcheck feature resides in the PDP-D that proxies for PAP, PDP-X, etc. To perform the Healthcheck on policy components you can follow the generic procedure documented as below, these commands must be executed within the PDP-D container.
  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/app/policy/config/feature-healthcheck.conf.environment
  71
  72         curl -k --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}"
  73                        -X GET https://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 - The main application logs for PAP are located at */var/log/onap/policy/pap/* location. The catalina.out can be found at *$POLICY_HOME/servers/pap/logs/* location.
  81
  82 * 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.
  83
  84 - 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.
  85
  86 PDP-X (XACML Policy Decision Point)
  87 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  88
  89 Accessing and Starting PDP
  90 --------------------------
  91
  92 - To access the PDP-X docker :
  93
  94     .. code-block:: bash
  95
  96         docker exec -it -u 0 pdp su - policy
  97
  98 - To start and stop the PDP-X components the same procedure can be followed as documented for PAP.
  99
 100     .. code-block:: bash
 101
 102         policy.sh [--debug] status|start|stop
 103
 104
 105 Swagger UI Testing (Only for HEAT installations)
 106 ------------------------------------------------
 107
 108 - The PDP-X provides the swagger UI from which PDP-X REST APIs can be tested and used, this also lets us know the PDP Status.
 109 - In order to access PDP's swagger UI visit ``https://{PDP_URL}:8081/pdp/swagger-ui.html.``
 110 - NOTE: This feature is only available for HEAT installation as it is disabled in OOM installations.
 111
 112 Logs
 113 ----
 114
 115 - The main application logs for PDP are located at */var/log/onap/policy/pdpx/* location. The catalina.out can be found at *$POLICY_HOME/servers/pdp/logs/* location.
 116
 117 * Policy PDP uses EELF logging framework for logging and if needed to be modified can be modified at *$POLICY_HOME/servers/pap/webapps/pdp/WEB-INF/classes/logback.xml*.  This change needs a restart of the PDP component in order to be in effect.
 118
 119 - 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.
 120
 121
 122 BRMSGW (Business Rule Management System Gateway)
 123 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 124
 125 Accessing and Starting BRMSGW
 126 -----------------------------
 127
 128 - To access the BRMSGW docker :
 129
 130     .. code-block:: bash
 131
 132         docker exec -it -u 0 brmsgw su - policy
 133
 134 - To start and stop the BRMSGW components the same procedure can be followed as documented for PAP and PDP-X.
 135
 136     .. code-block:: bash
 137
 138         policy.sh [--debug] status|start|stop
 139
 140 Logs
 141 ----
 142
 143 - The main application logs for BRMSGW are located at */var/log/onap/policy/policyapi/* location. The logs are divided into separate files; debug logs can be found in *debug.log* and error logs in *error.log* file which are two different files under application logs directory.
 144
 145 * The brmsgw.log can be found at */var/log/onap/policy/brmsgw* location.
 146
 147
 148 End of Document
 149
 150 .. SSNote: Wiki page ref.  https://wiki.onap.org/pages/viewpage.action?pageId=16003633
 151