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