From df2716420918b03320c1ecdfd722cf5a85bac280 Mon Sep 17 00:00:00 2001 From: Kanagaraj Manickam k00365106 Date: Fri, 6 Oct 2017 23:05:25 +0530 Subject: Normalize all env with OPEN_CLI Issue-Id: CLI-66 Change-Id: Iac377cf4cbd3e4d7419fcd41417e4c8bc127a03e Signed-off-by: Kanagaraj Manickam k00365106 --- README.md | 34 +- deployment/docker/src/main/docker/Dockerfile | 23 +- .../docker/src/main/docker/docker-compose.yaml | 5 - deployment/http/lighttpd/lighttpd.conf | 2 +- deployment/http/web/index.html | 109 +++--- deployment/http/web/onap-cli.png | Bin 29672 -> 0 bytes deployment/http/web/open-cli.png | Bin 0 -> 12119 bytes deployment/zip/src/main/release/bin/oclip.sh | 2 +- docs/cmd_help.rst | 415 ++++++++++++++++----- docs/open_cli_schema_version_1_0.rst | 6 +- docs/user_guide.rst | 4 +- .../fw/error/OnapCommandProductVersionInvalid.java | 2 +- .../org/onap/cli/fw/utils/OnapCommandUtils.java | 4 +- .../resources/default_input_parameters_http.yaml | 6 +- .../src/test/resources/sample-cmd-test-help.txt | 2 +- main/src/main/resources/onap-readme.txt | 22 +- 16 files changed, 422 insertions(+), 214 deletions(-) delete mode 100644 deployment/http/web/onap-cli.png create mode 100644 deployment/http/web/open-cli.png diff --git a/README.md b/README.md index a69963b2..a400bb0c 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,21 @@ Provides unified commands to operate any cloud enabled software products from Linux/Web console. Configure the following environment variables, before using it: -1. **HOST_URL** - Catalog service URL or a service URL -2. **HOST_USERNAME** - Service user name -3. **HOST_PASSWORD** - Service password +1. **OPEN_CLI_HOST_URL** - Catalog service URL or a service URL +2. **OPEN_CLI_HOST_USERNAME** - Service user name +3. **OPEN_CLI_HOST_PASSWORD** - Service password To Run a command ----------------- -Type **onap ** from linux console. +Type **oclip ** from linux console. To Run in Interactive mode -------------------------- -Type **onap** from linux console. +Type **oclip** from linux console. And use the directive set to set the values for following parameters: -1. **host-url** - Catalog service URL or a service URL +1. **host-url** - Catalog service URL or a service URL 2. **host-username** - Service user name 3. **host-password** - Service password @@ -27,12 +27,12 @@ Set the product version ------------------------ CLI framework is enhanced to handle multiple product versions at same time. so to choose the product version, set evironment variable -**CLI_PROUDCT_VERSION**. +**OPEN_CLI_PROUDCT_IN_USE**. NOTE: In interactive mode, product version can be selected using typing **use ** -Run *onap [-v|--version]* to see the CLI and available product version details +Run *oclip [-v|--version]* to see the CLI and available product version details Set the parameter values ------------------------ @@ -40,15 +40,19 @@ Use the directive 'set' for setting the values for parameters and 'unset' for un Help ---- -*onap [-h|--help]* -*onap [-h|--help]* +*oclip [-h|--help]* +*oclip [-h|--help]* Debug Mode ---------- To run in debug mode, set following environment variables: -1. CLI_DEBUG - By default its false, otherwise Set to true -2. CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number -More details -------------- -https://wiki.onap.org +1. OPEN_CLI_DEBUG - By default its false, otherwise Set to true +2. OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number + +

More details

https://wiki.onap.org

+ +

To download

Please download Open CLI Platform here

