README.md

   1 [comment]: # (# Copyright 2018 Huawei Technologies Co., Ltd.)
   2 [comment]: # (# )
   3 [comment]: # (Licensed under the Apache License, Version 2.0 (the "License")
   4 [comment]: # (# you may not use this file except in compliance with the License.)
   5 [comment]: # (# You may obtain a copy of the License at)
   6 [comment]: # (#)
   7 [comment]: # (#     http://www.apache.org/licenses/LICENSE-2.0)
   8 [comment]: # (#)
   9 [comment]: # (# Unless required by applicable law or agreed to in writing, software)
  10 [comment]: # (# distributed under the License is distributed on an "AS IS" BASIS,)
  11 [comment]: # (# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.)
  12 [comment]: # (# See the License for the specific language governing permissions and)
  13 [comment]: # (# limitations under the License.)
  14
  15 Open Command-line interface Platform (OCLIP)
  16 ============================================
  17
  18 Provides unified commands to operate any cloud enabled software
  19 products from Linux/Web console.
  20
  21 Set the following environment variable, before using OCLIP:
  22
  23 **OPEN_CLI_HOME** - Complete path of directory, where OCLIP is installed.
  24
  25 To Run a command
  26 -----------------
  27 Configure the following environment variables:
  28
  29 1. **OPEN_CLI_HOST_URL** - Catalog service URL or a service URL
  30 2. **OPEN_CLI_HOST_USERNAME** - Service user name
  31 3. **OPEN_CLI_HOST_PASSWORD** - Service password
  32
  33 Run **oclip <command>** from Linux console.
  34
  35 To Run in Interactive mode
  36 --------------------------
  37 Run **oclip** from Linux console.
  38
  39 And use the directive set to set the values for following parameters:
  40
  41 1. **host-url** - Catalog service URL or a service URL
  42 2. **host-username** - Service user name
  43 3. **host-password** - Service password
  44
  45 NOTE: This mode is available as Web command console when OCLIP is running from docker.
  46
  47 Select the product version
  48 --------------------------
  49 CLI framework is enhanced to handle multiple product versions at same
  50 time. so to choose the product version, set environment variable
  51 **OPEN_CLI_PROUDCT_IN_USE**.
  52
  53 NOTE: In interactive mode, product version can be selected using
  54 typing **use <product-version>**
  55
  56 Run *oclip [-v|--version]* to see the available product version details.
  57
  58 Set the parameter values
  59 ------------------------
  60 Use the directive 'set' for setting the values for parameters and 'unset' for un-setting the values.
  61
  62 Help
  63 ----
  64 *oclip [-h|--help]*
  65 *oclip <command> [-h|--help]*
  66
  67 Debug Mode
  68 ----------
  69 To run in debug mode, set following environment variables:
  70
  71 1. OPEN_CLI_DEBUG - By default its false, otherwise Set to true
  72 2. OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number