diff options
Diffstat (limited to 'docs/sections/services/pm-subscription-handler/overview.rst')
| -rw-r--r-- | docs/sections/services/pm-subscription-handler/overview.rst | 46 |
1 files changed, 33 insertions, 13 deletions
diff --git a/docs/sections/services/pm-subscription-handler/overview.rst b/docs/sections/services/pm-subscription-handler/overview.rst index f520329f..82331660 100644 --- a/docs/sections/services/pm-subscription-handler/overview.rst +++ b/docs/sections/services/pm-subscription-handler/overview.rst @@ -8,17 +8,18 @@ Overview Introduction """""""""""" -The PM Subscription Handler (PMSH) is a micro service written in Python, which allows for the definition and activation +The PM Subscription Handler (PMSH) is a Python based micro service, which allows for the definition and activation of PM subscriptions on one or more network function (NF) instances. -.. _Delivery: ./delivery.html Functionality """"""""""""" -The PMSH allows for the definition of subscriptions on a network level, which enables the configuration of PM data on a -set of NF instances. During creation of a subscription, PM reporting configuration and a network function filter will -be defined. This filter will then be used to produce a subset of NF's to which the subscription will be applied. If -a NF matching the filter is registered in ONAP after the microservice has been deployed, the subscription will +PMSH allows for the definition of subscriptions on a network level, which enables the configuration of PM data on a +set of NF instances. +During creation of a subscription, PM reporting configuration and a network function filter will be defined. +This filter will then be used to produce a subset of NF's to which the subscription will be applied. +The NF's in question must have an Active orchestration-status in A&AI. +If an NF matching the filter is registered in ONAP after the microservice has been deployed, the subscription will be applied to that NF. Interaction @@ -27,23 +28,42 @@ Interaction Config Binding Service ^^^^^^^^^^^^^^^^^^^^^^ -The PMSH interacts with the Config Binding Service to retrieve it's configuration information, including the +PMSH interacts with the Config Binding Service to retrieve it's configuration information, including the subscription information. DMaaP ^^^^^ -The PMSH subscribes and publishes to various DMaaP Message Router topics (See :ref:`Topics<Topics>` +PMSH subscribes and publishes to various DMaaP Message Router topics (See :ref:`Topics<Topics>` for more information on which topics are used). A&AI ^^^^ -The PMSH interacts with A&AI to fetch data about network functions. The ``nfFilter`` is then +PMSH interacts with A&AI to fetch data about network functions. The ``nfFilter`` is then applied to this data to produce a targeted subset of NF's. -Policy and CDS -^^^^^^^^^^^^^^ +Policy +^^^^^^ -The PMSH will indirectly interact with Policy and CDS in order to push subscriptions to NF's. A policy will be used to -make a request to CDS, which will apply the subscription to the NF. +PMSH interacts indirectly with Policy via DMaaP Message Router to trigger an action on an operational policy defined +by the operator. The operational policy must align with the inputs provided in the event sent from PMSH. + +CDS +^^^ +The operational policy will be used to make a request to CDS, which will apply/remove the subscription to/from the NF. +The CDS blue print processor will execute the action over netconf towards the NF. +(See :ref:`DCAE_CL_OUTPUT_Topic<DCAE_CL_OUTPUT_Topic>` for more details) + +Multiple CDS Blueprint support +"""""""""""""""""""""""""""""" +When PMSH applies the nfFilter during the parsing of the NF data, it will attempt to retrieve the relevant blueprint information +defined in A&AI related to that model. +These are optional parameters in SDC (sdnc_model_name, sdnc_model_version), and can be defined as properties +assignment inputs, then pushed to A&AI during distribution. + +If no blueprint information is available, the NF will be skipped and no subscription event sent. + +If successful, the sdnc_model_name and sdnc_model_version will be sent as part of the event to the policy framework as +blueprintName and blueprintVersion respectively. +This in turn will be sent from the operational policy towards CDS blueprint processor, to trigger the action for the relevant blueprint. |