+ diff --git a/deployment/docker/src/main/docker/Dockerfile b/deployment/docker/src/main/docker/Dockerfile index 777e3ac8..e23a3c1b 100644 --- a/deployment/docker/src/main/docker/Dockerfile +++ b/deployment/docker/src/main/docker/Dockerfile @@ -10,15 +10,18 @@ RUN cd /tmp && curl -O https://storage.googleapis.com/golang/go1.9.linux-amd64.t mv /tmp/gotty/bin/gotty /usr/sbin/ #Environments -ENV OPEN_CLI_HOME /opt/onap/cli +ENV OPEN_CLI_HOME /opt/oclip ENV OPEN_CLI_DEBUG false ENV OPEN_CLI_DEBUG_PORT 5005 ENV OPEN_CLI_MODE console ENV OPEN_CLI_PRODUCT_IN_USE open-cli -ENV HOST_URL http://localhost:8080 -ENV OPEN_USERNAME guest -ENV OPEN_PASSWORD guest +ENV OPEN_CLI_HOST_URL http://localhost:8080 +ENV OPEN_CLI_USERNAME guest +ENV OPEN_CLI_PASSWORD guest + +ENV GOTTY_TITLE_FORMAT {{ .command }} +ENV GOTTY_INDEX $OPEN_CLI_HOME/http/web/occ.html #Copy CLI into docker ADD ./STAGE $OPEN_CLI_HOME @@ -27,18 +30,18 @@ WORKDIR $OPEN_CLI_HOME #Setup the run time environment (RTE) #RTE: CLI RUN chmod +x ./bin/oclip.sh && \ - ln ./bin/oclip.sh /usr/sbin/onap && \ + ln ./bin/oclip.sh /usr/sbin/oclip && \ if [ ! -d ./data ]; then mkdir ./data; fi && \ - if [ ! -d ./onap-cli-schema ]; then mkdir ./onap-cli-schema; fi + if [ ! -d ./open-cli-schema ]; then mkdir ./open-cli-schema; fi #Create the readable README RUN pandoc -t plain $OPEN_CLI_HOME/docs/README.md > $OPEN_CLI_HOME/docs/onap-readme.txt #RTE: lighttpd COPY ./STAGE/http/lighttpd/lighttpd.conf /etc/lighttpd/lighttpd.conf -COPY ./STAGE/http/web /var/www-data/servers/onap-cli/ +COPY ./STAGE/http/web /var/www-data/servers/open-cli/ COPY ./STAGE/http/lighttpd/10-proxy.conf /etc/lighttpd/conf-enabled/ -COPY ./STAGE/installer/cli-*.zip /var/www-data/servers/onap-cli/onap-cli.zip +COPY ./STAGE/installer/cli-*.zip /var/www-data/servers/open-cli/open-cli.zip RUN if [ ! -f /var/log/lighttpd/access.log ]; then touch /var/log/lighttpd/access.log; fi RUN cp /etc/lighttpd/conf-available/10-accesslog.conf /etc/lighttpd/conf-enabled/ @@ -49,9 +52,9 @@ EXPOSE 80 EXPOSE 8080 #Start -ENTRYPOINT if [ "$OPEN_CLI_MODE" = "daemon" ]; then service lighttpd start; gotty --permit-write --reconnect onap; else onap -v && /bin/bash; fi +ENTRYPOINT if [ "$OPEN_CLI_MODE" = "daemon" ]; then service lighttpd start; gotty --permit-write --reconnect oclip; else oclip -v && /bin/bash; fi #Cleanup RUN apt-get purge -y pandoc && apt-get autoremove -y && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/go /tmp/gotty /tmp/* /var/tmp/* -RUN echo ONAP CLI docker successfully created !! +RUN echo Open CLI docker successfully created !! diff --git a/deployment/docker/src/main/docker/docker-compose.yaml b/deployment/docker/src/main/docker/docker-compose.yaml index 370ca678..dfd3bb20 100644 --- a/deployment/docker/src/main/docker/docker-compose.yaml +++ b/deployment/docker/src/main/docker/docker-compose.yaml @@ -5,9 +5,6 @@ services: image: onap/cli environment: OPEN_CLI_MODE: 'daemon' - expose: - - 80 - - 8080 ports: - 8080:80 - 9090:8080 @@ -26,7 +23,5 @@ services: environment: OPEN_CLI_MODE: 'console' OPEN_CLI_DEBUG: "true" - expose: - - 5005 ports: - 5005:5005 diff --git a/deployment/http/lighttpd/lighttpd.conf b/deployment/http/lighttpd/lighttpd.conf index 03765bf8..07a49644 100644 --- a/deployment/http/lighttpd/lighttpd.conf +++ b/deployment/http/lighttpd/lighttpd.conf @@ -24,7 +24,7 @@ server.modules = ( ) #server.upload-dirs = ( "/var/cache/lighttpd/uploads" ) -#server.errorlog = "/var/log/lighttpd/error.log" +server.errorlog = "/var/log/lighttpd/error.log" server.pid-file = "/var/run/lighttpd.pid" #compress.cache-dir = "/var/cache/lighttpd/compress/" #compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" ) diff --git a/deployment/http/web/index.html b/deployment/http/web/index.html index f8680f08..263d2bd7 100644 --- a/deployment/http/web/index.html +++ b/deployment/http/web/index.html @@ -1,70 +1,61 @@ -ONAP CLI -

ONAP Command-line interface (CLI)

One Command to command whole Onap !!

