From c92e128c5d7a1a67f43321d275b6e9d3c8f16e57 Mon Sep 17 00:00:00 2001 From: waynedunican Date: Wed, 3 May 2023 08:18:36 +0100 Subject: Add microk8s installation documentation - Add description of how to install and run the Policy Framework in microk8s - Fix html issues in local-installation.rst Issue-ID: POLICY-4582 Change-Id: I7351c08bf77aaca85677ff0cd34912017373e363 Signed-off-by: waynedunican --- docs/development/devtools/devtools.rst | 14 +- .../devtools/images/a1-ppnt-intellij.png | Bin 169355 -> 0 bytes docs/development/devtools/images/acm-eclipse.png | Bin 228862 -> 0 bytes docs/development/devtools/images/acm-intellij.png | Bin 163735 -> 0 bytes .../devtools/images/apex-pdp-eclipse.png | Bin 306536 -> 0 bytes .../devtools/images/apex-pdp-intellij.png | Bin 273045 -> 0 bytes .../devtools/images/drools-pdp-eclipse.png | Bin 326193 -> 0 bytes .../devtools/images/drools-pdp-intellij.png | Bin 186189 -> 0 bytes .../devtools/images/http-ppnt-intellij.png | Bin 176737 -> 0 bytes .../devtools/images/k8s-ppnt-intellij.png | Bin 174754 -> 0 bytes .../devtools/images/kserve-ppnt-intellij.png | Bin 183985 -> 0 bytes .../devtools/images/policy-api-eclipse.png | Bin 891410 -> 0 bytes .../devtools/images/policy-api-intellij.png | Bin 474845 -> 0 bytes .../devtools/images/policy-pap-eclipse.png | Bin 161261 -> 0 bytes .../devtools/images/policy-pap-intellij.png | Bin 492975 -> 0 bytes .../devtools/images/policy-ppnt-eclipse.png | Bin 210489 -> 0 bytes .../devtools/images/policy-ppnt-intellij.png | Bin 169818 -> 0 bytes .../devtools/images/xacml-pdp-eclipse.png | Bin 292217 -> 0 bytes .../devtools/images/xacml-pdp-intellij.png | Bin 265483 -> 0 bytes .../installation/images/a1-ppnt-intellij.png | Bin 0 -> 169355 bytes .../devtools/installation/images/acm-eclipse.png | Bin 0 -> 228862 bytes .../devtools/installation/images/acm-intellij.png | Bin 0 -> 163735 bytes .../installation/images/apex-pdp-eclipse.png | Bin 0 -> 306536 bytes .../installation/images/apex-pdp-intellij.png | Bin 0 -> 273045 bytes .../installation/images/drools-pdp-eclipse.png | Bin 0 -> 326193 bytes .../installation/images/drools-pdp-intellij.png | Bin 0 -> 186189 bytes .../installation/images/http-ppnt-intellij.png | Bin 0 -> 176737 bytes .../installation/images/k8s-ppnt-intellij.png | Bin 0 -> 174754 bytes .../installation/images/kserve-ppnt-intellij.png | Bin 0 -> 183985 bytes .../installation/images/policy-api-eclipse.png | Bin 0 -> 891410 bytes .../installation/images/policy-api-intellij.png | Bin 0 -> 474845 bytes .../installation/images/policy-pap-eclipse.png | Bin 0 -> 161261 bytes .../installation/images/policy-pap-intellij.png | Bin 0 -> 492975 bytes .../installation/images/policy-ppnt-eclipse.png | Bin 0 -> 210489 bytes .../installation/images/policy-ppnt-intellij.png | Bin 0 -> 169818 bytes .../installation/images/xacml-pdp-eclipse.png | Bin 0 -> 292217 bytes .../installation/images/xacml-pdp-intellij.png | Bin 0 -> 265483 bytes .../devtools/installation/local-installation.rst | 252 +++++++++++++++++++++ .../installation/microk8s-installation.rst | 47 ++++ docs/development/devtools/local-installation.rst | 252 --------------------- 40 files changed, 311 insertions(+), 254 deletions(-) delete mode 100644 docs/development/devtools/images/a1-ppnt-intellij.png delete mode 100644 docs/development/devtools/images/acm-eclipse.png delete mode 100644 docs/development/devtools/images/acm-intellij.png delete mode 100644 docs/development/devtools/images/apex-pdp-eclipse.png delete mode 100644 docs/development/devtools/images/apex-pdp-intellij.png delete mode 100644 docs/development/devtools/images/drools-pdp-eclipse.png delete mode 100644 docs/development/devtools/images/drools-pdp-intellij.png delete mode 100644 docs/development/devtools/images/http-ppnt-intellij.png delete mode 100644 docs/development/devtools/images/k8s-ppnt-intellij.png delete mode 100644 docs/development/devtools/images/kserve-ppnt-intellij.png delete mode 100644 docs/development/devtools/images/policy-api-eclipse.png delete mode 100644 docs/development/devtools/images/policy-api-intellij.png delete mode 100644 docs/development/devtools/images/policy-pap-eclipse.png delete mode 100644 docs/development/devtools/images/policy-pap-intellij.png delete mode 100644 docs/development/devtools/images/policy-ppnt-eclipse.png delete mode 100644 docs/development/devtools/images/policy-ppnt-intellij.png delete mode 100644 docs/development/devtools/images/xacml-pdp-eclipse.png delete mode 100644 docs/development/devtools/images/xacml-pdp-intellij.png create mode 100644 docs/development/devtools/installation/images/a1-ppnt-intellij.png create mode 100644 docs/development/devtools/installation/images/acm-eclipse.png create mode 100644 docs/development/devtools/installation/images/acm-intellij.png create mode 100644 docs/development/devtools/installation/images/apex-pdp-eclipse.png create mode 100644 docs/development/devtools/installation/images/apex-pdp-intellij.png create mode 100644 docs/development/devtools/installation/images/drools-pdp-eclipse.png create mode 100644 docs/development/devtools/installation/images/drools-pdp-intellij.png create mode 100644 docs/development/devtools/installation/images/http-ppnt-intellij.png create mode 100644 docs/development/devtools/installation/images/k8s-ppnt-intellij.png create mode 100644 docs/development/devtools/installation/images/kserve-ppnt-intellij.png create mode 100644 docs/development/devtools/installation/images/policy-api-eclipse.png create mode 100644 docs/development/devtools/installation/images/policy-api-intellij.png create mode 100644 docs/development/devtools/installation/images/policy-pap-eclipse.png create mode 100644 docs/development/devtools/installation/images/policy-pap-intellij.png create mode 100644 docs/development/devtools/installation/images/policy-ppnt-eclipse.png create mode 100644 docs/development/devtools/installation/images/policy-ppnt-intellij.png create mode 100644 docs/development/devtools/installation/images/xacml-pdp-eclipse.png create mode 100644 docs/development/devtools/installation/images/xacml-pdp-intellij.png create mode 100644 docs/development/devtools/installation/local-installation.rst create mode 100644 docs/development/devtools/installation/microk8s-installation.rst delete mode 100644 docs/development/devtools/local-installation.rst diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst index 75f34434..5f7f8434 100644 --- a/docs/development/devtools/devtools.rst +++ b/docs/development/devtools/devtools.rst @@ -421,12 +421,22 @@ To test these images, CSITs will be run. Running Policy Components Locally ********************************* -The following page outlines how to run the policy framework components locally use IntelliJ, Eclipse and the Command Line. +The following page outlines how to run the policy framework components locally using IntelliJ, Eclipse and the Command Line. .. toctree:: :maxdepth: 1 - local-installation.rst + ./installation/local-installation.rst + +Running the Policy Framework in Microk8s +**************************************** + +The following page outlines how to run the policy framework components using microk8s. + +.. toctree:: + :maxdepth: 1 + + ./installation/microk8s-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 deleted file mode 100644 index 808911e3..00000000 Binary files a/docs/development/devtools/images/a1-ppnt-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/acm-eclipse.png b/docs/development/devtools/images/acm-eclipse.png deleted file mode 100644 index d70337cf..00000000 Binary files a/docs/development/devtools/images/acm-eclipse.png and /dev/null differ diff --git a/docs/development/devtools/images/acm-intellij.png b/docs/development/devtools/images/acm-intellij.png deleted file mode 100644 index cd55acdf..00000000 Binary files a/docs/development/devtools/images/acm-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/apex-pdp-eclipse.png b/docs/development/devtools/images/apex-pdp-eclipse.png deleted file mode 100644 index d02cfce4..00000000 Binary files a/docs/development/devtools/images/apex-pdp-eclipse.png and /dev/null differ diff --git a/docs/development/devtools/images/apex-pdp-intellij.png b/docs/development/devtools/images/apex-pdp-intellij.png deleted file mode 100644 index 350ceb1f..00000000 Binary files a/docs/development/devtools/images/apex-pdp-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/drools-pdp-eclipse.png b/docs/development/devtools/images/drools-pdp-eclipse.png deleted file mode 100644 index 8ce2ac47..00000000 Binary files a/docs/development/devtools/images/drools-pdp-eclipse.png and /dev/null differ diff --git a/docs/development/devtools/images/drools-pdp-intellij.png b/docs/development/devtools/images/drools-pdp-intellij.png deleted file mode 100644 index 73af7973..00000000 Binary files a/docs/development/devtools/images/drools-pdp-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/http-ppnt-intellij.png b/docs/development/devtools/images/http-ppnt-intellij.png deleted file mode 100644 index ae0b0ef7..00000000 Binary files a/docs/development/devtools/images/http-ppnt-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/k8s-ppnt-intellij.png b/docs/development/devtools/images/k8s-ppnt-intellij.png deleted file mode 100644 index 9911b68e..00000000 Binary files a/docs/development/devtools/images/k8s-ppnt-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/kserve-ppnt-intellij.png b/docs/development/devtools/images/kserve-ppnt-intellij.png deleted file mode 100644 index 077d3f5b..00000000 Binary files a/docs/development/devtools/images/kserve-ppnt-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/policy-api-eclipse.png b/docs/development/devtools/images/policy-api-eclipse.png deleted file mode 100644 index d083578e..00000000 Binary files a/docs/development/devtools/images/policy-api-eclipse.png and /dev/null differ diff --git a/docs/development/devtools/images/policy-api-intellij.png b/docs/development/devtools/images/policy-api-intellij.png deleted file mode 100644 index b109b510..00000000 Binary files a/docs/development/devtools/images/policy-api-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/policy-pap-eclipse.png b/docs/development/devtools/images/policy-pap-eclipse.png deleted file mode 100644 index e93a298c..00000000 Binary files a/docs/development/devtools/images/policy-pap-eclipse.png and /dev/null differ diff --git a/docs/development/devtools/images/policy-pap-intellij.png b/docs/development/devtools/images/policy-pap-intellij.png deleted file mode 100644 index 9f2d1c94..00000000 Binary files a/docs/development/devtools/images/policy-pap-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/policy-ppnt-eclipse.png b/docs/development/devtools/images/policy-ppnt-eclipse.png deleted file mode 100644 index ac011ab9..00000000 Binary files a/docs/development/devtools/images/policy-ppnt-eclipse.png and /dev/null differ diff --git a/docs/development/devtools/images/policy-ppnt-intellij.png b/docs/development/devtools/images/policy-ppnt-intellij.png deleted file mode 100644 index 282e5136..00000000 Binary files a/docs/development/devtools/images/policy-ppnt-intellij.png and /dev/null differ diff --git a/docs/development/devtools/images/xacml-pdp-eclipse.png b/docs/development/devtools/images/xacml-pdp-eclipse.png deleted file mode 100644 index 35a35307..00000000 Binary files a/docs/development/devtools/images/xacml-pdp-eclipse.png and /dev/null differ diff --git a/docs/development/devtools/images/xacml-pdp-intellij.png b/docs/development/devtools/images/xacml-pdp-intellij.png deleted file mode 100644 index 3025cfff..00000000 Binary files a/docs/development/devtools/images/xacml-pdp-intellij.png and /dev/null differ diff --git a/docs/development/devtools/installation/images/a1-ppnt-intellij.png b/docs/development/devtools/installation/images/a1-ppnt-intellij.png new file mode 100644 index 00000000..808911e3 Binary files /dev/null and b/docs/development/devtools/installation/images/a1-ppnt-intellij.png differ diff --git a/docs/development/devtools/installation/images/acm-eclipse.png b/docs/development/devtools/installation/images/acm-eclipse.png new file mode 100644 index 00000000..d70337cf Binary files /dev/null and b/docs/development/devtools/installation/images/acm-eclipse.png differ diff --git a/docs/development/devtools/installation/images/acm-intellij.png b/docs/development/devtools/installation/images/acm-intellij.png new file mode 100644 index 00000000..cd55acdf Binary files /dev/null and b/docs/development/devtools/installation/images/acm-intellij.png differ diff --git a/docs/development/devtools/installation/images/apex-pdp-eclipse.png b/docs/development/devtools/installation/images/apex-pdp-eclipse.png new file mode 100644 index 00000000..d02cfce4 Binary files /dev/null and b/docs/development/devtools/installation/images/apex-pdp-eclipse.png differ diff --git a/docs/development/devtools/installation/images/apex-pdp-intellij.png b/docs/development/devtools/installation/images/apex-pdp-intellij.png new file mode 100644 index 00000000..350ceb1f Binary files /dev/null and b/docs/development/devtools/installation/images/apex-pdp-intellij.png differ diff --git a/docs/development/devtools/installation/images/drools-pdp-eclipse.png b/docs/development/devtools/installation/images/drools-pdp-eclipse.png new file mode 100644 index 00000000..8ce2ac47 Binary files /dev/null and b/docs/development/devtools/installation/images/drools-pdp-eclipse.png differ diff --git a/docs/development/devtools/installation/images/drools-pdp-intellij.png b/docs/development/devtools/installation/images/drools-pdp-intellij.png new file mode 100644 index 00000000..73af7973 Binary files /dev/null and b/docs/development/devtools/installation/images/drools-pdp-intellij.png differ diff --git a/docs/development/devtools/installation/images/http-ppnt-intellij.png b/docs/development/devtools/installation/images/http-ppnt-intellij.png new file mode 100644 index 00000000..ae0b0ef7 Binary files /dev/null and b/docs/development/devtools/installation/images/http-ppnt-intellij.png differ diff --git a/docs/development/devtools/installation/images/k8s-ppnt-intellij.png b/docs/development/devtools/installation/images/k8s-ppnt-intellij.png new file mode 100644 index 00000000..9911b68e Binary files /dev/null and b/docs/development/devtools/installation/images/k8s-ppnt-intellij.png differ diff --git a/docs/development/devtools/installation/images/kserve-ppnt-intellij.png b/docs/development/devtools/installation/images/kserve-ppnt-intellij.png new file mode 100644 index 00000000..077d3f5b Binary files /dev/null and b/docs/development/devtools/installation/images/kserve-ppnt-intellij.png differ diff --git a/docs/development/devtools/installation/images/policy-api-eclipse.png b/docs/development/devtools/installation/images/policy-api-eclipse.png new file mode 100644 index 00000000..d083578e Binary files /dev/null and b/docs/development/devtools/installation/images/policy-api-eclipse.png differ diff --git a/docs/development/devtools/installation/images/policy-api-intellij.png b/docs/development/devtools/installation/images/policy-api-intellij.png new file mode 100644 index 00000000..b109b510 Binary files /dev/null and b/docs/development/devtools/installation/images/policy-api-intellij.png differ diff --git a/docs/development/devtools/installation/images/policy-pap-eclipse.png b/docs/development/devtools/installation/images/policy-pap-eclipse.png new file mode 100644 index 00000000..e93a298c Binary files /dev/null and b/docs/development/devtools/installation/images/policy-pap-eclipse.png differ diff --git a/docs/development/devtools/installation/images/policy-pap-intellij.png b/docs/development/devtools/installation/images/policy-pap-intellij.png new file mode 100644 index 00000000..9f2d1c94 Binary files /dev/null and b/docs/development/devtools/installation/images/policy-pap-intellij.png differ diff --git a/docs/development/devtools/installation/images/policy-ppnt-eclipse.png b/docs/development/devtools/installation/images/policy-ppnt-eclipse.png new file mode 100644 index 00000000..ac011ab9 Binary files /dev/null and b/docs/development/devtools/installation/images/policy-ppnt-eclipse.png differ diff --git a/docs/development/devtools/installation/images/policy-ppnt-intellij.png b/docs/development/devtools/installation/images/policy-ppnt-intellij.png new file mode 100644 index 00000000..282e5136 Binary files /dev/null and b/docs/development/devtools/installation/images/policy-ppnt-intellij.png differ diff --git a/docs/development/devtools/installation/images/xacml-pdp-eclipse.png b/docs/development/devtools/installation/images/xacml-pdp-eclipse.png new file mode 100644 index 00000000..35a35307 Binary files /dev/null and b/docs/development/devtools/installation/images/xacml-pdp-eclipse.png differ diff --git a/docs/development/devtools/installation/images/xacml-pdp-intellij.png b/docs/development/devtools/installation/images/xacml-pdp-intellij.png new file mode 100644 index 00000000..3025cfff Binary files /dev/null and b/docs/development/devtools/installation/images/xacml-pdp-intellij.png differ diff --git a/docs/development/devtools/installation/local-installation.rst b/docs/development/devtools/installation/local-installation.rst new file mode 100644 index 00000000..861d4650 --- /dev/null +++ b/docs/development/devtools/installation/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” diff --git a/docs/development/devtools/installation/microk8s-installation.rst b/docs/development/devtools/installation/microk8s-installation.rst new file mode 100644 index 00000000..360c5b28 --- /dev/null +++ b/docs/development/devtools/installation/microk8s-installation.rst @@ -0,0 +1,47 @@ +.. _local-policy-label: + +.. toctree:: + :maxdepth: 2 + +Policy Framework Component Microk8s Installation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This page will explain how to install the policy in a microk8s environment. +The intention of this page is to outline the process to spin up a kubernetes cluster using microk8s. + +These instructions are for development purposes only. + +Process +******* + +In the latest release of the Policy Framework, the ability to run the Policy Framework CSITs in a kubernetes environment was introduced. +As part of this work, a script has been added to the policy/docker repo to bring up a kubernetes environment and deploy the Policy Framework helm charts. +This makes installation of the Policy Framework easier for developers. + +Steps +----- + +1. Clone the policy/docker repo. + + .. code-block:: bash + + git clone https://github.com/onap/policy-docker + +2. Invoke the microk8s installation script (docker/csit/run-k8s-csit.sh) + + .. code-block:: bash + + docker/csit/run-k8s-csit.sh {install} {project_name} + + When the project name is not specified, the script only installs the policy helm charts and will not execute the robot tests. Alternatively, if you want to run the csit tests for a particular project, you can supply the name here. + + This script verifies the microk8s kubernetes cluster is running, deploys the policy helm charts under the default namespace, builds the docker image for the robot framework and deploys the robot framework helm chart + in the default namespace, and invokes the robot test(s) for the project supplied by the user. The test results can be viewed from the logs of the policy-csit-robot pod. + +3. Teardown the cluster + + .. code-block:: bash + + docker/csit/run-k8s-csit.sh {uninstall} + + To teardown the cluster, the same script can be invoked with the {uninstall} argument. No project name is required. diff --git a/docs/development/devtools/local-installation.rst b/docs/development/devtools/local-installation.rst deleted file mode 100644 index 76520143..00000000 --- a/docs/development/devtools/local-installation.rst +++ /dev/null @@ -1,252 +0,0 @@ -.. _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 -- cgit 1.2.3-korg