60f846758ad9ad77783bffe75ef992b1b4537aab
[dmaap/messagerouter/messageservice.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 .. note::
8    * This section is used to describe a software component from a high level
9      view of capability, common usage scenarios, and interactions with other
10      components required in the usage scenarios.  
11    
12    * The architecture section is typically: provided in a platform-component
13      and sdk collections; and referenced from developer and user guides.
14    
15    * This note must be removed after content has been added.
16
17
18 Capabilities
19 ------------
20 Message Router is a RESTful web service used for any needed action with Kaka
21
22 Usage Scenarios
23 ---------------
24 Message Router endpoints are used to create/view/delete a topic in Kafka. Clients can use the Message Router endpoints to publish a message to a topic and subscribe to a topic 
25
26 Interactions
27 ------------
28 Message Service REST service uses the message service API to interact with the ZooKeeper/Kafka