Fix doc config files and dead links

[policy/parent.git] / docs / development / devtools / devtools.rst

diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst
index 9012caf..cfd0ab6 100644 (file)
--- a/docs/development/devtools/devtools.rst
+++ b/docs/development/devtools/devtools.rst
@@ -27,7 +27,7 @@ The procedure documented in this article has been verified to work on a MacBook
 Cloning All The Policy Repositories
 ***********************************
 
 Cloning All The Policy Repositories
 ***********************************
 

-Run a script such as the script below to clone the required modules from the `ONAP git repository <https://gerrit.onap.org/r/#/admin/projects/?filter=policy>`_. This script clones all the ONAP Policy Framework repositories.
+Run a script such as the script below to clone the required modules from the `ONAP git repository <https://gerrit.onap.org/r/admin/repos/q/filter:policy>`_. This script clones all the ONAP Policy Framework repositories.

 
 ONAP Policy Framework has dependencies to the ONAP Parent *oparent* module, the ONAP ECOMP SDK *ecompsdkos* module, and the A&AI Schema module.
 
 
 ONAP Policy Framework has dependencies to the ONAP Parent *oparent* module, the ONAP ECOMP SDK *ecompsdkos* module, and the A&AI Schema module.
 


@@ -246,7 +246,7 @@ Another example on how to run the MariaDb is using the docker compose file used
 `Example Compose Script to run MariaDB <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 API component standalone
 `Example Compose Script to run MariaDB <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 API component standalone

-+++++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++++

 
 Assuming you have successfully built the codebase using the instructions above. The only requirement for the API component to run is a
 running MariaDb database instance. The easiest way to do this is to run the docker image, please see the mariadb documentation for the latest
 
 Assuming you have successfully built the codebase using the instructions above. The only requirement for the API component to run is a
 running MariaDb database instance. The easiest way to do this is to run the docker image, please see the mariadb documentation for the latest


@@ -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>`_
 
 
 `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
 ***********************
 
 Running the Smoke Tests
 ***********************
 


@@ -283,15 +297,8 @@ familiar with the Policy Framework components and test any local changes.
    api-smoke.rst
    pap-smoke.rst
    apex-smoke.rst
    api-smoke.rst
    pap-smoke.rst
    apex-smoke.rst

-   distribution-smoke.rst
-
-..

    drools-smoke.rst
    drools-smoke.rst

-
-..

    xacml-smoke.rst
    xacml-smoke.rst

-
-..

    distribution-smoke.rst
 
 
    distribution-smoke.rst
 
 


@@ -327,6 +334,8 @@ the Policy Framework works in a full ONAP deployment.
 
    policy-cds.rst
 
 
    policy-cds.rst
 

+   clamp-sdc.rst
+

 ..
    api-pairwise.rst
 
 ..
    api-pairwise.rst
 


@@ -346,6 +355,57 @@ the Policy Framework works in a full ONAP deployment.
    distribution-pairwise.rst
 
 
    distribution-pairwise.rst
 
 

+Testing OpenSuse docker images
+******************************
+
+Policy Framework offers docker images in two flavors: Alpine and OpenSuse.
+Alpine images are used in OOM for ONAP deployments.
+The OpenSuse images are built manually if needed, by running Maven with the -Pdockersuse profile.
+To test these images, CSITs will be run.
+
+1. Build the OpenSuse image you want by running Maven with -Pdockersuse:
+
+    .. code-block:: bash
+
+        cd policy/apex-pdp
+        mvn clean install -Pdockersuse
+
+    The image onap/policy-apex-pdp:latest will be produced.
+
+2. To avoid ambiguity, tag the image as opensuse:
+
+    .. code-block:: bash
+
+        docker tag onap/policy-apex-pdp:latest onap/policy-apex-pdp:opensuse
+
+3. Clone policy/docker repo.
+
+4. Modify docker/csit/docker-compose-all.yml to use the tagged OpenSuse image.
+
+    Replace:
+
+    .. code-block:: yaml
+
+        apex-pdp:
+          image: nexus3.onap.org:10001/onap/policy-apex-pdp:${POLICY_APEX_PDP_VERSION}
+
+    with:
+
+    .. code-block:: yaml
+
+        apex-pdp:
+          image: onap/policy-apex-pdp:opensuse
+
+5. Run the project CSIT. For apex-pdp:
+
+    .. code-block:: bash
+
+        cd docker/csit
+        ./run-project-csit.sh apex-pdp
+
+    Automated tests will be run, and log files displayed.
+
+

 Generating Swagger Documentation
 ********************************
 
 Generating Swagger Documentation
 ********************************
 


@@ -396,9 +456,6 @@ of such a test case.
                Charset.defaultCharset());
    }
 
                Charset.defaultCharset());
    }
 

-See `this unit test case <https://github.com/onap/policy-clamp/blob/master/runtime/src/test/java/org/onap/policy/clamp/clds/it/HttpsItCase.java>`_
-for the full example.
-

 2. Accessing Swagger documentation for springboot based policy applications
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 2. Accessing Swagger documentation for springboot based policy applications
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 


@@ -453,3 +510,15 @@ You may specify a local configuration file instead of *src/test/resources/simPar
        }
      ]
    }
        }
      ]
    }

+
+Bringing up Strimzi-Kafka Deploment with Policy Framework
+*********************************************************
+
+This page will explain how to setup a local Kubernetes cluster and minimal helm setup to run and deploy Policy Framework on a single host.
+
+This is meant for a development purpose only as we are going to use microk8s in this page
+
+.. toctree::
+   :maxdepth: 1
+
+   strimzi-policy.rst