X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdrools%2FpdpdEngine.rst;h=6992a8ed4cda0dca27223bdf450432aa4df769fc;hb=688a2dd3a681c28ac48ad737316c2dc1dff08526;hp=3456cc6d45e18bb3e4a6be88529287f684292c27;hpb=108dd8ff62cbdfbbe1ba3589afe43582105ea275;p=policy%2Fparent.git diff --git a/docs/drools/pdpdEngine.rst b/docs/drools/pdpdEngine.rst index 3456cc6d..6992a8ed 100644 --- a/docs/drools/pdpdEngine.rst +++ b/docs/drools/pdpdEngine.rst @@ -40,11 +40,11 @@ Docker Image ~~~~~~~~~~~~ Check the *drools-pdp* `released 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 - 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. @@ -60,7 +60,7 @@ The following command can be used to explore the directory layout. .. 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 ======================= @@ -216,27 +216,27 @@ Controllers defined in *-controller.properties* files. For example, see the -`frankfurt controller configuration `__. +`usecases controller configuration `__. 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 - controller.name=frankfurt + controller.name=usecases rules.groupId=${project.groupId} - rules.artifactId=controller-frankfurt + rules.artifactId=controller-usecases rules.version=${project.version} ..... This *kjar* contains the -`frankfurt DRL `__ file (there may be more than one DRL file included). +`usecases DRL `__ file (there may be more than one DRL file included). .. code-block:: bash @@ -256,7 +256,7 @@ This *kjar* contains the ... The DRL in conjuction with the dependent java libraries in the kjar -`pom `__ +`pom `__ 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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 @@ -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* -- *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*. -One such controller is the *frankfurt* controller residing in the +One such controller is the *usecases* controller residing in the `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*. -For example, the *frankfurt controller* packages this information in the -`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 `__. 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 @@ -469,12 +468,12 @@ commit to execute policies against these policy types if a supporting controller - + Software Architecture -====================== +===================== PDP-D is divided into 2 layers: @@ -783,6 +782,7 @@ unnecessary or have not been thoroughly tested: feature_sesspersist.rst feature_statemgmt.rst feature_testtransaction.rst + feature_nolocking.rst 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 -For example in the official frankfurt delivery: +For example in the official guilin delivery: .. code-block:: bash @@ -872,7 +872,7 @@ The drools libraries in the PDP-D uses maven to fetch rules artifacts and softwa The default *settings.xml* file specifies the repositories to search. This configuration can be overriden with a custom copy that would sit in a mounted configuration directory. See an example of the OOM override -`settings.xml `__. +`settings.xml `_. The default ONAP installation of the *control loop* child image *onap/policy-pdpd-cl:1.6.4* is *OFFLINE*. In this configuration, the *rules* artifact and the *dependencies* retrieves all the artifacts from the local @@ -883,7 +883,7 @@ An offline configuration requires two items: - *OFFLINE* environment variable set to true. - override *settings.xml* customization, see - `settings.xml `__. + `settings.xml `_. The default mode in the *onap/policy-drools:1.6.3* is ONLINE instead. @@ -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-frankfurt 1.6.4 enabled - controlloop-usecases 1.6.4 disabled + controlloop-usecases 1.6.4 enabled [migration] pooling: OK @ 1811 @@ -993,7 +992,7 @@ Telemetry Shell Server: Jetty(9.4.24.v20191120) [ - "frankfurt" + "usecases" ] https://localhost:9696/policy/pdp/engine> exit @@ -1358,7 +1357,7 @@ A post-start script *config/active.post.sh* can place PDP-D in *active* mode at .. code-block:: bash - bash -c "http --verify=no -a ${TELEMETRY_USER}:${TELEMETRY_PASSWORD} PUT https://localhost:9696/policy/pdp/engine/lifecycle/state/ACTIVE" + bash -c "http --verify=no -a ${TELEMETRY_USER}:${TELEMETRY_PASSWORD} PUT ://localhost:9696/policy/pdp/engine/lifecycle/state/ACTIVE" Bring up the PDP-D, nexus, and mariadb ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1378,22 +1377,22 @@ To take it down: Other examples ~~~~~~~~~~~~~~ -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 configurations: -* `plans `__: startup scripts. -* `scripts `__: docker-compose related files. -* `plans `__: test plan. +* `plans `__: startup & teardown scripts. +* `scripts `__: docker-compose file. +* `tests `__: test plan. Configuring the PDP-D in an OOM Kubernetes installation ======================================================= -The `PDP-D OOM chart `__ can be +The `PDP-D OOM chart `__ can be customized at the following locations: -* `values.yaml `__: custom values for your installation. -* `configmaps `__: place in this directory any configuration extensions or overrides to customize the PDP-D that does not contain sensitive information. -* `secrets `__: place in this directory any configuration extensions or overrides to customize the PDP-D that does contain sensitive information. +* `values.yaml `__: custom values for your installation. +* `configmaps `__: place in this directory any configuration extensions or overrides to customize the PDP-D that does not contain sensitive information. +* `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. @@ -1402,4 +1401,4 @@ Additional information ====================== For additional information, please see the -`Drools PDP Development and Testing (In Depth) `__ page. +`Drools PDP Development and Testing (In Depth) `__ page.