diff options
| author |   Ajith Sreekumar <ajith.sreekumar@bell.ca> | 2022-04-22 17:25:01 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2022-04-22 17:25:01 +0000 |
| commit | ff8bf24ffc2766644986990c35c5f769e232388a (patch) | |
| tree | 3a9e0a9c382101d73b3991546b5915dffd4b7f94 /docs | |
| parent | 72831558e5ba5b9b4ea745bb5f71e751f83b705e (diff) | |
| parent | bf35ec5f9707280c457eac763b4c29653ec52791 (diff) | |
Merge "Document changes for PAP spring boot migration"
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/devtools/devtools.rst | 14 | ||||
| -rw-r--r-- | docs/pap/pap.rst | 9 |
2 files changed, 20 insertions, 3 deletions
diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst index 9012caf8..5b75d328 100644 --- a/docs/development/devtools/devtools.rst +++ b/docs/development/devtools/devtools.rst @@ -265,6 +265,20 @@ An example of running the api using a docker compose script is located in the Po `Policy CSIT API Docker Compose <https://gerrit.onap.org/r/gitweb?p=integration/csit.git;a=blob;f=scripts/policy/docker-compose-api.yml;h=e32190f1e6cb6d9b64ddf53a2db2c746723a0c6a;hb=refs/heads/master>`_ +Running the PAP component standalone ++++++++++++++++++++++++++++++++++++++ + +Once you have successfully built the PAP codebase, a running MariaDb database and DMaaP instance will also be required to start up the application. +For MariaDb instance, the easiest way is to run the docker image, please see the mariadb documentation for the latest +information on doing so. For DMaaP, the easiest way during development is to run the DMaaP simulator which is explained in the below sections. +Once the mariadb and DMaaP are running, a configuration file must be provided to the PAP component in order for it to know how to +connect to the mariadb and DMaaP along with other relevant configuration details. You can locate the default configuration file in the packaging of the PAP component: + +`Default PAP Configuration <https://gerrit.onap.org/r/gitweb?p=policy/pap.git;a=blob;f=packages/policy-pap-tarball/src/main/resources/etc/papParameters.yaml;h=06dd45f4946fd0a11ed8ef859f8fc5bcf409a3f0;hb=HEAD>`_ + +Update the fields related to MariaDB, DMaaP and the RestServer for the application as per your local environment settings. +Then to start the application, just run the Spring Boot application using IDE or command line. + Running the Smoke Tests *********************** diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst index 074947bd..1af62617 100644 --- a/docs/pap/pap.rst +++ b/docs/pap/pap.rst @@ -387,14 +387,17 @@ Here is a sample response: 3 Configuration ================= +The *PolicyAdministration* component (PAP) is initialized using a configuration file: `papParameters.yaml +<https://github.com/onap/policy-pap/blob/master/packages/policy-pap-tarball/src/main/resources/etc/papParameters.yaml>`_ + +The configuration file is a YAML file containing the relevant fields for configuring the REST server, Database and DMaaP connectivity and so on. + 3.1 Disable collection of PDP Statistics ======================================== This configuration is to inform PAP to not save the PDP statistics in the database. -In `config.json -<https://github.com/onap/policy-pap/blob/master/packages/policy-pap-tarball/src/main/resources/etc/defaultConfig.json>`_, -add or change the property savePdpStatisticsInDb to false. +In *papParameters.yaml*, add or change the property savePdpStatisticsInDb to false. .. note:: By default, if the property is not present, it will be considered as false and |