Code Review / policy / parent.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Fix urls in drools-pdp docs
[policy/parent.git] / docs / drools / pdpdEngine.rst
diff --git a/docs/drools/pdpdEngine.rst b/docs/drools/pdpdEngine.rst
index 3456cc6..58120a5 100644 (file)
--- a/docs/drools/pdpdEngine.rst
+++ b/docs/drools/pdpdEngine.rst
@@ -40,11 +40,11 @@ Docker Image
 ~~~~~~~~~~~~
 
 Check the *drools-pdp* `released versions <https://wiki.onap.org/display/DW/Policy+Framework+Project%3A+Component+Versions>`__ page for the latest versions.
 ~~~~~~~~~~~~
 
 Check the *drools-pdp* `released versions <https://wiki.onap.org/display/DW/Policy+Framework+Project%3A+Component+Versions>`__ page for the latest versions.
-At the time of this writing *1.6.3* is the latest version.
+At the time of this writing *1.8.2* is the latest version.
 
 .. code-block:: bash
 
 
 .. code-block:: bash
 
-    docker pull onap/policy-drools:1.6.3
+    docker pull onap/policy-drools:1.8.2
 
 A container instantiated from this image will run under the non-priviledged *policy* account.
 
 
 A container instantiated from this image will run under the non-priviledged *policy* account.
 
@@ -60,7 +60,7 @@ The following command can be used to explore the directory layout.
 
 .. code-block:: bash
 
 
 .. code-block:: bash
 
-    docker run --rm -it nexus3.onap.org:10001/onap/policy-drools:1.6.3 -- bash
+    docker run --rm -it nexus3.onap.org:10001/onap/policy-drools:1.8.2 -- bash
 
 Communication Endpoints
 =======================
 
 Communication Endpoints
 =======================
@@ -216,27 +216,27 @@ Controllers
 defined in *<name>-controller.properties* files.
 
 For example, see the
 defined in *<name>-controller.properties* files.
 
 For example, see the
-`frankfurt controller configuration <https://git.onap.org/policy/drools-applications/tree/controlloop/common/feature-controlloop-frankfurt/src/main/feature/config/frankfurt-controller.properties>`__.
+`usecases controller configuration <https://git.onap.org/policy/drools-applications/tree/controlloop/common/feature-controlloop-usecases/src/main/feature/config/usecases-controller.properties>`__.
 
 This configuration file has two sections: *a)* application maven coordinates, and *b)* endpoint references and coders.
 
 Maven Coordinates
 ~~~~~~~~~~~~~~~~~
 
 
 This configuration file has two sections: *a)* application maven coordinates, and *b)* endpoint references and coders.
 
 Maven Coordinates
 ~~~~~~~~~~~~~~~~~
 
-The coordinates section (*rules*) points to the *controller-frankfurt* *kjar* artifact.
+The coordinates section (*rules*) points to the *controller-usecases* *kjar* artifact.
 It is the *brain* of the control loop application.
 
 .. code-block:: bash
 
 It is the *brain* of the control loop application.
 
 .. code-block:: bash
 
-    controller.name=frankfurt
+    controller.name=usecases
 
     rules.groupId=${project.groupId}
 
     rules.groupId=${project.groupId}
-    rules.artifactId=controller-frankfurt
+    rules.artifactId=controller-usecases
     rules.version=${project.version}
     .....
 
 This *kjar* contains the
     rules.version=${project.version}
     .....
 
 This *kjar* contains the
-`frankfurt DRL <https://git.onap.org/policy/drools-applications/tree/controlloop/common/controller-frankfurt/src/main/resources/frankfurt.drl>`__ file (there may be more than one DRL file included).
+`usecases DRL <https://git.onap.org/policy/drools-applications/tree/controlloop/common/controller-usecases/src/main/resources/usecases.drl>`__ file (there may be more than one DRL file included).
 
 .. code-block:: bash
 
 
 .. code-block:: bash
 
@@ -256,7 +256,7 @@ This *kjar* contains the
     ...
 
 The DRL in conjuction with the dependent java libraries in the kjar
     ...
 
 The DRL in conjuction with the dependent java libraries in the kjar
