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 .. _architecture:
   4
   5 Architecture
   6 ============
   7
   8
   9 Capabilities
  10 ------------
  11 Bus Controller is a RESTful web service used to provision DMaaP topics on MR (Message Router)
  12 and feeds on DR (Data Router), with associated authorization via AAF.
  13
  14 Usage Scenarios
  15 ---------------
  16 Bus Controller endpoints are used to provision:
  17
  18 - an authorized topic on MR, and to create and grant permission for publishers and subscribers.
  19 - a feed on DR, with associated user authentication.
  20
  21 .. blockdiag::
  22
  23    blockdiag layers {
  24    orientation = portrait
  25    DBC_CLIENT -> DBC_API;
  26    DBC_API -> MR;
  27    DBC_API -> DR;
  28    DBC_API -> AAF;
  29    group l1 {
  30         color = blue;
  31         label = "Bus Controller Container";
  32         DBC_API;
  33         }
  34    group l2 {
  35         color = yellow;
  36         label = "MR";
  37         MR;
  38         }
  39    group l3 {
  40         color = orange;
  41         label = "DR";
  42         DR;
  43         }
  44     group l4 {
  45         color = green;
  46         label = "AAF";
  47         AAF;
  48         }
  49     }