[PMSH] Add doc updates for update sub use case

Signed-off-by: efiacor <fiachra.corcoran@est.tech>
Change-Id: Ibdaf35b844e0dff1fc035173888ab06dcf4e2dd4
Issue-ID: DCAEGEN2-2152

diff --git a/docs/sections/services/pm-subscription-handler/administration.rst b/docs/sections/services/pm-subscription-handler/administration.rst
new file mode 100644 (file)
index 0000000..0cac381
--- /dev/null
+++ b/docs/sections/services/pm-subscription-handler/administration.rst
@@ -0,0 +1,25 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Administration
+==============
+PMSH has a healthcheck functionality. One can also check the liveliness of the service.
+
+Updating a Subscription
+"""""""""""""""""""""""
+Current functionality does not support updating an active (UNLOCKED) subscription at runtime.
+To update a subscription:
+
+- transition the administrativeState from UNLOCKED to LOCKED
+
+This will attempt to remove any active/running subscriptions from the relevant NFs and set the administrativeState to "LOCKING".
+Monitor the administrativeState via the /subscriptions api endpoint until it has fully LOCKED.
+
+- update the relevant fields of the subscription object
+
+See :ref:`Subscription configuration<Subscription>` for details.
+All subscription fields except the subscriptionName can be updated.
+
+- transition the administrativeState from LOCKED to UNLOCKED
+
+This will attempt to create the updated subscription on the relevant NFs.
\ No newline at end of file

diff --git a/docs/sections/services/pm-subscription-handler/configuration.rst b/docs/sections/services/pm-subscription-handler/configuration.rst
index 7b8b721..10b2702 100644 (file)
--- a/docs/sections/services/pm-subscription-handler/configuration.rst
+++ b/docs/sections/services/pm-subscription-handler/configuration.rst
@@ -116,21 +116,21 @@ 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                                                                                                                                                                |
++---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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 in minutes.                                                                                                               |
++---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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.                                                                                                                                          |
++---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 **nfFilter**
 

diff --git a/docs/sections/services/pm-subscription-handler/installation.rst b/docs/sections/services/pm-subscription-handler/installation.rst
index ea55256..4cc0d83 100644 (file)
--- a/docs/sections/services/pm-subscription-handler/installation.rst
+++ b/docs/sections/services/pm-subscription-handler/installation.rst
@@ -6,7 +6,7 @@
 Installation
 ============
 
-In Guilin, the PMSH can be deployed using the DCAE Dashboard or via CLI. Steps to deploy using CLI will be shown
+The PMSH microservice can be deployed using the DCAE Dashboard or via CLI. Steps to deploy using CLI will be shown
 below.
 
 Deployment Prerequisites
@@ -21,7 +21,7 @@ As well as this, the following components are required to be running. They can b
     - A&AI
     - AAF
 
-The robot healthcheck can be run from one of the Kubernetes controllers.
+The robot healthcheck test suite can be run from the local OOM repository.
 
 .. code-block:: bash
 
@@ -30,7 +30,7 @@ The robot healthcheck can be run from one of the Kubernetes controllers.
 Deployment Procedure
 ^^^^^^^^^^^^^^^^^^^^
 
-To deploy the PMSH in the Frankfurt release, the monitoring policy needs to be pushed directly to CONSUL.
+To deploy the PMSH, the monitoring policy needs to be pushed directly to CONSUL.
 To begin, kubectl exec on to the dcae-bootstrap pod and move to the /tmp directory.
 
 .. code-block:: bash

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 6b8570e..3d9dd40 100644 (file)
--- a/docs/sections/services/pm-subscription-handler/resources/monitoring-policy.json
+++ b/docs/sections/services/pm-subscription-handler/resources/monitoring-policy.json
@@ -14,6 +14,9 @@
          ],
          "modelVersionIDs":[
             "e80a6ae3-cafd-4d24-850d-e14c084a5ca9"
+         ],
+         "modelNames": [
+            "PnfSVC"
          ]
       },
       "measurementGroups":[

diff --git a/docs/sections/services/pm-subscription-handler/troubleshooting.rst b/docs/sections/services/pm-subscription-handler/troubleshooting.rst
index 8fe3034..1c1a5a8 100644 (file)
--- a/docs/sections/services/pm-subscription-handler/troubleshooting.rst
+++ b/docs/sections/services/pm-subscription-handler/troubleshooting.rst
@@ -14,10 +14,21 @@ Unable to connect to Config Binding Service
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The PMSH may not be able to reach the Config Binding Service. If this is the case you will be able to
-see an error connecting to Config Binding Service, by checking the logs in Kibana.
+see an error connecting to Config Binding Service, by checking the container logs.
 
 Invalid Configuration
 ^^^^^^^^^^^^^^^^^^^^^
 
 If the PMSH is able to connect to Config Binding Service, but is failing to start. It may be due to
-invalid configuration. Check Kibana for an incorrect configuration error.
+invalid configuration. Check the container logs for an incorrect configuration error.
+
+Failure to create/delete Subscription
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If an error occurs when UN/LOCKING the administrativeState of the subscription, this may be due to a failure
+in one of the following ONAP services/applications. Check the logs of each to debug the issue.
+
+- dmaap-message-router
+- policy-apex-pdp
+- cds-blueprints-processor
+- sdnc