update link to upper-constraints.txt

[cli.git] / docs / cookbook.rst

diff --git a/docs/cookbook.rst b/docs/cookbook.rst
index 6f636a5..55f88a1 100644 (file)
--- a/docs/cookbook.rst
+++ b/docs/cookbook.rst
@@ -1,11 +1,14 @@
 .. 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.
+.. Copyright 2018 Huawei Technologies Co., Ltd.
 
 .. _cli_cookbook:
 
+CLI cook-book
+=============
+
 To Run OCLIP on local docker machine
-=======================================
+---------------------------------------
 
 1. Login to docker repository::
 
@@ -13,20 +16,21 @@ To Run OCLIP on local docker machine
 
 2. Pull cli docker image and run locally::
 
-    docker run -d --name oclip -e CLI_MODE=daemon -p 8080:9090 -p 8080:80 nexus3.onap.org:10001/onap/cli:2.0-STAGING-latest
+    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
 
-3. Access the CLI console:
+Access the CLI console
+~~~~~~~~~~~~~~~~~~~~~~
 
-3.1 Web command console::
+1. Web command console::
 
     http://localhost:9090
 
-3.2 Linux console::
+2. Linux console::
 
     docker exec -it oclip oclip
 
 How to run OCLIP on ubuntu server
-=================================
+---------------------------------
 
 1. Download install script::
 
@@ -49,7 +53,7 @@ How to run OCLIP on ubuntu server
     echo $OPEN_CLI_HOME
 
 Setup profile
-=============
+-------------
 
 1. Run oclip console::
 
@@ -84,7 +88,7 @@ Setup profile
     exit
 
 Use the existing profile
-========================
+------------------------
 
 1. In console mode, type::
 
@@ -99,11 +103,12 @@ Use the existing profile
 
 
 How to configure OCLIP to use for given product version
-=======================================================
+-------------------------------------------------------
 
-1. In console mode
+In console mode
+~~~~~~~~~~~~~~~
 
-1.1 Identify the available and current product version, type::
+1. Identify the available and current product version, type::
 
     version
 
@@ -113,17 +118,18 @@ How to configure OCLIP to use for given product version
     Available products: [open-cli, onap-beijing, onap-amsterdam, sample-helloworld]
     Enabled product   : open-cli
 
-1.2 To enable a product say onap-beijing, type::
+2. To enable a product say onap-beijing, type::
 
     use onap-beijing
 
-1.3 List available commands, type::
+3. List available commands, type::
 
     help
 
-2. In scripting mode::
+In scripting mode
+~~~~~~~~~~~~~~~~~
 
-2.1 Identify the available and current product version, type::
+1. Identify the available and current product version, type::
 
     oclip --version
 
@@ -133,10 +139,10 @@ How to configure OCLIP to use for given product version
     Available products: [open-cli, onap-beijing, onap-amsterdam, sample-helloworld]
     Enabled product   : open-cli
 
-2.2 To enable a product say onap-beijing, set environment variable OPEN_CLI_PRODUCT_IN_USE::
+2. To enable a product say onap-beijing, set environment variable OPEN_CLI_PRODUCT_IN_USE::
 
     export OPEN_CLI_PRODUCT_IN_USE=onap-beijing
 
-2.3 List available commands, type::
+3. List available commands, type::
 
     oclip --help