Merge "[DCAEGEN2] PMSH Policy impact doc updates."

2 files changed, 83 insertions, 76 deletions

diff --git a/docs/sections/services/pm-subscription-handler/configuration.rst b/docs/sections/services/pm-subscription-handler/configuration.rst
index 7b8b7211..0be8b61f 100644
--- a/docs/sections/services/pm-subscription-handler/configuration.rst
+++ b/docs/sections/services/pm-subscription-handler/configuration.rst
@@ -21,10 +21,6 @@ specified in the dashboard deployment GUI.
 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+
 | replicas                    | Number of instances.                                                                   | integer | True     | 1                                                                                   |
 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+
-| operational_policy_name     | Name of the operational policy to be executed.                                         | string  | True     | pmsh-operational-policy                                                             |
-+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+
-| control_loop_name           | Name of the control loop.                                                              | string  | True     | pmsh-control-loop                                                                   |
-+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+
 | pm_publish_topic_name       | The topic that PMSH will publish to, and which policy will subscribe to.               | string  | True     | unauthenticated.DCAE_CL_OUTPUT                                                      |
 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+
 | policy_feedback_topic_name  | The topic that PMSH will subscribe to, and which policy will publish to.               | string  | True     | unauthenticated.PMSH_CL_INPUT                                                       |
