From c1e9c2f17ce8a9800e3a8b22068411258989d7ea Mon Sep 17 00:00:00 2001 From: Tony Hansen Date: Wed, 3 Mar 2021 16:32:04 +0000 Subject: Revert "[PMSH] Add doc updates for update sub use case" This reverts commit 6132c206cc4a64df2248647326d569393605cf90. Reason for revert: Container not ready; functionality deferred to I release Issue-ID: DCAEGEN2-2653 Issue-ID: DCAEGEN2-2152 Change-Id: I2ed41ce31d0b4e02e8e8a2faaffaef412d61b6d7 Signed-off-by: Tony Hansen ; --- .../pm-subscription-handler/administration.rst | 25 ------------------ .../pm-subscription-handler/configuration.rst | 30 +++++++++++----------- .../pm-subscription-handler/installation.rst | 6 ++--- .../resources/monitoring-policy.json | 3 --- .../pm-subscription-handler/troubleshooting.rst | 15 ++--------- 5 files changed, 20 insertions(+), 59 deletions(-) delete mode 100644 docs/sections/services/pm-subscription-handler/administration.rst (limited to 'docs') diff --git a/docs/sections/services/pm-subscription-handler/administration.rst b/docs/sections/services/pm-subscription-handler/administration.rst deleted file mode 100644 index 0cac381e..00000000 --- a/docs/sections/services/pm-subscription-handler/administration.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. 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` 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 10b27020..7b8b7211 100644 --- 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 | -+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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. | -+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| 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. | | | | ++---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ **nfFilter** diff --git a/docs/sections/services/pm-subscription-handler/installation.rst b/docs/sections/services/pm-subscription-handler/installation.rst index 4cc0d833..ea55256a 100644 --- a/docs/sections/services/pm-subscription-handler/installation.rst +++ b/docs/sections/services/pm-subscription-handler/installation.rst @@ -6,7 +6,7 @@ Installation ============ -The PMSH microservice can be deployed using the DCAE Dashboard or via CLI. Steps to deploy using CLI will be shown +In Guilin, the PMSH 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 test suite can be run from the local OOM repository. +The robot healthcheck can be run from one of the Kubernetes controllers. .. code-block:: bash @@ -30,7 +30,7 @@ The robot healthcheck test suite can be run from the local OOM repository. Deployment Procedure ^^^^^^^^^^^^^^^^^^^^ -To deploy the PMSH, the monitoring policy needs to be pushed directly to CONSUL. +To deploy the PMSH in the Frankfurt release, 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 3d9dd40a..6b8570e3 100644 --- a/docs/sections/services/pm-subscription-handler/resources/monitoring-policy.json +++ b/docs/sections/services/pm-subscription-handler/resources/monitoring-policy.json @@ -14,9 +14,6 @@ ], "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 1c1a5a89..8fe3034f 100644 --- a/docs/sections/services/pm-subscription-handler/troubleshooting.rst +++ b/docs/sections/services/pm-subscription-handler/troubleshooting.rst @@ -14,21 +14,10 @@ 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 container logs. +see an error connecting to Config Binding Service, by checking the logs in Kibana. 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 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 +invalid configuration. Check Kibana for an incorrect configuration error. -- cgit 1.2.3-korg