diff options
Diffstat (limited to 'docs')
20 files changed, 262 insertions, 0 deletions
diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst index 0ea25d09..1bb96a8d 100644 --- a/docs/development/devtools/devtools.rst +++ b/docs/development/devtools/devtools.rst @@ -421,6 +421,16 @@ To test these images, CSITs will be run. Automated tests will be run, and log files displayed. +Running Policy Components Locally +********************************* + +The following page outlines how to run the policy framework components locally use IntelliJ, Eclipse and the Command Line. + +.. toctree:: + :maxdepth: 1 + + local-installation.rst + Generating Swagger Documentation ******************************** diff --git a/docs/development/devtools/images/a1-ppnt-intellij.png b/docs/development/devtools/images/a1-ppnt-intellij.png Binary files differnew file mode 100644 index 00000000..808911e3 --- /dev/null +++ b/docs/development/devtools/images/a1-ppnt-intellij.png diff --git a/docs/development/devtools/images/acm-eclipse.png b/docs/development/devtools/images/acm-eclipse.png Binary files differnew file mode 100644 index 00000000..d70337cf --- /dev/null +++ b/docs/development/devtools/images/acm-eclipse.png diff --git a/docs/development/devtools/images/acm-intellij.png b/docs/development/devtools/images/acm-intellij.png Binary files differnew file mode 100644 index 00000000..cd55acdf --- /dev/null +++ b/docs/development/devtools/images/acm-intellij.png diff --git a/docs/development/devtools/images/apex-pdp-eclipse.png b/docs/development/devtools/images/apex-pdp-eclipse.png Binary files differnew file mode 100644 index 00000000..d02cfce4 --- /dev/null +++ b/docs/development/devtools/images/apex-pdp-eclipse.png diff --git a/docs/development/devtools/images/apex-pdp-intellij.png b/docs/development/devtools/images/apex-pdp-intellij.png Binary files differnew file mode 100644 index 00000000..350ceb1f --- /dev/null +++ b/docs/development/devtools/images/apex-pdp-intellij.png diff --git a/docs/development/devtools/images/drools-pdp-eclipse.png b/docs/development/devtools/images/drools-pdp-eclipse.png Binary files differnew file mode 100644 index 00000000..8ce2ac47 --- /dev/null +++ b/docs/development/devtools/images/drools-pdp-eclipse.png diff --git a/docs/development/devtools/images/drools-pdp-intellij.png b/docs/development/devtools/images/drools-pdp-intellij.png Binary files differnew file mode 100644 index 00000000..73af7973 --- /dev/null +++ b/docs/development/devtools/images/drools-pdp-intellij.png diff --git a/docs/development/devtools/images/http-ppnt-intellij.png b/docs/development/devtools/images/http-ppnt-intellij.png Binary files differnew file mode 100644 index 00000000..ae0b0ef7 --- /dev/null +++ b/docs/development/devtools/images/http-ppnt-intellij.png diff --git a/docs/development/devtools/images/k8s-ppnt-intellij.png b/docs/development/devtools/images/k8s-ppnt-intellij.png Binary files differnew file mode 100644 index 00000000..9911b68e --- /dev/null +++ b/docs/development/devtools/images/k8s-ppnt-intellij.png diff --git a/docs/development/devtools/images/kserve-ppnt-intellij.png b/docs/development/devtools/images/kserve-ppnt-intellij.png Binary files differnew file mode 100644 index 00000000..077d3f5b --- /dev/null +++ b/docs/development/devtools/images/kserve-ppnt-intellij.png diff --git a/docs/development/devtools/images/policy-api-eclipse.png b/docs/development/devtools/images/policy-api-eclipse.png Binary files differnew file mode 100644 index 00000000..d083578e --- /dev/null +++ b/docs/development/devtools/images/policy-api-eclipse.png diff --git a/docs/development/devtools/images/policy-api-intellij.png b/docs/development/devtools/images/policy-api-intellij.png Binary files differnew file mode 100644 index 00000000..b109b510 --- /dev/null +++ b/docs/development/devtools/images/policy-api-intellij.png diff --git a/docs/development/devtools/images/policy-pap-eclipse.png b/docs/development/devtools/images/policy-pap-eclipse.png Binary files differnew file mode 100644 index 00000000..e93a298c --- /dev/null +++ b/docs/development/devtools/images/policy-pap-eclipse.png diff --git a/docs/development/devtools/images/policy-pap-intellij.png b/docs/development/devtools/images/policy-pap-intellij.png Binary files differnew file mode 100644 index 00000000..9f2d1c94 --- /dev/null +++ b/docs/development/devtools/images/policy-pap-intellij.png diff --git a/docs/development/devtools/images/policy-ppnt-eclipse.png b/docs/development/devtools/images/policy-ppnt-eclipse.png Binary files differnew file mode 100644 index 00000000..ac011ab9 --- /dev/null +++ b/docs/development/devtools/images/policy-ppnt-eclipse.png diff --git a/docs/development/devtools/images/policy-ppnt-intellij.png b/docs/development/devtools/images/policy-ppnt-intellij.png Binary files differnew file mode 100644 index 00000000..282e5136 --- /dev/null +++ b/docs/development/devtools/images/policy-ppnt-intellij.png diff --git a/docs/development/devtools/images/xacml-pdp-eclipse.png b/docs/development/devtools/images/xacml-pdp-eclipse.png Binary files differnew file mode 100644 index 00000000..35a35307 --- /dev/null +++ b/docs/development/devtools/images/xacml-pdp-eclipse.png diff --git a/docs/development/devtools/images/xacml-pdp-intellij.png b/docs/development/devtools/images/xacml-pdp-intellij.png Binary files differnew file mode 100644 index 00000000..3025cfff --- /dev/null +++ b/docs/development/devtools/images/xacml-pdp-intellij.png diff --git a/docs/development/devtools/local-installation.rst b/docs/development/devtools/local-installation.rst new file mode 100644 index 00000000..76520143 --- /dev/null +++ b/docs/development/devtools/local-installation.rst @@ -0,0 +1,252 @@ +.. _local-policy-label: + +.. toctree:: + :maxdepth: 2 + +Policy Framework Component Local Execution +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This page will explain how to execute policy components locally using an IDE (IntelliJ/Eclipse) or using the command line. +The intention of this page is to outline how a developer can quickly execute a single component for testing purposes, alleviating the need to generate docker images per change to test in Docker/Kubernetes environments. + +These instructions are for development purposes only. + +Note: Run "mvn clean install" before bringing up the components using the methods outlined below. +Note: Running applications in the IDEs will require run configurations if shown below. + +Policy API +********** + +Eclipse +------- + + .. image:: images/policy-api-eclipse.png + +IntelliJ +-------- + + .. image:: images/policy-api-intellij.png + +Command Line +------------ + + .. code-block:: bash + + mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082” + +Policy PAP +********** + +Eclipse +------- + + .. image:: images/policy-pap-eclipse.png + +IntelliJ +-------- + + .. image:: images/policy-pap-intellij.png + +Command Line +------------ + + .. code-block:: bash + + mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082” + +Apex-PDP +******** + +Eclipse +------- + + .. image:: images/apex-pdp-eclipse.png + +IntelliJ +-------- + + .. image:: images/apex-pdp-intellij.png + +Command Line +------------ + + .. code-block:: bash + + cd services/services-engine + mvn -q -e clean compile exec:java -Dexec.mainClass="org.onap.policy.apex.service.engine.main.ApexMain" -Dexec.args="-p /PATH/TO/POLICY_FILE.json" + +ACM-Runtime +*********** + +Eclipse +------- + + .. image:: images/acm-eclipse.png + +IntelliJ +-------- + + .. image:: images/acm-intellij.png + +Command Line +------------ + + .. code-block:: bash + + mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082” + +Models Simulators +***************** + +Command Line +------------ + + .. code-block:: bash + + mvn -q -e clean compile exec:java -Dexec.mainClass="org.onap.policy.models.sim.pdp.PdpSimulatorMain" -Dexec.args="-c /PATH/TO/OnapPfConfig.json" + + .. code-block:: bash + + mvn -q -e clean compile exec:java -Dexec.mainClass="org.onap.policy.models.sim.dmaap.startstop.Main" -Dexec.args="-c /PATH/TO/DefaultConfig.json" + +XACML-PDP +********* + +Eclipse +------- + + .. image:: images/xacml-pdp-eclipse.png + +IntelliJ +-------- + + .. image:: images/xacml-pdp-intellij.png + +Command Line +------------ + + .. code-block:: bash + + cd main + mvn -q -e clean compile exec:java -Dexec.mainClass="org.onap.policy.pdpx.main.startstop.Main" -Dexec.args="-c /PATH/TO/XacmlPdpConfigParameters.json" + +Drools-PDP +********** + +Eclipse +------- + + .. image:: images/drools-pdp-eclipse.png + +IntelliJ +-------- + + .. image:: images/drools-pdp-intellij.png + +Command Line +------------ + + .. code-block:: bash + + cd policy-management + mvn -q -e clean compile exec:java -Dexec.mainClass="org.onap.policy.drools.system.Main" + +Policy Participant +****************** + +Eclipse +------- + + .. image:: images/policy-ppnt-eclipse.png + +IntelliJ +-------- + + .. image:: images/policy-ppnt-intellij.png + +Command Line +------------ + + .. code-block:: bash + + mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082” + +Http Participant +**************** + +Eclipse +------- + +Similar to above eclipse configuration for participant startup. + +IntelliJ +-------- + + .. image:: images/http-ppnt-intellij.png + +Command Line +------------ + + .. code-block:: bash + + mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082” + +Kubernetes Participant +********************** + +Eclipse +------- + +Similar to above eclipse configuration for participant startup. + +IntelliJ +-------- + + .. image:: images/k8s-ppnt-intellij.png + +Command Line +------------ + + .. code-block:: bash + + mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082” + +A1 Participant +************** + +Eclipse +------- + +Similar to above eclipse configuration for participant startup. + +IntelliJ +-------- + + .. image:: images/a1-ppnt-intellij.png + +Command Line +------------ + + .. code-block:: bash + + mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082” + +Kserve Participant +****************** + +Eclipse +------- + +Similar to above eclipse configuration for participant startup. + +IntelliJ +-------- + + .. image:: images/kserve-ppnt-intellij.png + +Command Line +------------ + + .. code-block:: bash + + mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
\ No newline at end of file |
