diff options
| author |   Kanagaraj Manickam <kanagaraj.manickam@huawei.com> | 2017-10-12 02:03:10 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2017-10-12 02:03:10 +0000 |
| commit | 255d1373266095994baf320326f1ba08022977ee (patch) | |
| tree | 6de9e7d2edd00e0b4ecb11687978162154435c9f /docs/installation_guide.rst | |
| parent | 5648ee7dcf958cfb54721cfc6a6bbb53447f0248 (diff) | |
| parent | 7d4b1876b84bc933d335bcac974bcf4230859ef6 (diff) | |
Merge "Add installation guide"
Diffstat (limited to 'docs/installation_guide.rst')
| -rw-r--r-- | docs/installation_guide.rst | 76 |
1 files changed, 75 insertions, 1 deletions
diff --git a/docs/installation_guide.rst b/docs/installation_guide.rst index 3a55e578..8f7f2503 100644 --- a/docs/installation_guide.rst +++ b/docs/installation_guide.rst @@ -4,4 +4,78 @@ .. Copyright 2017 Huawei Technologies Co., Ltd. CLI installation guide -======================
\ No newline at end of file +====================== + +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: + +Using install.sh +---------------- + +Please follow the instructions given below, for installing CLI using install.sh. + +1. Download install.sh from here_. to /tmp + +.. _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:: + + source /tmp/install.sh + +3. Verify the installation by running following command:: + + onap -v + +4. For more details, please refer user_guide_. + + +Using Portal CLI app +-------------------- + +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 + +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 + +3. After downloading, please follow the instruction given in this page to install ONAP CLI. + +4. Verify the installation by running following command:: + + onap -v + +5. For more details, please refer user_guide_. + +Using docker image +----------------- + +Please follow the instructions given below, for installing CLI using docker image. + +1. Download the cli docker image:: + + 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:: + + docker run onap/cli onap -v + +3. For more details, please refer user_guide_. + + |