docs/installation_guide.rst

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