summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-06-06 14:47:43 +0530
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-06-06 14:49:38 +0530
commit9c990574211bb7ed2e64ab8def47f7712db37b9b (patch)
tree99e04bc6d9194419a26c75e8991e467d767a8dad
parent2c8bf9a826b04f41a9367154660b0490103f1292 (diff)
Add docs for cli microservice-create
Issue-ID: CLI-115 Change-Id: Icf26cc0e669539ced886a98cccc8dfdefd5fec65 Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
-rw-r--r--docs/cmd_help_onap_beijing.rst81
1 files changed, 81 insertions, 0 deletions
diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst
index 550422d1..e1a47805 100644
--- a/docs/cmd_help_onap_beijing.rst
+++ b/docs/cmd_help_onap_beijing.rst
@@ -1749,6 +1749,87 @@ Error::
On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+microservice-create
+-----------------------------------------------
+
+
+usage: oclip microservice-create
+
+Register microservice into Onap
+
+Product: onap-beijing
+Service: msb
+Author: ONAP CLI Team onap-discuss@lists.onap.org
+
+Options::
+
+ [-m | --host-url] [-C | --no-catalog] [-h | --help]
+ [-f | --format] [-t | --no-title] [-V | --verify]
+ <create-or-update> [-v | --version] [-d | --debug]
+ [-c | --path] [-y | --service-version] <node-ip>
+ [-s | --long] [-D | --context] <node-port>
+ [-x | --service-name] [-r | --service-url] [-b | --enable-ssl]
+
+where::
+
+ -m | --host-url host url in http(s). It is of type URL. By
+ default, it is read from environment variable
+ OPEN_CLI_HOST_URL.
+ -C | --no-catalog Whether to use given host-url directly or
+ discover it from catalog, it will override the
+ service->mode. It is of type BOOL. It is
+ optional.
+ -h | --help print help message. It is of type BOOL.
+ -f | --format Output formats, supported formats such as table,
+ csv, json, yaml. It is of type STRING.
+ -t | --no-title whether to print title or not. It is of type BOOL.
+ -V | --verify Helps to verify the command using samples
+ provides under open-cli-samples directory. By
+ default, it goes with mock.To enable the
+ verification of samples in real time, set
+ DISABLE_MOCKING=true in the context parameter. It
+ is of type BOOL. It is optional.
+ create-or-update Onap service create or update. It is of type BOOL.
+ -v | --version print service version. It is of type BOOL.
+ -d | --debug Enable debug output. It is of type BOOL.
+ -c | --path Onap service path. It is of type STRING. It is
+ optional. By default, it is .
+ -y | --service-version Onap service version. It is of type STRING. By
+ default, it is .
+ node-ip Onap service running node IP. It is of type
+ STRING. By default, it is .
+ -s | --long whether to print all attributes or only short
+ attributes. It is of type BOOL.
+ -D | --context command context. It is of type MAP. It is
+ optional.
+ node-port Onap service running node port. It is of type
+ STRING. By default, it is .
+ -x | --service-name Onap service name. It is of type STRING. By
+ default, it is .
+ -r | --service-url Onap service base url. It is of type URL. By
+ default, it is .
+ -b | --enable-ssl Onap service is enabled with https or not. It is
+ of type STRING. It is optional. By default, it is
+ .
+
+
+Results::
+
+ name Onap service name and is of type STRING.
+ version Onap service version and is of type STRING.
+ url Onap service base url and is of type URL.
+ status Onap service status and is of type DIGIT.
+ nodes Onap service running nodes and is of type STRING.
+ enable-ssl Onap service is enabled with https or not and is
+ of type STRING.
+ path Onap service path and is of type STRING.
+
+
+Error::
+
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+
+
tenant-create
----------------------------------------------------