Provides unified commands to operate ONAP from Linux console and Web console.

- -

To download

Please download ONAP CLI here

- -

To install

Please follow the instructions given below for installing ONAP CLI.

Un-zip the above download file into /opt/onap/cli folder
Run the following commands: -
export ONAP_CLI_HOME=$CLI_INSTALL_DIR -
export CLI_PRODUCT_VERSION=onap-1.1 -
-
cd $CLI_INSTALL_DIR -
-
if [ ! -d ./data ]; then mkdir ./data; fi -
if [ ! -d ./onap-cli-schema ]; then mkdir ./onap-cli-schema; fi -
-
chmod +x ./bin/onap.sh -
-
#Make onap available in path -
ln ./bin/onap.sh $CLI_BIN -
-
#Print the version -
onap -v

Open CLI Platform (OCLIP)

OPEN Command-line interface (CLI)

Provides unified commands to operate any cloud enabled software products from Linux/Web console. Configure the following environment variables, before using it:

OPEN_CLI_HOST_URL - Catalog service URL or a service URL
OPEN_CLI_HOST_USERNAME - Service user name
OPEN_CLI_HOST_PASSWORD - Service password

Web Command console

To open Console, Click Web Command console

To Run a command

Configure the following environment variables, before using it in Linux console:

HOST_URL - Onap Micro service bus(MSB) URL or a service URL
HOST_USERNAME - Onap user name
HOST_PASSWORD - Onap user password

To Run a command

Type oclip from linux console.

To Run in Interactive mode

Type oclip from linux console.

And use the directive set to set the values for following parameters:

host-url - Catalog service URL or a service URL
host-username - Service user name
host-password - Service password

Type onap <command> from Linux console.

To Run in Interactive mode

Type onap from linux console

Set the product version

CLI framework is enhanced to handle multiple product versions at same
-time. so to choose the product version, set evironment variable
-CLI_PROUDCT_VERSION.

NOTE: In interactive mode, product version can be selected using
-typing use <product-version>

Run onap [-v|–version] to see the CLI and available product version details

Help

onap [-h|–help]
-onap <command> [-h|–help]

Debug Mode

Set the product version

CLI framework is enhanced to handle multiple product versions at same time. so to choose the product version, set evironment variable OPEN_CLI_PROUDCT_IN_USE.

NOTE: In interactive mode, product version can be selected using typing use

Run oclip [-v|--version] to see the CLI and available product version details

Set the parameter values

Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values.

Help

oclip [-h|--help] oclip [-h|--help]

Debug Mode

To run in debug mode, set following environment variables:

OPEN_CLI_DEBUG - By default its false, otherwise Set to true
OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number

More details

https://wiki.onap.org

+More details +

+https://wiki.onap.org +

+To download +

Please download Open CLI Platform here

Click me here

To download

Please download ONAP CLI here