@@ -66,9 +62,8 @@ The subscription is configured within the monitoring policy. The subscription mo
     {
        "subscription":{
           "subscriptionName":"someExtraPM-All-gNB-R2B",
-          "administrativeState":"UNLOCKED",
-          "fileBasedGP":15,
-          "fileLocation":"/pm/pm.xml",
+          "operationalPolicyName":"operational-policy-name",
+          "controlLoopName":"controlLoop-name",
           "nfFilter":{
              "nfNames":[
                 "^pnf1.*"
@@ -87,6 +82,10 @@ The subscription is configured within the monitoring policy. The subscription mo
           "measurementGroups":[
              {
                 "measurementGroup":{
+                   "measurementGroupName":"msgroupname",
+                   "administrativeState":"UNLOCKED",
+                   "fileBasedGP":15,
+                   "fileLocation":"/pm/pm.xml",
                    "measurementTypes":[
                       {
                          "measurementType":"EutranCell.*"
@@ -116,21 +115,24 @@ The subscription is configured within the monitoring policy. The subscription mo
     }
 
 
-+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
-| Field               | Description                                                                                                                                                                | Type | Required | Values |
-+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
-| subscriptionName    | Name of the subscription.                                                                                                                                                  |      |          |        |
-+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
-| administrativeState | Setting a subscription to UNLOCKED will apply the subscription to the NF instances immediately. If it is set to LOCKED, it will not be applied until it is later unlocked. |      |          |        |
-+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
-| fileBasedGP         | The frequency at which measurements are produced.                                                                                                                          |      |          |        |
-+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
-| fileLocation        | Location of Report Output Period file.                                                                                                                                     |      |          |        |
-+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
-| nfFilter            | The network function filter will be used to filter the list of nf's stored in A&AI to produce a subset.                                                                    |      |          |        |
-+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
-| measurementGroups   | List containing measurementGroup.                                                                                                                                          |      |          |        |
-+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
++-----------------------+---------------------------------------------------------------------------------------------------------+--------+----------+--------------------------+
+| Field                 | Description                                                                                             | Type   | Required | Values                   |
++-----------------------+---------------------------------------------------------------------------------------------------------+--------+----------+--------------------------+
+| subscriptionName      | Name of the subscription.                                                                               | string | True     | subscriptionName         |
++-----------------------+---------------------------------------------------------------------------------------------------------+--------+----------+--------------------------+
+| operationalPolicyName | Name of the operational policy to be executed.                                                          | string | True     | operationalPolicyName    |
++-----------------------+---------------------------------------------------------------------------------------------------------+--------+----------+--------------------------+
+| controlLoopName       | Name of the control loop.                                                                               | string | True     | controlLoopName          |
++-----------------------+---------------------------------------------------------------------------------------------------------+--------+----------+--------------------------+
+| nfFilter              | The network function filter will be used to filter the list of nf's stored in A&AI to produce a subset. |  list  | False    |                          |
++-----------------------+---------------------------------------------------------------------------------------------------------+--------+----------+--------------------------+
+| measurementGroups     | List containing measurementGroup.                                                                       |  list  | True     | List of measurementGroup |
++-----------------------+---------------------------------------------------------------------------------------------------------+--------+----------+--------------------------+
+
+.. note::
+  Since release Istanbul of ONAP, PMSH Subscriptions model schema is updated.
+  Subscription model is centric to ``measurementGroup``, for instance any update on attributes administrativeState, fileBasedGP,
+  fileLocation, nfFilter will be applicable to only individual measurementGroup object.
 
 **nfFilter**
 
@@ -176,6 +178,10 @@ least 1 must be present for the filter to work.
 .. code-block:: json
 
     "measurementGroup": {
+       "measurementGroupName":"msgroupname",
+       "administrativeState":"UNLOCKED",
+       "fileBasedGP":15,
+       "fileLocation":"/pm/pm.xml",
        "measurementTypes": [
          {
            "measurementType": "EutranCell.*"
@@ -200,13 +206,21 @@ least 1 must be present for the filter to work.
        ]
     }
 
-+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+
-| Field                 | Description                                                                                                                                       | Type | Required |
-+=======================+===================================================================================================================================================+======+==========+
-| measurementTypes      | List of measurement types. These are regexes, and it is expected that either the CDS blueprint, or NF can parse them. As the PMSH will not do so. | list | True     |
-+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+
-| managedObjectDNsBasic | List of managed object distinguished names.                                                                                                       | list | True     |
-+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+
++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
+| Field                 | Description                                                                                                                                                                            | Type | Required | Values |
++=======================+========================================================================================================================================================================================+======+==========+========+
+| measurementGroupName  | Unique identifier for measurementGroup.                                                                                                                                                |      |          |        |
++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
+| administrativeState   | Setting a measurementGroup to UNLOCKED will apply the subscription changes to the NF instances immediately. If it is set to LOCKED, it will not be applied until it is later unlocked. |      |          |        |
++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
+| fileBasedGP           | The frequency at which measurements are produced.                                                                                                                                      |      |          |        |
++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
+| fileLocation          | Location of Report Output Period file.                                                                                                                                                 |      |          |        |
++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
+| measurementTypes      | List of measurement types. These are regexes, and it is expected that either the CDS blueprint, or NF can parse them. As the PMSH will not do so.                                      | list | True     |        |
++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
+| managedObjectDNsBasic | List of managed object distinguished names.                                                                                                                                            | list | True     |        |
++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 
 .. _Topics:
 
@@ -242,6 +256,7 @@ Example of successful CREATE event sent from policy:
         "version": "0.0.1",
         "status": {
             "subscriptionName": "subscriptiona",
+            "measurementGroupName":"msgroupname",
             "nfName": "PNF104",
             "changeType": "CREATE",
             "message": "success"
@@ -261,6 +276,11 @@ Publisher:
 PMSH publishes subscriptions to this topic. They will be consumed by an operational policy which will make a request to CDS to
 change the state of the subscription.
 
+.. note::
+  Since release Istanbul of ONAP, PMSH Publish Subscriptions event format is updated.
+  A new attribute ``measurementGroupName`` is added as a unique identifier for ``measurementGroup`` and a single ``measurementGroup`` is associated with
+  PMSH Subscription event.
+
 Example event sent from PMSH:
 
 .. code-block:: json
@@ -268,8 +288,8 @@ Example event sent from PMSH:
     {
        "nfName":"PNF104",
        "ipv4Address": "10.12.13.12",
-       "policyName":"pmsh-operational-policy",
-       "closedLoopControlName":"pmsh-control-loop",
+       "policyName":"operational-policy-name",
+       "closedLoopControlName":"controlLoop-name",
        "blueprintName":"pm_control",
        "blueprintVersion":"1.2.4",
        "changeType":"CREATE",
@@ -278,47 +298,24 @@ Example event sent from PMSH:
           "subscriptionName":"subscriptiona",
           "fileBasedGP":15,
           "fileLocation":"/pm/pm.xml",
-          "measurementGroups":[
-             {
-                "measurementGroup":{
-                   "measurementTypes":[
-                      {
-                         "measurementType":"countera"
-                      },
-                      {
-                         "measurementType":"counterb"
-                      }
-                   ],
-                   "managedObjectDNsBasic":[
-                      {
-                         "DN":"dna"
-                      },
-                      {
-                         "DN":"dnb"
-                      }
-                   ]
+          "measurementGroup":{
+             "measurementGroupName":"msgroupname",
+             "measurementTypes":[
+                {
+                   "measurementType":"countera"
+                },
+                {
+                   "measurementType":"counterb"
                 }
-             },
-             {
-                "measurementGroup":{
-                   "measurementTypes":[
-                      {
-                         "measurementType":"counterc"
-                      },
-                      {
-                         "measurementType":"counterd"
-                      }
-                   ],
-                   "managedObjectDNsBasic":[
-                      {
-                         "DN":"dnc"
-                      },
-                      {
-                         "DN":"dnd"
-                      }
-                   ]
+             ],
+             "managedObjectDNsBasic":[
+                {
+                   "DN":"dna"
+                },
+                {
+                   "DN":"dnb"
                 }
-             }
-          ]
+             ]
+          }
        }
-    }
+    }
\ No newline at end of file
diff --git a/docs/sections/services/pm-subscription-handler/resources/monitoring-policy.json b/docs/sections/services/pm-subscription-handler/resources/monitoring-policy.json
index 6b8570e3..f142f8b4 100644
--- a/docs/sections/services/pm-subscription-handler/resources/monitoring-policy.json
+++ b/docs/sections/services/pm-subscription-handler/resources/monitoring-policy.json
@@ -1,9 +1,8 @@
 {
    "subscription":{
-      "subscriptionName":"subscriptiona",
-      "administrativeState":"UNLOCKED",
-      "fileBasedGP":15,
-      "fileLocation":"/pm/pm.xml",
+      "subscriptionName":"subscription-name",
+      "operationalPolicyName":"operational-policy-name",
+      "controlLoopName":"controlLoop-name",
       "nfFilter":{
          "nfNames":[
             "^pnf1.*"
@@ -14,11 +13,18 @@
          ],
          "modelVersionIDs":[
             "e80a6ae3-cafd-4d24-850d-e14c084a5ca9"
+         ],
+         "modelNames":[
+            "pnf102"
          ]
       },
       "measurementGroups":[
          {
             "measurementGroup":{
+               "measurementGroupName":"msgroupnamea",
+               "administrativeState":"UNLOCKED",
+               "fileBasedGP":15,
+               "fileLocation":"/pm/pma.xml",
                "measurementTypes":[
                   {
                      "measurementType":"countera"
@@ -39,6 +45,10 @@
          },
          {
             "measurementGroup":{
+               "measurementGroupName":"msgroupnameb",
+               "administrativeState":"UNLOCKED",
+               "fileBasedGP":15,
+               "fileLocation":"/pm/pmb.xml",
                "measurementTypes":[
                   {
                      "measurementType":"counterc"