Fix doc config files and dead links
[policy/parent.git] / docs / drools / pdpdApps.rst
index a9a0b9f..58bbb06 100644 (file)
@@ -52,7 +52,7 @@ The *onap/policy-pdpd-cl* image extends the *onap/policy-drools* image with
 the *usecases* controller that realizes the *control loop* application.
 
 Usecases Controller
-====================
+===================
 
 The `usecases <https://git.onap.org/policy/drools-applications/tree/controlloop/common/controller-usecases>`__
 controller is the *control loop* application in ONAP.
@@ -86,6 +86,25 @@ The Tosca Compliant Operational Policy Type is defined at the
 An example of a Tosca Compliant Operational Policy can be found
 `here <https://git.onap.org/policy/models/tree/models-examples/src/main/resources/policies/vDNS.policy.operational.input.tosca.json>`__.
 
+Policy Chaining
+===============
+
+The *usecases* controller supports chaining of multiple operations inside a Tosca Operational Policy. The next operation can be chained based on the result/output from an operation.
+The possibilities available for chaining are:
+
+- *success: chain after the result of operation is success*
+- *failure: chain after the result of operation is failure due to issues with controller/actor*
+- *failure_timeout: chain after the result of operation is failure due to timeout*
+- *failure_retries: chain after the result of operation is failure after all retries*
+- *failure_exception: chain after the result of operation is failure due to exception*
+- *failure_guard: chain after the result of operation is failure due to guard not allowing the operation*
+
+An example of policy chaining for VNF can be found
+`here <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vFirewall.cds.policy.operational.chaining.yaml>`__.
+
+An example of policy chaining for PNF can be found
+`here <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/pnf.cds.policy.operational.chaining.yaml>`__.
+
 Features
 ========
 
@@ -121,14 +140,14 @@ telemetry API extensions.   *Actor* configurations are packaged in this
 feature.
 
 Usecases Controller (controlloop-usecases)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 It is the *guilin* release implementation of the ONAP use cases.
 It relies on the new *Actor* model framework to carry out a policy's
 execution.
 
 TDJAM Controller (controlloop-tdjam)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This is an experimental, java-only controller that will be deprecated after the
 guilin release.
@@ -715,7 +734,7 @@ Verify in *$POLICY_LOGS/network.log* that a *FINAL: SUCCESS* notification is sen
 and an entry is added to the *$POLICY_LOGS/audit.log* indicating successful completion.
 
 vFirewall use case testing
-===========================
+==========================
 
 First step is to create the *operational.modifyconfig* policy.
 
@@ -784,7 +803,7 @@ Verify that the policy shows with the telemetry tools:
 
 
 dcae.vfw.onset.json
-~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: bash
 
@@ -858,13 +877,14 @@ Running PDP-D Control Loop Application with other components
 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 Control Loop configurations:
 
-* `plans <https://github.com/onap/policy-docker/tree/master/csit/drools-pdp/plans>`__: startup scripts.
-* `tests <https://github.com/onap/policy-docker/tree/master/csit/drools-pdp/tests>`__: test plan.
+* `plans <https://github.com/onap/policy-docker/tree/master/csit/drools-applications/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-applications/tests>`__: test plan.
 
 Additional information
 ======================
 
 For additional information, please see the
-`Drools PDP Development and Testing (In Depth) <https://wiki.onap.org/display/DW/2020+Frankfurt+Tutorials>`__ page.
+`Drools PDP Development and Testing (In Depth) <https://wiki.onap.org/display/DW/2020-08+Frankfurt+Tutorials>`__ page.