HEAT based deployment
----------------------
-As part of HEAT based deploment, ONAL CLI docker image is integrated into ONAP Portal and when portal_vm is
+As part of HEAT based deployment, 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
Following diagram shows the high-level architecture of ONAP CLI.
-|image3|
-
-.. |image3| image:: images/portal-cli-arch.png
+.. image:: images/portal-cli-arch.png
:height: 600px
:width: 800px
* **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_.
+* **Command Plug-ings** : Implement the command as plugin. More details :ref:`developer_guide`
* **HTTP Command** : Plug-in for implementing all Rest based command as YAML without any coding.
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
+Please install the CLI by following guidelines provided in :ref:`OOM_and_HEAT_based_deployment`
After installation, ONAP CLI can be used in following form:
# Command Shell
-|image4|
-
-.. |image4| image:: images/portal-cli-shell.png
+.. image:: images/portal-cli-shell.png
:height: 600px
:width: 800px
# Web Command Console
-|image5|
-
-.. |image5| image:: images/portal-cli-web-con.png
+.. image:: images/portal-cli-web-con.png
:height: 600px
:width: 800px
\ No newline at end of file
onap -v
-4. For more details, please refer user_guide_.
+4. For details, see :ref:`user_guide`
Using Portal CLI app
1. After installing Portal, ONAP CLI will be available as Portal application as shown below:
-|image0|
-
-.. |image0| image:: images/portal-cli-app.png
+.. image:: images/portal-cli-app.png
:height: 600px
:width: 800px
2. Click on CLI application and it will show the following page and download the CLI as reported in this page.
-|image1|
-
-.. |image1| image:: images/portal-cli-dowload.png
+.. image:: images/portal-cli-dowload.png
:height: 600px
:width: 800px
onap -v
-5. For more details, please refer user_guide_.
+5. For details, see :ref:`user_guide`
Using docker image
-----------------
docker run onap/cli onap -v
-3. For more details, please refer user_guide_.
+3. For details, see :ref:`user_guide`