diff options
Diffstat (limited to 'docs/platform')
| -rw-r--r-- | docs/platform/deployPDPPAP.rst | 74 | ||||
| -rw-r--r-- | docs/platform/feature_healthcheck.rst | 4 |
2 files changed, 56 insertions, 22 deletions
diff --git a/docs/platform/deployPDPPAP.rst b/docs/platform/deployPDPPAP.rst index 2ca7b4989..487bf1d9e 100644 --- a/docs/platform/deployPDPPAP.rst +++ b/docs/platform/deployPDPPAP.rst @@ -2,9 +2,9 @@ .. 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 -******************************************** +********************************************** +Testing, Deploying and Debugging the PDP-X/PAP +********************************************** .. contents:: :depth: 3 @@ -27,7 +27,7 @@ Accessing and Starting PAP .. code-block:: bash - policy [--debug] status|start|stop + policy.sh [--debug] status|start|stop - To get the current status of Policy use *policy.sh status* @@ -60,55 +60,89 @@ Accessing and Starting PAP Healthcheck ----------- -- To perform Health check on policy components you can follow the generic procedure documented as below. +- 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. .. 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 + source /opt/app/policy/config/feature-healthcheck.conf.environment - curl --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}" - -X GET http://localhost:6969/healthcheck | python -m json.tool + curl -k --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}" + -X GET https://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. +- 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. * 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. +- 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) -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +PDP-X (XACML Policy Decision Point) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Accessing and Starting PDP -------------------------- -- To access the PDP docker : +- To access the PDP-X 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. +- To start and stop the PDP-X components the same procedure can be followed as documented for PAP. .. code-block:: bash - policy [--debug] status|start|stop + policy.sh [--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. +Swagger UI Testing (Only for HEAT installations) +------------------------------------------------ -- 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.`` +- 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. +- In order to access PDP's swagger UI visit ``https://{PDP_URL}:8081/pdp/swagger-ui.html.`` +- NOTE: This feature is only available for HEAT installation as it is disabled in OOM installations. -- In order to test the Policy components, the swagger UI provided by PDP can be used to test PDP and PAP. +Logs +---- + +- 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. + +* 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. + +- 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. + + +BRMSGW (Business Rule Management System Gateway) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Accessing and Starting BRMSGW +----------------------------- + +- To access the BRMSGW docker : + + .. code-block:: bash + + docker exec -it -u 0 brmsgw su - policy + +- To start and stop the BRMSGW components the same procedure can be followed as documented for PAP and PDP-X. + + .. code-block:: bash + + policy.sh [--debug] status|start|stop + +Logs +---- + +- 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. + +* The brmsgw.log can be found at */var/log/onap/policy/brmsgw* location. End of Document diff --git a/docs/platform/feature_healthcheck.rst b/docs/platform/feature_healthcheck.rst index d66a514d7..a0793e92b 100644 --- a/docs/platform/feature_healthcheck.rst +++ b/docs/platform/feature_healthcheck.rst @@ -108,8 +108,8 @@ The Healthcheck can also be invoked manually as follows: # 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 + source /opt/app/policy/config/feature-healthcheck.conf.environment + curl -k --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}" -X GET https://localhost:6969/healthcheck | python -m json.tool End of Document |