aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKanagaraj Manickam <kanagaraj.manickam@huawei.com>2017-10-13 01:32:43 +0000
committerGerrit Code Review <gerrit@onap.org>2017-10-13 01:32:43 +0000
commit0aeedb55066ff9e860225be51266ac85134afb87 (patch)
treede67d764ebdcba34191464f19edc17dc0486989e
parentfdf9058ba5daeeb551b19190d41cf97635c018d7 (diff)
parent67ff4a5fcec551014d15eb7cae66f70b990e781e (diff)
Merge changes Ia1e2064a,I7c8acd53,I3a1e0713
* changes: Add console doc Fix minor issues Add OOM and HEAT based installation details
-rw-r--r--README.md2
-rw-r--r--docs/OOM_and_HEAT_based_deployment.rst22
-rw-r--r--docs/console.rst30
-rw-r--r--docs/images/portal-cli-shell.pngbin0 -> 60357 bytes
-rw-r--r--docs/images/portal-cli-web-con.pngbin0 -> 101711 bytes
-rw-r--r--docs/index.rst5
-rw-r--r--docs/installation_guide.rst2
-rw-r--r--docs/logging.rst6
-rw-r--r--docs/open_cli_schema_version_1_0.rst4
-rw-r--r--docs/user_guide.rst4
10 files changed, 64 insertions, 11 deletions
diff --git a/README.md b/README.md
index 07cae08d..670fbc6f 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ Type **onap** from linux console.
And use the directive set to set the values for following parameters:
-1. **onap-host-url** - Onap Micro service bus(MSB) URL or a service URL
+1. **host-url** - Onap Micro service bus(MSB) URL or a service URL
2. **onap-username** - Onap user name
3. **onap-password** - Onap user password
diff --git a/docs/OOM_and_HEAT_based_deployment.rst b/docs/OOM_and_HEAT_based_deployment.rst
new file mode 100644
index 00000000..18601b89
--- /dev/null
+++ b/docs/OOM_and_HEAT_based_deployment.rst
@@ -0,0 +1,22 @@
+.. _OOM_and_HEAT_based_deployment:
+.. 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 deployment using OOM and HEAT
+=================================
+
+ONAP CLI is integrated with OOM and HEAT based ONAP deployment.
+
+HEAT based deployment
+----------------------
+
+As part of HEAT based deploment, ONAL CLI docker image is integrated into ONAP Portal and when portal_vm is
+successfully installed, it will be available at http://portal_vm-ip:8080
+
+To troubleshoot any issues in CLI, please login to portal_vm and CLI docker runs with image onap/cli
+
+
+OOM based deployment
+--------------------
+ONAL CLI docker image is integrated with OOM and is available under name 'cli' \ No newline at end of file
diff --git a/docs/console.rst b/docs/console.rst
new file mode 100644
index 00000000..f96e6fc9
--- /dev/null
+++ b/docs/console.rst
@@ -0,0 +1,30 @@
+.. 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.
+
+.. _console:
+
+CLI Console
+===========
+
+Please install the CLI by following guidelines provided in OOM_and_HEAT_based_deployment_.
+
+.. _OOM_and_HEAT_based_deployment : OOM_and_HEAT_based_deployment.rst
+
+After installation, ONAP CLI can be used in following form:
+
+# Command Shell
+
+|image4|
+
+.. |image4| image:: images/portal-cli-shell.png
+ :height: 600px
+ :width: 800px
+
+# Web Command Console
+
+|image5|
+
+.. |image5| image:: images/portal-cli-web-con.png
+ :height: 600px
+ :width: 800px \ No newline at end of file
diff --git a/docs/images/portal-cli-shell.png b/docs/images/portal-cli-shell.png
new file mode 100644
index 00000000..eb49e328
--- /dev/null
+++ b/docs/images/portal-cli-shell.png
Binary files differ
diff --git a/docs/images/portal-cli-web-con.png b/docs/images/portal-cli-web-con.png
new file mode 100644
index 00000000..97c54aaf
--- /dev/null
+++ b/docs/images/portal-cli-web-con.png
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
index 614d03a7..34cc6319 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -31,11 +31,12 @@ ONAP CLI is developed using the industry first CLI platform called
.. toctree::
:maxdepth: 1
+ console.rst
OCLIP.rst
+ open_cli_schema_version_1_0.rst
architecture.rst
developer_guide.rst
user_guide.rst
installation_guide.rst
- open_cli_schema_version_1_0.rst
+ OOM_and_HEAT_based_deployment.rst
logging.rst
-
diff --git a/docs/installation_guide.rst b/docs/installation_guide.rst
index 8f7f2503..95dc6046 100644
--- a/docs/installation_guide.rst
+++ b/docs/installation_guide.rst
@@ -11,7 +11,7 @@ ONAP CLI is delivered in following formats:
* Nexus ZIP artifact
* Docker image
-And tt could be installed by following one of the approaches given below:
+And it could be installed by following one of the approaches given below:
Using install.sh
----------------
diff --git a/docs/logging.rst b/docs/logging.rst
index be86c222..9c92fbd1 100644
--- a/docs/logging.rst
+++ b/docs/logging.rst
@@ -3,9 +3,9 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
-Logging
-=======
+CLI Logging
+===========
-ONAP CLI provides logging based on slf4j and logging.properties is used to configure it.
+ONAP CLI provides logging based on slf4j and ONAP_CLI_HOME/conf/logging.properties is used to configure it.
By default it reports the logs under ONAP_CLI_HOME/logs folder. \ No newline at end of file
diff --git a/docs/open_cli_schema_version_1_0.rst b/docs/open_cli_schema_version_1_0.rst
index e8592e98..5d649eaf 100644
--- a/docs/open_cli_schema_version_1_0.rst
+++ b/docs/open_cli_schema_version_1_0.rst
@@ -3,8 +3,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
-Open Command Line Interface (CLI) Schema Version 1.0
-====================================================
+Open Command Line Interface (CLI) Schema Version (OCS) 1.0
+==========================================================
Open CLI Platform (OCLIP) provides model based framework to implement
Linux Commands for any given software products, by using YAML template
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
index d002662b..3e9c89fe 100644
--- a/docs/user_guide.rst
+++ b/docs/user_guide.rst
@@ -21,11 +21,11 @@ Type **onap <command>** from linux console.
To Run in Interactive mode
--------------------------
-Type **onap** from linux console.
+Type **onap** from linux/web console.
And use the directive set to set the values for following parameters:
-1. **onap-host-url** - Onap Micro service bus(MSB) URL or a service URL
+1. **host-url** - Onap Micro service bus(MSB) URL or a service URL
2. **onap-username** - Onap user name
3. **onap-password** - Onap user password