X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation_guide.rst;h=f1b99b139a48148284bcc3af9dd83f311e56f214;hb=518087cd3e0ad0ef7e84d425105c906aa302612d;hp=8f7f25039e1a076ba85ea8e35846e744c6899987;hpb=255d1373266095994baf320326f1ba08022977ee;p=cli.git diff --git a/docs/installation_guide.rst b/docs/installation_guide.rst index 8f7f2503..f1b99b13 100644 --- a/docs/installation_guide.rst +++ b/docs/installation_guide.rst @@ -1,8 +1,9 @@ -.. _installation_guide: .. 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_installation_guide: + CLI installation guide ====================== @@ -11,7 +12,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 ---------------- @@ -22,15 +23,19 @@ Please follow the instructions given below, for installing CLI using install.sh. .. _here: https://gerrit.onap.org/r/gitweb?p=cli.git;a=blob_plain;f=deployment/zip/installer/install.sh;hb=refs/heads/master -2. Run command:: +2. Run command + +.. code-block:: bash source /tmp/install.sh -3. Verify the installation by running following command:: +3. Verify the installation by running following command. + +.. code-block:: bash onap -v -4. For more details, please refer user_guide_. +4. For details, see :ref:`cli_user_guide` Using Portal CLI app @@ -40,42 +45,40 @@ Please follow the instructions given below, for installing CLI from portal. 1. After installing Portal, ONAP CLI will be available as Portal application as shown below: -|image0| - -.. |image0| image:: images/portal-cli-app.png - :height: 600px - :width: 800px +.. image:: images/portal-cli-app.png 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 - :height: 600px - :width: 800px +.. image:: images/portal-cli-dowload.png 3. After downloading, please follow the instruction given in this page to install ONAP CLI. -4. Verify the installation by running following command:: +4. Verify the installation by running following command + +.. code-block:: bash onap -v -5. For more details, please refer user_guide_. +5. For details, see :ref:`cli_user_guide` Using docker image ------------------ +------------------ Please follow the instructions given below, for installing CLI using docker image. -1. Download the cli docker image:: +1. Download the cli docker image + +.. code-block:: bash docker login -u docker -p docker nexus3.onap.org:10001 docker pull nexus3.onap.org:10001/onap/cli -2. Verify the installation by running following command:: +2. Verify the installation by running following command + +.. code-block:: bash docker run onap/cli onap -v -3. For more details, please refer user_guide_. +3. For details, see :ref:`cli_user_guide`