aboutsummaryrefslogtreecommitdiffstats
path: root/docs/architecture.rst
diff options
context:
space:
mode:
authorefiacor <fiachra.corcoran@est.tech>2021-04-08 16:40:06 +0100
committerefiacor <fiachra.corcoran@est.tech>2021-04-21 13:49:22 +0100
commit71d3d0925874247de5e657821638b1c08360f571 (patch)
tree91bcca2c8bd53c3ee54269c3101538cba70fa588 /docs/architecture.rst
parent20221353bdb213a1f143a132d819d4e0810e3794 (diff)
[DMAAP-BC] Consolidate bus controller repos
Migrate BC CSITs to the repo Fix documentation Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I874ed61be1b61187e233e9fd0937f6658f0ec0f0 Issue-ID: DMAAP-1544
Diffstat (limited to 'docs/architecture.rst')
-rw-r--r--docs/architecture.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644
index 0000000..721146d
--- /dev/null
+++ b/docs/architecture.rst
@@ -0,0 +1,49 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. _architecture:
+
+Architecture
+============
+
+
+Capabilities
+------------
+Bus Controller is a RESTful web service used to provision DMaaP topics on MR (Message Router)
+and feeds on DR (Data Router), with associated authorization via AAF.
+
+Usage Scenarios
+---------------
+Bus Controller endpoints are used to provision:
+
+- an authorized topic on MR, and to create and grant permission for publishers and subscribers.
+- a feed on DR, with associated user authentication.
+
+.. blockdiag::
+
+ blockdiag layers {
+ orientation = portrait
+ DBC_CLIENT -> DBC_API;
+ DBC_API -> MR;
+ DBC_API -> DR;
+ DBC_API -> AAF;
+ group l1 {
+ color = blue;
+ label = "Bus Controller Container";
+ DBC_API;
+ }
+ group l2 {
+ color = yellow;
+ label = "MR";
+ MR;
+ }
+ group l3 {
+ color = orange;
+ label = "DR";
+ DR;
+ }
+ group l4 {
+ color = green;
+ label = "AAF";
+ AAF;
+ }
+ }