summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRam Krishna Verma <ram_krishna.verma@bell.ca>2021-06-10 16:57:14 -0400
committerRam Krishna Verma <ram_krishna.verma@bell.ca>2021-06-10 17:03:10 -0400
commitf4009f0e29a39f4ab0821e6d335de833acf0b0c1 (patch)
treed81d68fe1edbde4f10309f8796af8a6196001976
parent831ecf744cba1172efcd25a5f2fe3b19e4249a18 (diff)
Update drools-pdp documents
* Fixed few broken links * Updated the CSIT links to point to policy/docker * Updated the latest version to Honolulu * Removed legacy operational policy type * Removed frankfurt controller Issue-ID: POLICY-3382 Change-Id: I3eb5d409abc90eb5a52d953051993a3c5f830176 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
-rw-r--r--docs/drools/drools.rst1
-rw-r--r--docs/drools/pdpdApps.rst37
-rw-r--r--docs/drools/pdpdEngine.rst7
3 files changed, 13 insertions, 32 deletions
diff --git a/docs/drools/drools.rst b/docs/drools/drools.rst
index ccbad75a..1bcbda9a 100644
--- a/docs/drools/drools.rst
+++ b/docs/drools/drools.rst
@@ -33,7 +33,6 @@ The PDP-D Engine hosts applications by means of *controllers*.
types supported by the *Control Loop* applications are:
- onap.policies.controlloop.operational.common.Drools
-- onap.policies.controlloop.Operational
**PDP-D Applications**
diff --git a/docs/drools/pdpdApps.rst b/docs/drools/pdpdApps.rst
index afb246ea..a9a0b9fc 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,9 +44,9 @@ 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.
@@ -74,24 +73,16 @@ 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 <https://git.onap.org/policy/models/tree/models-examples/src/main/resources/policytypes/onap.policies.controlloop.Operational.yaml>`__.
-
The Tosca Compliant Operational Policy Type is defined at the
`onap.policies.controlloop.operational.common.Drools <https://git.onap.org/policy/models/tree/models-examples/src/main/resources/policytypes/onap.policies.controlloop.operational.common.Drools.yaml>`__.
-An example of a Legacy Operational Policy can be found
-`here <https://git.onap.org/policy/models/tree/models-examples/src/main/resources/policies/vDNS.policy.operational.legacy.input.json>`__.
-
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>`__.
@@ -112,7 +103,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.
@@ -137,12 +127,6 @@ 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)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -157,7 +141,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 +150,7 @@ An offline configuration requires two configuration items:
- *OFFLINE* environment variable set to true (see `values.yaml <https://git.onap.org/oom/tree/kubernetes/policy/values.yaml>`__.
- override of the default *settings.xml* (see
- `settings.xml <https://git.onap.org/oom/tree/kubernetes/policy/charts/drools/resources/configmaps/settings.xml>`__) override.
+ `settings.xml <https://git.onap.org/oom/tree/kubernetes/policy/components/policy-drools-pdp/resources/configmaps/settings.xml>`__) override.
Running the PDP-D Control Loop Application in a single container
================================================================
@@ -871,12 +855,11 @@ 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 <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 Control Loop configurations:
-* `plans <https://git.onap.org/integration/csit/tree/plans/policy/drools-applications>`__: startup scripts.
-* `scripts <https://git.onap.org/integration/csit/tree/scripts/policy/drools-apps/docker-compose-drools-apps.yml>`__: docker-compose and related files.
-* `plans <https://git.onap.org/integration/csit/tree/tests/policy/drools-applications>`__: test plan.
+* `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.
Additional information
======================
diff --git a/docs/drools/pdpdEngine.rst b/docs/drools/pdpdEngine.rst
index d19eac15..d9902904 100644
--- 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.
-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
=======================
@@ -438,7 +438,6 @@ 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*.