Merge "Updating documentation for Docker components in XACML Custom Application Tutor...

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

diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst
index 5b75d32..ab57cd2 100644 (file)
--- a/docs/development/devtools/devtools.rst
+++ b/docs/development/devtools/devtools.rst
@@ -297,15 +297,8 @@ familiar with the Policy Framework components and test any local changes.
    api-smoke.rst
    pap-smoke.rst
    apex-smoke.rst
-   distribution-smoke.rst
-
-..
    drools-smoke.rst
-
-..
    xacml-smoke.rst
-
-..
    distribution-smoke.rst
 
 
@@ -341,6 +334,8 @@ the Policy Framework works in a full ONAP deployment.
 
    policy-cds.rst
 
+   clamp-sdc.rst
+
 ..
    api-pairwise.rst
 
@@ -360,6 +355,57 @@ the Policy Framework works in a full ONAP deployment.
    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
 ********************************
 
@@ -467,3 +513,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