summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/pm-subscription-handler/overview.rst
diff options
context:
space:
mode:
authordfarrelly <david.farrelly@est.tech>2019-11-27 15:13:04 +0000
committerdfarrelly <david.farrelly@est.tech>2019-12-04 12:19:01 +0000
commit6cf238429ab448de881e1458ea10697df8c9dcde (patch)
tree7fe8df320b8a669d3af7e134a3a1166e7d446138 /docs/sections/services/pm-subscription-handler/overview.rst
parentd10bd6a5350ae9284b0fd16a0bb53ce4f3ae24bf (diff)
Add PMSH documentation
*Add base PM Subscription Handler documentation Issue-ID: DCAEGEN2-1837 Change-Id: I17bb587ef56704e0a122d65c7d29a2998489ce9c Signed-off-by: dfarrelly <david.farrelly@est.tech>
Diffstat (limited to 'docs/sections/services/pm-subscription-handler/overview.rst')
-rw-r--r--docs/sections/services/pm-subscription-handler/overview.rst54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/sections/services/pm-subscription-handler/overview.rst b/docs/sections/services/pm-subscription-handler/overview.rst
new file mode 100644
index 00000000..076d384a
--- /dev/null
+++ b/docs/sections/services/pm-subscription-handler/overview.rst
@@ -0,0 +1,54 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _Overview:
+
+Overview
+========
+
+Introduction
+""""""""""""
+The PM Subscription Handler (PMSH) is a micro service written in Python, which allows for the definition and unlocking
+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.
+
+Interaction
+"""""""""""
+
+Config Binding Service
+^^^^^^^^^^^^^^^^^^^^^^
+
+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>`
+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
+applied to this data to produce a targeted subset of NF's.
+
+Policy and CDS
+^^^^^^^^^^^^^^
+
+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.
+
+
+
+
+
+
+
+