docs/architecture.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 Architecture
   5 ============
   6
   7 Capabilities
   8 ------------
   9 The DMaaP Data Router (DR) provisioning API is an HTTPS-based, REST-like API for creating and managing
  10 DR feeds and subscriptions, which provides a pub/sub architectural model for the transfer of data.
  11
  12 The DR API also supports `AAF CADI authorization <https://docs.onap.org/en/latest/submodules/aaf/authz.git/docs/sections/architecture/cadi.html#authorization>`_.
  13
  14 To use this feature, the API client must provide a valid AAF AppID / MechID with each request.
  15 To enable this feature, see the :ref:`configuration` section.
  16
  17 .. note:: In future releases, AAF CADI auth will be enabled by default.
  18
  19 Usage Scenarios
  20 ---------------
  21 Typically, DR pub clients request the provisioning of a new DR feed.
  22 Once created, DR sub clients can then subscribe to the feed to receive all data published to that feed.
  23
  24    .. image:: images/dr_pub_flow.png
  25
  26
  27 The DR provisioning API is not meant to be used directly by DR end users (publishers and subscribers)
  28 for feed / subscription CRUD (create, read, update, delete) operations.
  29
  30 Instead, prospective publishers and subscribers should use the DMaaP Bus Controller API, which will call
  31 the DR provisioning API to manage feeds and subscriptions.
  32
  33    .. image:: images/dr_bc_prov.png
  34
  35
  36 See DMaaP Bus Controller API docs for more information:
  37
  38 `Bus Controller Feeds API <https://onap.readthedocs.io/en/latest/submodules/dmaap/dbcapi.git/docs/api.html#feeds>`_
  39
  40 `Bus Controller Subs API <https://onap.readthedocs.io/en/latest/submodules/dmaap/dbcapi.git/docs/api.html#dr-subs>`_
  41
  42
  43 High level Architecture
  44 -----------------------
  45 The following diagram shows the high-level relationship between the system components:
  46
  47    .. image:: images/dr_arch_only.png
  48
  49
  50 DMaaP DR architecture uses the Eclipse Jetty server as an application server to service it's front-end.
  51    * dmaap-dr-prov services all provisioning requests.
  52    * dmaap-dr-node services the publishing of data to feed subscribers.
  53
  54 DMaaP DR uses MariaDB as it's storage component for the following:
  55    * DR Provisioning data. (feeds, subscribers, etc.)
  56    * Historical logging data related to feed activity. (Publish, Delivery, etc.)