aboutsummaryrefslogtreecommitdiffstats
path: root/docs/design/design.rst
diff options
context:
space:
mode:
authorPamela Dragosh <pdragosh@research.att.com>2020-04-14 12:24:26 +0000
committerGerrit Code Review <gerrit@onap.org>2020-04-14 12:24:26 +0000
commit94fae9ace91dd0a6611ad163989f027dffe7a758 (patch)
treed2342d46013910f8692199b844d1908ced0918e7 /docs/design/design.rst
parent9cba11c42a7a4a88f29db31286955082e099b91e (diff)
parent89ba0977d65284ffabe3a55c21bb522e78322587 (diff)
Merge "Outline PDP-D new policy types in design doc."
Diffstat (limited to 'docs/design/design.rst')
-rw-r--r--docs/design/design.rst56
1 files changed, 46 insertions, 10 deletions
diff --git a/docs/design/design.rst b/docs/design/design.rst
index 6f328940..190758ce 100644
--- a/docs/design/design.rst
+++ b/docs/design/design.rst
@@ -58,16 +58,20 @@ integration of *PolicyTypeImpl* implementation is outside the scope of the ONAP
TheĀ *PolicyType* definitions and implementations listed below are preloaded and are always available for use in the
Policy Framework.
-====================================== ===============================================================================
-**Policy Type** **Description**
-====================================== ===============================================================================
-onap.policies.Monitoring Overarching model that supports Policy driven DCAE microservice components used
- in a Control Loops
-onap.policies.controlloop.Operational Used to support actor/action operational policies for control loops
-onap.policies.controlloop.Guard Control Loop guard policies for policing control loops
-onap.policies.controlloop.Coordination Control Loop Coordination policies to assist in coordinating multiple control
- loops at runtime
-====================================== ===============================================================================
+======================================= ===============================================================================
+**Policy Type** **Description**
+======================================= ===============================================================================
+onap.policies.Monitoring Overarching model that supports Policy driven DCAE microservice components used
+ in Control Loops
+onap.policies.controlloop.Operational Used to support legacy actor/action operational policies for control loops
+onap.policies.controlloop.Guard Control Loop guard policies for policing control loops
+onap.policies.controlloop.Coordination Control Loop Coordination policies to assist in coordinating multiple control
+ loops at runtime
+onap.policies.controlloop.common.Drools Used to support tosca compliant actor/action operational policies for control
+ loops
+onap.policies.native.drools.Controller Used to support the definition of PDP-D controllers
+onap.policies.native.drools.Artifact Used to associate application's software with a PDP-D controller
+======================================= ===============================================================================
2.1 Policy Type: onap.policies.Monitoring
-----------------------------------------
@@ -213,6 +217,38 @@ Guard policy type definitions for *FrequencyLimiter*, *BlackList*, and *MinMax*
policy-models gerrit repository
<https://github.com/onap/policy-models/tree/master/models-examples/src/main/resources/policytypes>`__.
+2.4 Policy Type: onap.policies.controlloop.common.Drools
+--------------------------------------------------------
+
+This policy type supports composition of Tosca-compliant Operational Policies for the PDP-D. The
+`onap.policies.controlloop.common.Drools policy type specification
+<https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.operational.common.Drools.yaml>`__ is preferred for composition of operational
+policies over its `onap.policies.controlloop.Operational policy type specification
+<https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.Operational.yaml>`__ precursor, which eventually will be deprecated.
+Both policy types are functionally equivalent.
+
+2.5 Policy Type: onap.policies.native.drools.Controller
+-------------------------------------------------------
+
+This policy type supports creation of native PDP-D controllers via policy. A controller is an abstraction on
+the PDP-D that groups communication channels, message mapping rules, and
+any other arbitrary configuration data to realize an application.
+
+Policies of this type are composed against the
+`onap.policies.native.drools.Controller policy type specification
+<https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.native.Drools.yaml>`__ specification.
+
+2.6 Policy Type: onap.policies.native.drools.Artifact
+-------------------------------------------------------
+
+This policy type supports the dynamic association of a native PDP-D controller with rules and dependent
+java libraries. This policy type is used in conjuction with the onap.policies.native.drools.Controller
+type to create or upgrade a drools application on a live PDP-D.
+
+Policies of this type are composed against the
+`onap.policies.native.drools.Controller policy type specification
+<https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.native.Drools.yaml>`__ specification.
+
3 PDP Deployment and Registration with PAP
==========================================