docs/sections/services/pm-subscription-handler/overview.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 .. _Overview:
   5
   6 Overview
   7 ========
   8
   9 Introduction
  10 """"""""""""
  11 The PM Subscription Handler (PMSH) is a micro service written in Python, which allows for the definition and activation
  12 of PM subscriptions on one or more network function (NF) instances.
  13
  14 .. _Delivery: ./delivery.html
  15
  16 Functionality
  17 """""""""""""
  18 The PMSH allows for the definition of subscriptions on a network level, which enables the configuration of PM data on a
  19 set of NF instances. During creation of a subscription, PM reporting configuration and a network function filter will
  20 be defined. This filter will then be used to produce a subset of NF's to which the subscription will be applied. If
  21 a NF matching the filter is registered in ONAP after the microservice has been deployed, the subscription will
  22 be applied to that NF.
  23
  24 Interaction
  25 """""""""""
  26
  27 Config Binding Service
  28 ^^^^^^^^^^^^^^^^^^^^^^
  29
  30 The PMSH interacts with the Config Binding Service to retrieve it's configuration information, including the
  31 subscription information.
  32
  33 DMaaP
  34 ^^^^^
  35
  36 The PMSH subscribes and publishes to various DMaaP Message Router topics (See :ref:`Topics<Topics>`
  37 for more information on which topics are used).
  38
  39 A&AI
  40 ^^^^
  41
  42 The PMSH interacts with A&AI to fetch data about network functions. The ``nfFilter`` is then
  43 applied to this data to produce a targeted subset of NF's.
  44
  45 Policy and CDS
  46 ^^^^^^^^^^^^^^
  47
  48 The PMSH will indirectly interact with Policy and CDS in order to push subscriptions to NF's. A policy will be used to
  49 make a request to CDS, which will apply the subscription to the NF.