-`pom <https://git.onap.org/policy/drools-applications/tree/controlloop/common/controller-frankfurt/pom.xml>`__
+`pom <https://git.onap.org/policy/drools-applications/tree/controlloop/common/controller-usecases/pom.xml>`__
 realizes the application's function.  For intance, it realizes the
 vFirewall, vCPE, and vDNS use cases in ONAP.
 
 realizes the application's function.  For intance, it realizes the
 vFirewall, vCPE, and vDNS use cases in ONAP.
 
@@ -274,7 +274,7 @@ vFirewall, vCPE, and vDNS use cases in ONAP.
 Endpoints References and Coders
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Endpoints References and Coders
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The *frankfurt-controller.properties* configuration also contains a mix of
+The *usecases-controller.properties* configuration also contains a mix of
 source (of incoming controller traffic) and sink (of outgoing controller traffic)
 configuration.  This configuration also contains specific
 filtering and mapping rules for incoming and outgoing dmaap messages
 source (of incoming controller traffic) and sink (of outgoing controller traffic)
 configuration.  This configuration also contains specific
 filtering and mapping rules for incoming and outgoing dmaap messages
@@ -438,11 +438,10 @@ The PDP-D also recognizes Tosca Operational Policies, although it needs an
 application *controller* that understands them to execute them.   These are:
 
 - *onap.policies.controlloop.operational.common.Drools*
 application *controller* that understands them to execute them.   These are:
 
 - *onap.policies.controlloop.operational.common.Drools*
-- *onap.policies.controlloop.Operational*
 
 A minimum of one application *controller* that supports these capabilities
 must be installed in order to honor the *operational policy types*.
 
 A minimum of one application *controller* that supports these capabilities
 must be installed in order to honor the *operational policy types*.
-One such controller is the *frankfurt* controller residing in the
+One such controller is the *usecases* controller residing in the
 `policy/drools-applications <https://git.onap.org/policy/drools-applications>`__
 repository.
 
 `policy/drools-applications <https://git.onap.org/policy/drools-applications>`__
 repository.
 
@@ -459,8 +458,8 @@ explicitly in a native *onap.policies.native.drools.Controller* policy.
     }
 
 The *controller* application could declare its supported policy types in the *kjar*.
     }
 
 The *controller* application could declare its supported policy types in the *kjar*.
-For example, the *frankfurt controller* packages this information in the
-`kmodule.xml <https://git.onap.org/policy/drools-applications/tree/controlloop/common/controller-frankfurt/src/main/resources/META-INF/kmodule.xml>`__.    One advantage of this approach is that the PDP-D would only
+For example, the *usecases controller* packages this information in the
+`kmodule.xml <https://git.onap.org/policy/drools-applications/tree/controlloop/common/controller-usecases/src/main/resources/META-INF/kmodule.xml>`__.    One advantage of this approach is that the PDP-D would only
 commit to execute policies against these policy types if a supporting controller is up and running.
 
 .. code-block:: bash
 commit to execute policies against these policy types if a supporting controller is up and running.
 
 .. code-block:: bash
@@ -469,7 +468,7 @@ commit to execute policies against these policy types if a supporting controller
         <kbase name="onap.policies.controlloop.operational.common.Drools" default="false" equalsBehavior="equality"/>
         <kbase name="onap.policies.controlloop.Operational" equalsBehavior="equality"
                packages="org.onap.policy.controlloop" includes="onap.policies.controlloop.operational.common.Drools">
         <kbase name="onap.policies.controlloop.operational.common.Drools" default="false" equalsBehavior="equality"/>
         <kbase name="onap.policies.controlloop.Operational" equalsBehavior="equality"
                packages="org.onap.policy.controlloop" includes="onap.policies.controlloop.operational.common.Drools">
-            <ksession name="frankfurt"/>
+            <ksession name="usecases"/>
         </kbase>
     </kmodule>
 
         </kbase>
     </kmodule>
 
@@ -783,6 +782,7 @@ unnecessary or have not been thoroughly tested:
    feature_sesspersist.rst
    feature_statemgmt.rst
    feature_testtransaction.rst
    feature_sesspersist.rst
    feature_statemgmt.rst
    feature_testtransaction.rst
+   feature_nolocking.rst
 
 Data Migration
 ==============
 
 Data Migration
 ==============
@@ -841,7 +841,7 @@ The following command will provide a report on the upgrade or downgrade activies
 
     db-migrator -s ALL -o report
 
 
     db-migrator -s ALL -o report
 
-For example in the official frankfurt delivery:
+For example in the official guilin delivery:
 
 .. code-block:: bash
 
 
 .. code-block:: bash
 