:::: + + + +[10] license-group-show +----------------------------------------------- + + +usage: onap license-group-show + +Details of the License Group + +Onap service: sdc v1.0 + +Options:: + + [-x | --license-model-id] [-y | --license-group-id] [-u | --onap-username] + [-p | --onap-password] [-m | --host-url] [-h | --help] + [-v | --version] [-d | --debug] [-f | --format] + [-s | --long] [-t | --no-title] [-a | --no-auth] + +where:: + +<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed + -x | --license-model-id Onap License Model ID. It is of type STRING. + -y | --license-group-id Onap License Group ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + ONAP_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + ONAP_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable ONAP_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. +======= + -x | --vsp-id Onap VSP ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_PASSWORD. Secured. + -m | --host-url Onap host url. It is of type URL. By default, it + is read from environment variable OPEN_HOST_URL. + -h | --help Onap command help message. It is of type STRING. + By default, it is false. + -v | --version Onap command service version. It is of type + STRING. By default, it is false. + -d | --debug Enable debug output. It is of type BOOL. By + default, it is false. + -f | --format Output formats, supported formats such as table, + csv, json, yaml. It is of type STRING. By + default, it is table. + -s | --long whether to print all attributes or only short + attributes. It is of type BOOL. By default, it is + false. + -t | --no-title whether to print title or not. It is of type + BOOL. By default, it is false. + -a | --no-auth whether to authenticate user or not. It is of + type BOOL. By default, it is false. +>>>>>>> Normalize all env with OPEN_CLI +>>>>>>> Normalize all env with OPEN_CLI + + +Results:: + +<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb <<<<<<< ab8942a839cc04dc8df1bf9cb19f375757f848b7 ID Entitlement Pool ID and is of type STRING. ======= @@ -7400,6 +7559,51 @@ Results:: -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable OPEN_PASSWORD. Secured. +======= +<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed + name License Group Name and is of type STRING. + ID License Group ID and is of type STRING. + description Description for the License Group and is of type + STRING. +======= + name VSP Name and is of type STRING. + ID VSP ID and is of type STRING. + description Description for the VSP and is of type STRING. + + +Error:: + + On error, it prints :::: + + + +vsp-submit +----------------------------------------------- + + +usage: onap vsp-submit + +Submit Vendor Software Product + +Onap service: sdc v1.0 + +Options:: + + [-x | --vsp-id] [-u | --onap-username] [-p | --onap-password] + [-m | --host-url] [-h | --help] [-v | --version] + [-d | --debug] [-f | --format] [-s | --long] + [-t | --no-title] [-a | --no-auth] + +where:: + + -x | --vsp-id Onap VSP ID. It is of type STRING. + -u | --onap-username Onap user name. It is of type STRING. By default, + it is read from environment variable + OPEN_CLI_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_PASSWORD. Secured. +>>>>>>> Normalize all env with OPEN_CLI -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -7418,8 +7622,12 @@ Results:: BOOL. By default, it is false. -a | --no-auth whether to authenticate user or not. It is of type BOOL. By default, it is false. +<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb >>>>>>> Migrate docs to use OPEN_ instead of ONAP_ >>>>>>> Migrate docs to use OPEN_ instead of ONAP_ +======= +>>>>>>> Normalize all env with OPEN_CLI +>>>>>>> Normalize all env with OPEN_CLI Error:: @@ -7450,10 +7658,17 @@ where:: -x | --customer-name Onap customer name. It is of type STRING. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable +<<<<<<< ece4fcf67742a307d5d68fbde1723f3e0485b7fb ONAP_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable ONAP_PASSWORD. Secured. +======= + OPEN_CLI_USERNAME. + -p | --onap-password Onap user password. It is of type STRING. By + default, it is read from environment variable + OPEN_CLI_PASSWORD. Secured. +>>>>>>> Normalize all env with OPEN_CLI -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable ONAP_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -7519,10 +7734,10 @@ where:: optional. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -7631,10 +7846,10 @@ where:: -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -7693,10 +7908,10 @@ where:: 6dc30068-de3c-483a-a9a8-7d483a39425d. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -7746,10 +7961,10 @@ where:: -y | --subscriber-name Onap subscriber name. It is of type STRING. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -7800,10 +8015,10 @@ where:: -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -7859,10 +8074,10 @@ where:: -x | --customer-name Onap customer name. It is of type STRING. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -7917,10 +8132,10 @@ where:: -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -7981,10 +8196,10 @@ where:: -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -8048,10 +8263,10 @@ where:: eb4a0d54-0e29-4174-8a3c-2c98e904a5f6. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -8105,10 +8320,10 @@ where:: b06576ca-74b8-42f2-815b-6f7b80f9941c. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -8156,10 +8371,10 @@ where:: -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. @@ -8231,10 +8446,10 @@ where:: optional. -u | --onap-username Onap user name. It is of type STRING. By default, it is read from environment variable - OPEN_USERNAME. + OPEN_CLI_USERNAME. -p | --onap-password Onap user password. It is of type STRING. By default, it is read from environment variable - OPEN_PASSWORD. Secured. + OPEN_CLI_PASSWORD. Secured. -m | --host-url Onap host url. It is of type URL. By default, it is read from environment variable OPEN_HOST_URL. -h | --help Onap command help message. It is of type STRING. diff --git a/docs/open_cli_schema_version_1_0.rst b/docs/open_cli_schema_version_1_0.rst index 42053730..8b365861 100644 --- a/docs/open_cli_schema_version_1_0.rst +++ b/docs/open_cli_schema_version_1_0.rst @@ -485,7 +485,7 @@ name: host-username long_option: host-username - default_value: ${HOST_USERNAME} + default_value: ${OPEN_CLI_HOST_USERNAME} is_optional: false @@ -500,7 +500,7 @@ name: host-password long_option: host-password - default_value: ${HOST_PASSWORD} + default_value: ${OPEN_CLI_HOST_PASSWORD} is_secured: true @@ -518,7 +518,7 @@ name: host-url is_optional: false - default_value: ${HOST_URL} + default_value: ${OPEN_CLI_HOST_URL} name: help ~~~~~~~~~~ diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 64554682..b82dd16b 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -13,8 +13,8 @@ Provides unified commands to operate ONAP from Linux console. Configure the following environment variables, before using it: 1. **OPEN_HOST_URL** - Onap Micro service bus(MSB) URL or a service URL -2. **OPEN_USERNAME** - Onap user name -3. **OPEN_PASSWORD** - Onap user password +2. **OPEN_CLI_USERNAME** - Onap user name +3. **OPEN_CLI_PASSWORD** - Onap user password To Run a command ----------------- diff --git a/framework/src/main/java/org/onap/cli/fw/error/OnapCommandProductVersionInvalid.java b/framework/src/main/java/org/onap/cli/fw/error/OnapCommandProductVersionInvalid.java index 2f970b5f..f3b949f1 100644 --- a/framework/src/main/java/org/onap/cli/fw/error/OnapCommandProductVersionInvalid.java +++ b/framework/src/main/java/org/onap/cli/fw/error/OnapCommandProductVersionInvalid.java @@ -19,7 +19,7 @@ package org.onap.cli.fw.error; import java.util.Set; /* - * ONAP command product version is invalid + * Open CLI command product version is invalid * */ public class OnapCommandProductVersionInvalid extends OnapCommandException { diff --git a/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java b/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java index 7baae094..bcb404fe 100644 --- a/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java +++ b/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java @@ -1062,8 +1062,8 @@ public class OnapCommandUtils { * help failed exception */ public static String help(OnapCommand cmd) throws OnapCommandHelpFailed { - //mrkanag refactor onap name into oclip - String help = "usage: onap " + cmd.getName(); + + String help = "usage: oclip " + cmd.getName(); // Add description help += "\n\n" + cmd.getDescription(); diff --git a/framework/src/main/resources/default_input_parameters_http.yaml b/framework/src/main/resources/default_input_parameters_http.yaml index 529053d0..81656ea0 100644 --- a/framework/src/main/resources/default_input_parameters_http.yaml +++ b/framework/src/main/resources/default_input_parameters_http.yaml @@ -5,14 +5,14 @@ parameters: description: Host user name short_option: u long_option: host-username - default_value: $s{env:HOST_USERNAME} + default_value: $s{env:OPEN_CLI_HOST_USERNAME} is_optional: false - name: host-password type: string description: Host user password short_option: p long_option: host-password - default_value: $s{env:HOST_PASSWORD} + default_value: $s{env:OPEN_CLI_HOST_PASSWORD} is_secured: true is_optional: false - name: host-url @@ -21,7 +21,7 @@ parameters: short_option: m long_option: host-url is_optional: false - default_value: $s{env:HOST_URL} + default_value: $s{env:OPEN_CLI_HOST_URL} - name: no-auth type: bool description: whether to authenticate user or not diff --git a/framework/src/test/resources/sample-cmd-test-help.txt b/framework/src/test/resources/sample-cmd-test-help.txt index 2523ce9b..fd36587d 100644 --- a/framework/src/test/resources/sample-cmd-test-help.txt +++ b/framework/src/test/resources/sample-cmd-test-help.txt @@ -1,4 +1,4 @@ -usage: onap sample-test +usage: oclip sample-test Onap sample command to test the command features diff --git a/main/src/main/resources/onap-readme.txt b/main/src/main/resources/onap-readme.txt index 39990700..ab4086b5 100644 --- a/main/src/main/resources/onap-readme.txt +++ b/main/src/main/resources/onap-readme.txt @@ -1,22 +1,22 @@ OPEN Command-line interface (CLI) ================================== - _____ _____ _ _____ + _____ _____ _ _____ | _ | / __ \| | |_ _| -| | | |_ __ ___ _ __ | / \/| | | | -| | | | '_ \ / _ \ '_ \ | | | | | | -\ \_/ / |_) | __/ | | | | \__/\| |_____| |_ - \___/| .__/ \___|_| |_| \____/\_____/\___/ - | | - |_| - +| | | |_ __ ___ _ __ | / \/| | | | +| | | | '_ \ / _ \ '_ \ | | | | | | +\ \_/ / |_) | __/ | | | | \__/\| |_____| |_ + \___/| .__/ \___|_| |_| \____/\_____/\___/ + | | + |_| + Provides unified commands to operate any cloud enabled software products from Linux/Web console. Configure the following environment variables, before using it: -1. HOST_URL - Catalog service URL or a service URL -2. HOST_USERNAME - Service user name -3. HOST_PASSWORD - Service password +1. OPEN_CLI_HOST_URL - Catalog service URL or a service URL +2. OPEN_CLI_HOST_USERNAME - Service user name +3. OPEN_CLI_HOST_PASSWORD - Service password To know the CLI version, type onap [-v|--version] To know the CLI usage, type onap [-h|--help] -- cgit 1.2.3-korg