docs/installation_guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 Huawei Technologies Co., Ltd.
   4
   5 .. _cli_installation_guide:
   6
   7 CLI installation guide
   8 ======================
   9
  10 ONAP CLI is delivered in following formats:
  11
  12 * Nexus ZIP artifact
  13 * Docker image
  14
  15 And it could be installed by following one of the approaches given below:
  16
  17 Using install.sh
  18 ----------------
  19
  20 Please follow the instructions given below, for installing CLI using install.sh.
  21
  22 1. Download install.sh from here_. to /tmp
  23
  24 .. _here: https://gerrit.onap.org/r/gitweb?p=cli.git;a=blob_plain;f=deployment/zip/installer/install.sh;hb=refs/heads/master
  25
  26 2. Run command
  27
  28 .. code-block:: bash
  29
  30    source /tmp/install.sh
  31
  32 3. Verify the installation by running following command.
  33
  34 .. code-block:: bash
  35
  36    onap -v
  37
  38 4. For details, see :ref:`cli_user_guide`
  39
  40
  41 Using Portal CLI app
  42 --------------------
  43
  44 Please follow the instructions given below, for installing CLI from portal.
  45
  46 1. After installing Portal, ONAP CLI will be available as Portal application as shown below:
  47
  48 .. image:: images/portal-cli-app.png
  49
  50 2. Click on CLI application and it will show the following page and download the CLI as reported in this page.
  51
  52 .. image:: images/portal-cli-dowload.png
  53
  54 3. After downloading, please follow the instruction given in this page to install ONAP CLI.
  55
  56 4. Verify the installation by running following command
  57
  58 .. code-block:: bash
  59
  60    onap -v
  61
  62 5. For details, see :ref:`cli_user_guide`
  63
  64 Using docker image
  65 ------------------
  66
  67 Please follow the instructions given below, for installing CLI using docker image.
  68
  69 1. Download the cli docker image
  70
  71 .. code-block:: bash
  72
  73   docker login -u docker -p docker nexus3.onap.org:10001
  74   docker pull nexus3.onap.org:10001/onap/cli
  75
  76 2. Verify the installation by running following command
  77
  78 .. code-block:: bash
  79
  80    docker run onap/cli onap -v
  81
  82 3. For details, see :ref:`cli_user_guide`
  83
  84