Add architecture doc

CLI-40

Change-Id: Ie2aeca50a2a3124668e877a0971a601db1956747
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>

diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644 (file)
index 0000000..7b54c3c
--- /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 (file)
index 0000000..d027e68
Binary files /dev/null and b/docs/images/portal-cli-arch.png differ

diff --git a/docs/index.rst b/docs/index.rst
index 1ad0b76..912bd50 100644 (file)
--- 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