summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2017-10-11 14:29:27 +0530
committerKanagaraj Manickam <kanagaraj.manickam@huawei.com>2017-10-12 02:03:23 +0000
commitaeeafd46c74c776ccd4427387a39da0f32c4f539 (patch)
treea6fc16ece7fdf0fa00382e12c62d6b065662310e /docs
parentd5048edb7d209fc11283f4666af0ab3c5d460bdc (diff)
Add architecture doc
CLI-40 Change-Id: Ie2aeca50a2a3124668e877a0971a601db1956747 Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/architecture.rst28
-rw-r--r--docs/images/portal-cli-arch.pngbin0 -> 135975 bytes
-rw-r--r--docs/index.rst1
3 files changed, 29 insertions, 0 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644
index 00000000..7b54c3c6
--- /dev/null
+++ b/docs/architecture.rst
@@ -0,0 +1,28 @@
+.. _architecture:
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+CLI architecture
+================
+
+Following diagram shows the high-level architecture of ONAP CLI.
+
+|image3|
+
+.. |image3| image:: images/portal-cli-arch.png
+ :height: 600px
+ :width: 800px
+
+* **Command Registrar** : Registrar keeps track of the commands regsitered in ONAP CLI and when user invokes the command, it identify
+the corresponding command route the request to that command plugin.
+
+* **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and auto-matically register them into Registrar.
+
+* **Command Plug-ings** : Implement the command as plugin. More details developer_guide_.
+
+* **HTTP Command** : Plug-in for implementing all Rest based command as YAML without any coding.
+
+* **Command Shell** : Provides the interactive command line console from Linux
+
+* **Web Command Console** : Provides the interactive command line console from web-browser
diff --git a/docs/images/portal-cli-arch.png b/docs/images/portal-cli-arch.png
new file mode 100644
index 00000000..d027e68f
--- /dev/null
+++ b/docs/images/portal-cli-arch.png
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
index 1ad0b76a..912bd506 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -32,6 +32,7 @@ ONAP CLI is developed using the industry first CLI platform called
:maxdepth: 1
OCLIP.rst
+ architecture.rst
developer_guide.rst
user_guide.rst
installation_guide.rst