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