[DMAAP-BC] Consolidate bus controller repos

[dmaap/buscontroller.git] / docs / architecture.rst

diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644 (file)
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;
+        }
+    }