@@ -960,8 +960,7 @@ The *status* option provides generic status of the system.
     controlloop-management 1.6.4           enabled
     controlloop-utils      1.6.4           enabled
     controlloop-trans      1.6.4           enabled
     controlloop-management 1.6.4           enabled
     controlloop-utils      1.6.4           enabled
     controlloop-trans      1.6.4           enabled
-    controlloop-frankfurt  1.6.4           enabled
-    controlloop-usecases   1.6.4           disabled
+    controlloop-usecases   1.6.4           enabled
 
     [migration]
     pooling: OK @ 1811
 
     [migration]
     pooling: OK @ 1811
@@ -993,7 +992,7 @@ Telemetry Shell
     Server: Jetty(9.4.24.v20191120)
 
     [
     Server: Jetty(9.4.24.v20191120)
 
     [
-        "frankfurt"
+        "usecases"
     ]
 
     https://localhost:9696/policy/pdp/engine> exit
     ]
 
     https://localhost:9696/policy/pdp/engine> exit
@@ -1378,22 +1377,22 @@ To take it down:
 Other examples
 ~~~~~~~~~~~~~~
 
 Other examples
 ~~~~~~~~~~~~~~
 
-The reader can also look at the `integration/csit repository <https://git.onap.org/integration/csit>`__.
+The reader can also look at the `policy/docker repository <https://github.com/onap/policy-docker/tree/master/csit>`__.
 More specifically, these directories have examples of other PDP-D configurations:
 
 More specifically, these directories have examples of other PDP-D configurations:
 
-* `plans <https://git.onap.org/integration/csit/tree/plans/policy/drools-pdp>`__: startup scripts.
-* `scripts <https://git.onap.org/integration/csit/tree/scripts/policy/docker-compose-drools.yml>`__: docker-compose related files.
-* `plans <https://git.onap.org/integration/csit/tree/tests/policy/drools-pdp>`__: test plan.
+* `plans <https://github.com/onap/policy-docker/tree/master/csit/drools-pdp/plans>`__: startup & teardown scripts.
+* `scripts <https://github.com/onap/policy-docker/blob/master/csit/docker-compose-all.yml>`__: docker-compose file.
+* `tests <https://github.com/onap/policy-docker/tree/master/csit/drools-pdp/tests>`__: test plan.
 
 Configuring the PDP-D in an OOM Kubernetes installation
 =======================================================
 
 
 Configuring the PDP-D in an OOM Kubernetes installation
 =======================================================
 
-The `PDP-D OOM chart <https://git.onap.org/oom/tree/kubernetes/policy/charts/drools>`__ can be
+The `PDP-D OOM chart <https://github.com/onap/oom/tree/master/kubernetes/policy/components/policy-drools-pdp>`__ can be
 customized at the following locations:
 
 customized at the following locations:
 
-* `values.yaml <https://git.onap.org/oom/tree/kubernetes/policy/charts/drools/values.yaml>`__: custom values for your installation.
-* `configmaps <https://git.onap.org/oom/tree/kubernetes/policy/charts/drools/resources/configmaps>`__: place in this directory any configuration extensions or overrides to customize the PDP-D that does not contain sensitive information.
-* `secrets <https://git.onap.org/oom/tree/kubernetes/policy/charts/drools/resources/secrets>`__: place in this directory any configuration extensions or overrides to customize the PDP-D that does contain sensitive information.
+* `values.yaml <https://github.com/onap/oom/blob/master/kubernetes/policy/components/policy-drools-pdp/values.yaml>`__: custom values for your installation.
+* `configmaps <https://github.com/onap/oom/tree/master/kubernetes/policy/components/policy-drools-pdp/resources/configmaps>`__: place in this directory any configuration extensions or overrides to customize the PDP-D that does not contain sensitive information.
+* `secrets <https://github.com/onap/oom/tree/master/kubernetes/policy/components/policy-drools-pdp/resources/secrets>`__: place in this directory any configuration extensions or overrides to customize the PDP-D that does contain sensitive information.
 
 The same customization techniques described in the docker sections for PDP-D, fully apply here, by placing the corresponding
 files or scripts in these two directories.
 
 The same customization techniques described in the docker sections for PDP-D, fully apply here, by placing the corresponding
 files or scripts in these two directories.
Parent code that holds the pom.xml to build all the repos (Casablanca)