diff options
| author |   su622b <sunil.unnava@att.com> | 2018-04-16 16:50:25 -0400 |
|---|---|---|
| committer | su622b <sunil.unnava@att.com> | 2018-04-16 16:50:52 -0400 |
| commit | 1c624de20ff321fe5c86c4df873952d82b1946b3 (patch) | |
| tree | 5bc44799ec76af23108d7bee9d71f8038fd0a05a /docs/architecture | |
| parent | 7cd58518e9dc263521f252c1095a43244e464222 (diff) | |
updated the documentation
Issue-ID: DMAAP-413
Change-Id: I4955f7e512e594c189c5183ec83c5769d33d8f05
Signed-off-by: su622b <sunil.unnava@att.com>
Diffstat (limited to 'docs/architecture')
| -rw-r--r-- | docs/architecture/architecture.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst new file mode 100644 index 0000000..60f8467 --- /dev/null +++ b/docs/architecture/architecture.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Architecture +============ + +.. note:: + * This section is used to describe a software component from a high level + view of capability, common usage scenarios, and interactions with other + components required in the usage scenarios. + + * The architecture section is typically: provided in a platform-component + and sdk collections; and referenced from developer and user guides. + + * This note must be removed after content has been added. + + +Capabilities +------------ +Message Router is a RESTful web service used for any needed action with Kaka + +Usage Scenarios +--------------- +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 + +Interactions +------------ +Message Service REST service uses the message service API to interact with the ZooKeeper/Kafka
\ No newline at end of file |