diff options
| author |   Pamela Dragosh <pdragosh@research.att.com> | 2019-12-05 20:29:10 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2019-12-05 20:29:10 +0000 |
| commit | af750ec94b742808e724b628d1b18a98c95de2fb (patch) | |
| tree | 32f507b8726ed40f7fb0f9ef462e94b4127b3799 | |
| parent | 0278ad6b5bd93531493596d6d671293a5112bf3c (diff) | |
| parent | 3c711d14e242c18a9d58215224fd40374f7018e6 (diff) | |
Merge "Document PAP policy notifications"
| -rw-r--r-- | docs/design/design.rst | 6 | ||||
| -rw-r--r-- | docs/pap/notification/dmaap-pap-notif.json | 23 | ||||
| -rw-r--r-- | docs/pap/pap.rst | 8 |
3 files changed, 34 insertions, 3 deletions
diff --git a/docs/design/design.rst b/docs/design/design.rst index 84beb9e1..6f328940 100644 --- a/docs/design/design.rst +++ b/docs/design/design.rst @@ -396,9 +396,9 @@ pdp_subgroups R M N/A A list of PDP subgroups ->pdp_type R M N/A The PDP type of this PDP subgroup, currently xacml, drools, or apex ->supported_policy_types R N/A N/A A list of the policy types supported by the PDPs in this PDP - subgroup. A trailing “.*” can be used to specify multiple - policy types; for example, “onap.policies.monitoring.*” - would match any policy type beginning with + subgroup. A trailing “.*” can be used to specify multiple + policy types; for example, “onap.policies.monitoring.*” + would match any policy type beginning with “onap.policies.monitoring.” ->policies R M N/A The list of policies running on the PDPs in this PDP subgroup ->->(name) R M N/A The name of a TOSCA policy running in this PDP subgroup diff --git a/docs/pap/notification/dmaap-pap-notif.json b/docs/pap/notification/dmaap-pap-notif.json new file mode 100644 index 00000000..bfe9162b --- /dev/null +++ b/docs/pap/notification/dmaap-pap-notif.json @@ -0,0 +1,23 @@ +{ + "deployed-policies": [ + { + "policy-type": "onap.policies.monitoring.cdap.tca.hi.lo.app", + "policy-type-version": "1.0.0", + "policy-id": "onap.scaleout.tca", + "policy-version": "2.0.0", + "success-count": 3, + "failure-count": 0 + } + ], + "undeployed-policies": [ + { + "policy-type": "onap.policies.firewall", + "policy-type-version": "1.0.0", + "policy-id": "onap.firewall.tca", + "policy-version": "6.0.0", + "success-count": 3, + "failure-count": 0 + } + ] +} + diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst index 97bcb825..d061c815 100644 --- a/docs/pap/pap.rst +++ b/docs/pap/pap.rst @@ -81,6 +81,14 @@ in the following table are transmitted via DMaaP: "PDP update", "Outgoing", "Assigns a PDP to a PDP Group and Subgroup; also deploys or undeploys policies from the PDP" "PDP state change", "Outgoing", "Changes the state of a PDP or all PDPs within a PDP Group or Subgroup" +In addition, PAP generates notifications via the DMaaP Message Router when policies are successfully or unsuccessfully +deployed (or undeployed) from all relevant PDPs. + +Here is a sample notification: + +.. literalinclude:: notification/dmaap-pap-notif.json + :language: json + 2 PAP REST API Swagger ====================== |