1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Huawei Technologies Co., Ltd.
10 To Run OCLIP on local docker machine
11 ---------------------------------------
13 1. Login to docker repository::
15 docker login -u docker -p docker nexus3.onap.org:10001
17 2. Pull cli docker image and run locally::
19 docker run -d --name oclip -e OPEN_CLI_MODE=daemon -p 9090:8080 -p 8080:80 nexus3.onap.org:10001/onap/cli:2.0-STAGING-latest
21 Access the CLI console
22 ~~~~~~~~~~~~~~~~~~~~~~
24 1. Web command console::
30 docker exec -it oclip oclip
32 How to run OCLIP on ubuntu server
33 ---------------------------------
35 1. Download install script::
37 wget -O ~/oclip-install.sh https://gerrit.onap.org/r/gitweb?p=cli.git;a=blob_plain;f=deployment/zip/installer/install-latest.sh;h=71488dae78a3ecbb27711c95475b4568883f799f;hb=refs/heads/master
39 2. Set execution mode and run installer::
43 chmod +x oclip-install.sh
47 3. verify the installation, by running::
51 NOTE: Make sure OPEN_CLI_HOME is set to /opt/oclip, type
58 1. Run oclip console::
66 3. Add basic parameters in to profile::
68 set <service-name>:<parameter-name>
70 Example: To set the host url for service AAI in ONAP, type 'set AAI:host-url=https://192.168.17.35:30233'
72 4. For ONAP beijing version, OCLIP provides default profile named onap-beijing. To use this profile, type::
76 set aai:host-url=<AAI service URL>
78 set msb:host-url=<MSB service URL>
80 set sdc:host-url=<SDC service URL>
82 set so:host-url=<SO service URL>
84 NOTE: This step is not applicable for other products, so it could be skipped.
90 Use the existing profile
91 ------------------------
93 1. In console mode, type::
95 profile <profile-name>
98 2. In scripting mode, type::
100 oclip -c <profile-name> <command name>
102 Example: To list the VNF cloud registered in the ONAP, type 'oclip -c onap-beijing cloud-list'.
105 How to configure OCLIP to use for given product version
106 -------------------------------------------------------
111 1. Identify the available and current product version, type::
115 It will report as below:
117 CLI version : 2.0.0 [2018-03-21 11:04 UTC]
118 Available products: [open-cli, onap-beijing, onap-amsterdam, sample-helloworld]
119 Enabled product : open-cli
121 2. To enable a product say onap-beijing, type::
125 3. List available commands, type::
132 1. Identify the available and current product version, type::
136 It will report as below:
138 CLI version : 2.0.0 [2018-03-21 11:04 UTC]
139 Available products: [open-cli, onap-beijing, onap-amsterdam, sample-helloworld]
140 Enabled product : open-cli
142 2. To enable a product say onap-beijing, set environment variable OPEN_CLI_PRODUCT_IN_USE::
144 export OPEN_CLI_PRODUCT_IN_USE=onap-beijing
146 3. List available commands, type::