X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdrools%2FpdpdApps.rst;h=5ef0a3fc16207b8d9b8cf11fecdf507075a5897a;hb=ce601f27a0c8f2cb969d2ba2c3a5e21990b46287;hp=afb246ea8e863621989b348a70df58a7f0d17393;hpb=ae9582c44f6032ff6504bdc5b773f598b1b5ef90;p=policy%2Fparent.git diff --git a/docs/drools/pdpdApps.rst b/docs/drools/pdpdApps.rst index afb246ea..5ef0a3fc 100644 --- a/docs/drools/pdpdApps.rst +++ b/docs/drools/pdpdApps.rst @@ -18,9 +18,8 @@ See :ref:`pdpd-engine-label` for the description of the PDP-D infrastructure. At this time *Control Loops* are the only type of applications supported. -*Control Loop* applications must support at least one of the following *Policy Types*: +*Control Loop* applications must support the following *Policy Type*: -- **onap.policies.controlloop.Operational** (Operational Policies for Legacy Control Loops) - **onap.policies.controlloop.operational.common.Drools** (Tosca Compliant Operational Policies) Software @@ -45,15 +44,15 @@ for the latest images: .. code-block:: bash - docker pull onap/policy-pdpd-cl:1.6.4 + docker pull onap/policy-pdpd-cl:1.8.2 -At the time of this writing *1.6.4* is the latest version. +At the time of this writing *1.8.2* is the latest version. 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 `__ controller is the *control loop* application in ONAP. @@ -74,27 +73,38 @@ components, part of a control loop transaction. The reader is referred to the Operational Policy Types ======================== -The *usecases* controller supports the two Operational policy types: +The *usecases* controller supports the following policy type: -- *onap.policies.controlloop.Operational*. - *onap.policies.controlloop.operational.common.Drools*. -The *onap.policies.controlloop.Operational* is the legacy operational type, used before -the *frankfurt* release. The *onap.policies.controlloop.operational.common.Drools* +The *onap.policies.controlloop.operational.common.Drools* is the Tosca compliant policy type introduced in *frankfurt*. -The legacy operational policy type is defined at the -`onap.policies.controlloop.Operational.yaml `__. - The Tosca Compliant Operational Policy Type is defined at the `onap.policies.controlloop.operational.common.Drools `__. -An example of a Legacy Operational Policy can be found -`here `__. - An example of a Tosca Compliant Operational Policy can be found `here `__. +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 `__. + +An example of policy chaining for PNF can be found +`here `__. + Features ======== @@ -112,7 +122,6 @@ The enabled features in the *onap/policy-pdpd-cl* image are: The following features are installed but disabled: -- **controlloop-frankfurt**: *controller* used in the frankfurt release. - **controlloop-tdjam**: experimental java-only *controller* to be deprecated post guilin. - **controlloop-utils**: *actor* simulators. @@ -131,20 +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. -Frankfurt Controller (controlloop-frankfurt) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This is the frankfurt controller that will be deprecated after the -guilin release. - TDJAM Controller (controlloop-tdjam) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is an experimental, java-only controller that will be deprecated after the guilin release. @@ -157,7 +160,7 @@ Enables *actor simulators* for testing purposes. Offline Mode ============ -The default ONAP installation in *onap/policy-pdpd-cl:1.6.4* is *OFFLINE*. +The default ONAP installation in *onap/policy-pdpd-cl:1.8.2* is *OFFLINE*. In this configuration, the *rules* artifact and the *dependencies* are all in the local maven repository. This requires that the maven dependencies are preloaded in the local repository. @@ -166,7 +169,7 @@ An offline configuration requires two configuration items: - *OFFLINE* environment variable set to true (see `values.yaml `__. - override of the default *settings.xml* (see - `settings.xml `__) override. + `settings.xml `__) override. Running the PDP-D Control Loop Application in a single container ================================================================ @@ -731,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. @@ -800,7 +803,7 @@ Verify that the policy shows with the telemetry tools: dcae.vfw.onset.json -~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~ .. code-block:: bash @@ -871,17 +874,17 @@ and an entry is added to the *$POLICY_LOGS/audit.log* indicating successful comp Running PDP-D Control Loop Application with other components ============================================================ -The reader can also look at the `integration/csit repository `__. +The reader can also look at the `policy/docker repository `__. More specifically, these directories have examples of other PDP-D Control Loop configurations: -* `plans `__: startup scripts. -* `scripts `__: docker-compose and related files. -* `plans `__: test plan. +* `plans `__: startup & teardown scripts. +* `scripts `__: docker-compose file. +* `tests `__: test plan. Additional information ====================== For additional information, please see the -`Drools PDP Development and Testing (In Depth) `__ page. +`Drools PDP Development and Testing (In Depth) `__ page.