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
.. code-block:: bash
- mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
+ mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
Policy PAP
**********
.. code-block:: bash
- mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
+ mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
Apex-PDP
********
.. 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"
+ 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
***********
.. code-block:: bash
- mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
+ mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
Models Simulators
*****************
.. 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"
+ 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"
+ 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
*********
.. 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"
+ 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
**********
.. code-block:: bash
- cd policy-management
- mvn -q -e clean compile exec:java -Dexec.mainClass="org.onap.policy.drools.system.Main"
+ cd policy-management
+ mvn -q -e clean compile exec:java -Dexec.mainClass="org.onap.policy.drools.system.Main"
Policy Participant
******************
.. code-block:: bash
- mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
+ mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
Http Participant
****************
.. code-block:: bash
- mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
+ mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
Kubernetes Participant
**********************
.. code-block:: bash
- mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
+ mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
A1 Participant
**************
.. code-block:: bash
- mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
+ mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
Kserve Participant
******************
.. code-block:: bash
- mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
\ No newline at end of file
+ mvn spring-boot:run -Dspring-boot.run.arguments=”–server.port=8082”
--- /dev/null
+.. _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.
Code Review / policy / parent.git / commitdiff
