aboutsummaryrefslogtreecommitdiffstats
path: root/docs/platform
diff options
context:
space:
mode:
Diffstat (limited to 'docs/platform')
-rw-r--r--docs/platform/cli-userguide/VFC_part/index.rst75
-rw-r--r--docs/platform/cli-userguide/cloud_complex/index.rst33
-rw-r--r--docs/platform/cli-userguide/config.json139
-rw-r--r--docs/platform/cli-userguide/create_csar_local/index.rst46
-rw-r--r--docs/platform/cli-userguide/create_csar_sdc/index.rst124
-rw-r--r--docs/platform/cli-userguide/create_service_customer/index.rst83
-rw-r--r--docs/platform/cli-userguide/index.rst86
-rw-r--r--docs/platform/cli-userguide/register_all_clouds/index.rst33
-rw-r--r--docs/platform/cli-userguide/register_vnfm/index.rst27
9 files changed, 646 insertions, 0 deletions
diff --git a/docs/platform/cli-userguide/VFC_part/index.rst b/docs/platform/cli-userguide/VFC_part/index.rst
new file mode 100644
index 00000000..322dbc2f
--- /dev/null
+++ b/docs/platform/cli-userguide/VFC_part/index.rst
@@ -0,0 +1,75 @@
+Cli VFC part Command Guide
+===============================
+
+1. VFC nslcm create
+-------------------
+
+::
+
+ usage: oclip vfc-nslcm-create
+ vfc nslcm create ns
+ Options:
+ [-n | --ns-csar-name] [-m | --host-url] [-c | --ns-csar-uuid]
+ [-C | --no-catalog] [-f | --format] [-h | --help]
+ [-V | --verify] [-t | --no-title] [-d | --debug]
+ [-v | --version] [-s | --long] [-D | --context]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ 'oclip vfc-nslcm-create -m {} -c {} -n {} -q {} -S {}'.format(parameters["vfc-url"], \
+ csar_id, ns.get("name"), parameters["customer_name"], parameters["service_name"])
+
+
+2. VFC nslcm instance
+---------------------
+
+::
+
+ usage: oclip vfc-nslcm-instance
+ vfc nslcm instance ns
+ Options:
+ [[-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-c | --location-constraints]
+ [-s | --long] [-D | --context] [-i | --ns-instance-id]
+ [-n | --sdn-controller-id]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ 'oclip vfc-nslcm-instantiate -m {} -i {} -c {} -n {}'.format(parameters["vfc-url"], \
+ ns_instance_id, parameters["location"], parameters["sdc-controller-id"])
+
+
+3. VFC nslcm terminate
+----------------------
+
+::
+
+ usage: oclip vfc-nslcm-terminate
+ vfc nslcm terminate ns
+ Options:
+ [[-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-c | --location-constraints]
+ [-s | --long] [-D | --context] [-i | --ns-instance-id]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ 'oclip vfc-nslcm-terminate -m {} -i {}'.format(parameters["vfc-url"], ns_instance_id)
+
+4. VFC nslcm delete
+----------------------
+
+::
+
+ usage: oclip vfc-nslcm-delete
+ vfc nslcm terminate ns
+ Options:
+ [[-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-c | --location-constraints]
+ [-s | --long] [-D | --context] [-c | --ns-instance-id]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ 'oclip vfc-nslcm-delete -m {} -c {}'.format(parameters["vfc-url"], ns_instance_id)
diff --git a/docs/platform/cli-userguide/cloud_complex/index.rst b/docs/platform/cli-userguide/cloud_complex/index.rst
new file mode 100644
index 00000000..75c5a03c
--- /dev/null
+++ b/docs/platform/cli-userguide/cloud_complex/index.rst
@@ -0,0 +1,33 @@
+Cli cloud complex Command Guide
+===============================
+
+1. complex-create
+-----------------
+
+::
+
+ usage: oclip complex-create
+ Create a cloud complex in Onap
+ Options:
+ [-V | --verify] [-f | --format] [-h | --help]
+ [-t | --no-title] [-j | --street2] [-v | --version]
+ [-r | --physical-location-type] [-s | --long] [-lt | --latitude]
+ [-x | --physical-location-id] [-y | --data-center-code] [-a | --no-auth]
+ [-l | --region] [-p | --host-password] [-m | --host-url]
+ [-C | --no-catalog] [-i | --street1] [-lo | --longitude]
+ [-d | --debug] [-S | --state] [-la | --lata]
+ [-D | --context] [-g | --city] [-w | --postal-code]
+ [-z | --complex-name] [-k | --country] [-o | --elevation]
+ [-u | --host-username] [-q | --identity-url]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ "oclip complex-create -j {} -r {} -x {} -y {} -lt {} -l {} -i {} -lo {} \
+ -S {} -la {} -g {} -w {} -z {} -k {} -o {} -q {} -m {} -u {} -p {}".format(parameters["street2"], \
+ parameters["physical_location"], parameters["complex_name"], \
+ parameters["data_center_code"], parameters["latitude"], parameters["region"], \
+ parameters["street1"], parameters["longitude"], parameters["state"], \
+ parameters["lata"], parameters["city"], parameters["postal-code"], \
+ parameters["complex_name"], parameters["country"], parameters["elevation"], \
+ parameters["identity_url"], parameters["aai_url"], parameters["aai_username"], \
+ parameters["aai_password"]) \ No newline at end of file
diff --git a/docs/platform/cli-userguide/config.json b/docs/platform/cli-userguide/config.json
new file mode 100644
index 00000000..bfb4bbde
--- /dev/null
+++ b/docs/platform/cli-userguide/config.json
@@ -0,0 +1,139 @@
+{
+ "open_cli_product" : "onap-dublin",
+ "open_cli_home" : "/opt/oclip",
+ "aai_url" : "https://10.12.5.54:30233",
+ "aai_username" : "AAI",
+ "aai_password" : "AAI",
+ "sdc_onboarding_url" : "http://10.43.89.129:8081",
+ "sdc_catalog_url" : "http://10.12.5.131:30205",
+ "sdc_password" : "demo123456!",
+ "sdc_creator" : "cs0008",
+ "sdc_tester" : "jm0007",
+ "sdc_governor" : "gv0001",
+ "sdc_operator" : "op0001",
+
+ "multicloud_url" : "http://10.12.5.131:30280",
+ "policy_url" : "https://10.12.5.131:30694",
+ "policy_username" : "testpdp",
+ "policy_password" : "alpha123",
+ "policy_directory" : "/opt/oclip/dublin/vcpe_policies",
+ "policy_scope" : "OSDF_DUBLIN",
+ "policy_onapName" : "SampleDemo",
+ "policy_config_type": "MicroService",
+ "policy_pdp_group" : "default",
+ "//" : "Put in a temp resource module name, should be the same in policy files, script will replace it in policies",
+ "temp_resource_module_name" : "resource_name",
+
+ "//" : "#Parameters required to create cloud complex",
+ "complex_name" : "clli1",
+ "street1" : "street1",
+ "street2" : "street2",
+ "physical_location" : "phy_type",
+ "data_center_code" : "code1",
+ "latitude" : "32.89948",
+ "longitude" : "97.045443",
+ "lata" : "example-lata-val-28399",
+ "elevation" : "example-elevation-val-28399",
+ "region" : "northwest",
+ "state" : "oregon",
+ "city" : "hillsboro",
+ "postal-code" : "00000",
+ "country" : "USA",
+ "identity_url" : "example-identity-url-val-56898",
+ "service-model-name" : "vfw-hpa",
+ "//" : "#Dictionary containing cloud regions and their Parameters",
+
+ "cloud_region_data":{
+ "ONAP-POD-01-Rail-07":{
+ "cloud-region-version" : "titanium_cloud",
+ "esr-system-info-id":"4c85ce1f-aa78-4ebf-8d6f-4b62773e9bc7",
+ "service-url": "http://10.12.11.1:5000/v3",
+ "user-name":"haibin_huang",
+ "password":"ONAP-pod-01_29:d4",
+ "system-type": "VIM",
+ "ssl-insecure":true,
+ "cloud-domain":"Default",
+ "default-tenant":"Integration-HPA",
+ "tenant-id" : "709ba629fe194f8699b12f9d6ffd86a0",
+ "cloud-type" : "openstack",
+ "identity-url": "WillBeUpdatedByMultiCloud",
+ "system-status":"active"
+ }
+ },
+
+ "//" : "#Parameters to register cloud region",
+ "cloud-owner" : "CloudOwner",
+ "owner-defined-type" : "t1",
+ "cloud-zone" : "CloudZone",
+
+ "service_name" : "vCPE",
+ "customer_name" : "hpa_cust",
+ "subscriber_name" : "hpa_cust",
+
+ "//" : "Onboarding parameters",
+ "vendor-name" : "Intel",
+ "entitlement-pool-name" : "hpa-pool",
+ "entitlement-description" : "hpa-pool",
+ "start-date" : "04/23/2019",
+ "expiry-date" : "12/31/2040",
+ "key-group-name" : "hpa-key",
+ "key-group-type" : "Universal",
+ "feature-grp-name" : "hpa-feature",
+ "feature-grp-desc" : "hpa-feature",
+ "part-no" : "hpa-part",
+ "agreement-name" : "hpa-agreement",
+ "agreement-desc" : "hpa-agreement",
+
+ "onboarding-method" : "NetworkPackage",
+
+ "//" : "Be sure to include single quotes in parameters that have spaces",
+ "project-code" : "000000",
+ "service-model-name" : "vcpe-hpa",
+ "service-model-desc" : "'hpa service model'",
+ "icon-id" : "network_l_1-3",
+ "category-display" : "'Network L1-3'",
+ "category" : "'network l1-3'",
+
+ "service-test-remarks" : "test",
+ "service-accept-remarks" : "accepted",
+ "service-approve-remarks" : "approved",
+
+ "//" : "#Parameters to vfc",
+ "vfc-url": "http://10.12.5.131:30280",
+ "vnfs":{
+ "vgw":{
+ "path": "/opt/oclip/csar_files/vgw.csar",
+ "csar-id": "9d3e4a5f-7e21-4714-9953-1376269832ba",
+ "vsp-name" : "vgw-hpa-vsp",
+ "vsp-desc" : "vgw-hpa-vsp-desc",
+ "vsp-version" : "1.0",
+ "vf-name" : "vgw-hpa-vf",
+ "vf-description" : "vgw-hpa-vf",
+ "vf-remarks" :"remarkss",
+ "vf-version" : "1.0",
+ "key": "key2",
+ "value": "value2"
+ }
+ },
+ "ns":{
+ "csar-id": "7857e876-3927-41b6-bf6b-ebbba749a404",
+ "key": "key1",
+ "value": "value1",
+ "path": "/opt/oclip/csar_files/ns_vgw.csar",
+ "name": "vcpe1"
+ },
+ "location": "CloudOwner_ONAP-POD-01-Rail-07",
+ "vnfm_params":{
+ "GVNFMDRIVER":{
+ "type": "gvnfmdriver",
+ "vendor": "vfc",
+ "version": "v1.0",
+ "url": "http://msb-iag:80/",
+ "vim-id": "CloudOwner_ONAP-POD-01-Rail-07",
+ "user-name": "admin",
+ "user-password": "admin",
+ "vnfm-version": "v1.0"
+ }
+ },
+ "sdc-controller-id": "2"
+}
diff --git a/docs/platform/cli-userguide/create_csar_local/index.rst b/docs/platform/cli-userguide/create_csar_local/index.rst
new file mode 100644
index 00000000..9bc5f0d7
--- /dev/null
+++ b/docs/platform/cli-userguide/create_csar_local/index.rst
@@ -0,0 +1,46 @@
+Cli cloud complex Command Guide
+===============================
+
+1. create-vnf-package
+---------------------
+
+::
+
+ usage: vfc-catalog-create-vnf
+ vfc create vnf
+ Options:
+ [-m | -m | --host-url]
+ [-c | -user-key]
+ [-e | -user-value]
+ [-C | --no-catalog]
+ [-f | --format] [-h | --help] [-V | --verify]
+ [-t | --no-title] [-d | --debug] [-v | --version]
+ [-s | --long] [-D | --context]
+ Error:
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ 'oclip vfc-catalog-create-vnf -m {} -c {} -e {}'.format(parameters["vfc-url"], \
+ vnf_values.get("key"), vnf_values.get("value"))
+
+
+2. create-ns-package
+---------------------
+
+::
+
+ usage: vfc-catalog-create-ns
+ vfc create ns
+ Options:
+ [-m | -m | --host-url]
+ [-c | -user-key]
+ [-e | -user-value]
+ [-C | --no-catalog]
+ [-f | --format] [-h | --help] [-V | --verify]
+ [-t | --no-title] [-d | --debug] [-v | --version]
+ [-s | --long] [-D | --context]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ 'oclip vfc-catalog-create-ns -m {} -c {} -e {}'.format(parameters["vfc-url"], \
+ ns.get("key"), ns.get("value"))
diff --git a/docs/platform/cli-userguide/create_csar_sdc/index.rst b/docs/platform/cli-userguide/create_csar_sdc/index.rst
new file mode 100644
index 00000000..1d18872a
--- /dev/null
+++ b/docs/platform/cli-userguide/create_csar_sdc/index.rst
@@ -0,0 +1,124 @@
+Cli Create Csar Command Guide
+===============================
+
+1. create-vlm
+---------------
+
+::
+
+ usage: oclip vlm-create
+ Create License Model
+ Options:
+ [-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-y | --description]
+ [-s | --long] [-D | --context] [-x | --vendor-name]
+ [-u | --host-username] [-a | --no-auth] [-p | --host-password]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ "oclip vlm-create -x {} -u {} -p {} -m {}".format(parameters["vendor-name"], \
+ parameters["sdc_creator"], parameters["sdc_password"], parameters["sdc_onboarding_url"])
+
+2. create-vsp
+---------------
+
+::
+
+ usage: oclip vsp-create
+ Create Vendor Software Product
+ Options:
+ [-m | --host-url] [-j | --vlm-feature-group-id] [-C | --no-catalog]
+ [-f | --format] [-h | --help] [-V | --verify]
+ [-t | --no-title] [-d | --debug] [-v | --version]
+ [-o | --onboarding-method] [-e | --vlm-vendor] [-x | --vsp-name]
+ [-y | --vsp-description] [-s | --long] [-D | --context]
+ [-i | --vlm-agreement-id] [-c | --vlm-version] [-u | --host-username]
+ [-a | --no-auth] [-g | --vlm-id] [-p | --host-password]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ "oclip vsp-create -j {} -o {} -e {} -x {} -y {} -i {} -c {} -g {} -u {} -p {} -m {}".format( in_list[0], \
+ parameters["onboarding-method"], parameters["vendor-name" ], value.get("vsp-name"), value.get("vsp-desc"), in_list[1], \
+ in_list[2], in_list[3], parameters["sdc_creator"], parameters["sdc_password"], parameters["sdc_onboarding_url"] )
+
+
+3. create-vf-model
+------------------
+
+::
+
+ usage: oclip vf-model-create
+ Create Virtual function from Vendor Software Product
+ Options:
+ [-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-y | --description]
+ [-g | --vsp-version] [-x | --name] [-s | --long]
+ [-D | --context] [-z | --vendor-name] [-u | --host-username]
+ [-a | --no-auth] [-b | --vsp-id] [-p | --host-password]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ "oclip vf-model-create -y {} -g {} -x {} -z {} -b {} -u {} -p {} -m {}".format(value.get("vf-description"), \
+ value.get("vsp-version"), value.get("vf-name"), parameters["vendor-name"], vsp_dict[name], \
+ parameters["sdc_creator"], parameters["sdc_password"], parameters["sdc_catalog_url"])
+
+4. create-service-model
+-----------------------
+
+::
+
+ usage: oclip service-model-create
+ Create Service model in SDC
+ Options:
+ [-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-z | --project-code]
+ [-y | --description] [-e | --icon-id] [-c | --category-display-name]
+ [-s | --long] [-D | --context] [-x | --service-name]
+ [-u | --host-username] [-a | --no-auth] [-b | --category]
+ [-p | --host-password]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ "oclip service-model-create -z {} -y {} -e {} -x {} -c {} -b {} -u {} -p {} -m {} |grep ID".format(parameters["project-code"], \
+ parameters["service-model-desc"], parameters["icon-id"], parameters["service-model-name"], parameters["category-display"], \
+ parameters["category"],parameters["sdc_creator"], parameters["sdc_password"], parameters["sdc_catalog_url"])
+
+5. vfc-catalog-onboard-vnf
+--------------------------
+
+::
+
+ usage: oclip vfc-catalog-onboard-vnf
+ vfc onboard vnf to catalog of vfc
+ Options:
+ [-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-s | --long]
+ [-D | --context] [-c | --vnf-csar-uuid]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ oclip vfc-catalog-onboard-vnf - -c {}'.format(value.get("csar-id"))
+
+
+6. vfc-catalog-onboard-ns
+--------------------------
+
+::
+
+ usage: oclip vfc-catalog-onboard-ns
+ vfc onboard ns to catalog of vfc
+ Options:
+ [-m | --host-url] [-c | --ns-csar-uuid] [-C | --no-catalog]
+ [-f | --format] [-h | --help] [-V | --verify]
+ [-t | --no-title] [-d | --debug] [-v | --version]
+ [-s | --long] [-D | --context]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ 'oclip vfc-catalog-onboard-ns -c {}'.format(parameters["ns"]["csar-id"])
+
+
diff --git a/docs/platform/cli-userguide/create_service_customer/index.rst b/docs/platform/cli-userguide/create_service_customer/index.rst
new file mode 100644
index 00000000..55489931
--- /dev/null
+++ b/docs/platform/cli-userguide/create_service_customer/index.rst
@@ -0,0 +1,83 @@
+Cli Create Service and Customer Command Guide
+=============================================
+
+1. create-service-type
+-----------------------
+
+::
+
+ usage: oclip service-type-create
+ Add a service type in Onap
+ Options:
+ [-m | --host-url] [-C | --no-catalog] [-x | --service-type]
+ [-f | --format] [-h | --help] [-V | --verify]
+ [-t | --no-title] [-d | --debug] [-v | --version]
+ [-y | --service-type-id] [-s | --long] [-D | --context]
+ [-u | --host-username] [-a | --no-auth] [-p | --host-password]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ "oclip service-type-create -x {} -m {} -u {} -p {}".format( parameters["service_name"], \
+ parameters["aai_url"], parameters["aai_username"], parameters["aai_password"])
+
+2. create-customer
+------------------
+
+::
+
+ usage: oclip customer-create
+ Create a customer in Onap
+ Options:
+ [-m | --host-url] [-y | --subscriber-name] [-C | --no-catalog]
+ [-f | --format] [-h | --help] [-V | --verify]
+ [-t | --no-title] [-d | --debug] [-v | --version]
+ [-x | --customer-name] [-s | --long] [-D | --context]
+ [-u | --host-username] [-a | --no-auth] [-p | --host-password]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ "oclip customer-create -x {} -y {} -m {} -u {} -p {}".format( parameters["customer_name"], \
+ parameters["subscriber_name"], parameters["aai_url"], parameters["aai_username"], parameters["aai_password"])
+
+
+3. add-customer-subscription(subscription not exist)
+----------------------------------------------------
+
+::
+
+ usage: oclip customer-create
+ Create a customer in Onap
+ Options:
+ [-m | --host-url] [-y | --subscriber-name] [-C | --no-catalog]
+ [-f | --format] [-h | --help] [-V | --verify]
+ [-t | --no-title] [-d | --debug] [-v | --version]
+ [-x | --customer-name] [-s | --long] [-D | --context]
+ [-u | --host-username] [-a | --no-auth] [-p | --host-password]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ "oclip subscription-create -x {} -c {} -z {} -e {} -y {} -r {} -m {} -u {} -p {}".format(\
+ parameters["customer_name"], cloud_region_values.get("tenant-id"), parameters["cloud-owner"], parameters["service_name"],\
+ cloud_region_values.get("default-tenant"), cloud_region, parameters["aai_url"], parameters["aai_username"], parameters["aai_password"] )
+
+4. add-customer-subscription(subscription existed)
+--------------------------------------------------
+
+::
+
+ usage: oclip subscription-cloud-add
+ Add a new cloud region to a customer subscription
+ Options:
+ [-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-V | --verify] [-t | --no-title]
+ [-d | --debug] [-v | --version] [-x | --customer-name]
+ [-c | --cloud-tenant-id] [-s | --long] [-D | --context]
+ [-z | --cloud-owner] [-e | --service-type] [-u | --host-username]
+ [-a | --no-auth] [-y | --tenant-name] [-r | --cloud-region]
+ [-p | --host-password]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ "oclip subscription-cloud-add -x {} -c {} -z {} -e {} -y {} -r {} -m {} -u {} -p {}".format(\
+ parameters["customer_name"], cloud_region_values.get("tenant-id"), parameters["cloud-owner"], parameters["service_name"],\
+ cloud_region_values.get("default-tenant"), cloud_region, parameters["aai_url"], parameters["aai_username"], parameters["aai_password"] )
diff --git a/docs/platform/cli-userguide/index.rst b/docs/platform/cli-userguide/index.rst
new file mode 100644
index 00000000..38b7204c
--- /dev/null
+++ b/docs/platform/cli-userguide/index.rst
@@ -0,0 +1,86 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+VFC-Test Cli Command Guide
+==========================
+
+Reference manual:
+
+1. https://onap.readthedocs.io/en/dublin/submodules/cli.git/docs/cmd_help_onap_dublin.html
+
+2. https://git.onap.org/cli/tree/products/onap-dublin
+
+Note:
+
+The config. JSON included in the folder is a data guarantee for the example in the guidance manual, which will be converted into Python recognizable object body through the json. load method. Use "parameters" to receive the converted results. (parameters = json. load (config))
+
+
+.. contents::
+ :depth: 2
+
+Create cloud complex
+--------------------
+
+More Cli command defination and reference can be found in the following page:
+
+.. toctree::
+ :maxdepth: 1
+
+ cloud_complex/index
+
+Register all clouds
+-------------------
+
+More Cli command defination and reference can be found in the following page:
+
+.. toctree::
+ :maxdepth: 1
+
+ register_all_clouds/index
+
+create service and customer
+---------------------------
+
+More Cli command defination and reference can be found in the following page:
+
+.. toctree::
+ :maxdepth: 1
+
+ create_service_customer/index
+
+Register vnfm
+-------------
+More Cli command defination and reference can be found in the following page:
+
+.. toctree::
+ :maxdepth: 1
+
+ register_vnfm/index
+
+Create csar file(by sdc)
+------------------------
+More Cli command defination and reference can be found in the following page:
+
+.. toctree::
+ :maxdepth: 1
+
+ create_csar_sdc/index
+
+Create csar file(by local)
+------------------------
+More Cli command defination and reference can be found in the following page:
+
+.. toctree::
+ :maxdepth: 1
+
+ create_csar_local/index
+
+VFC part
+-----------
+More Cli command defination and reference can be found in the following page:
+
+.. toctree::
+ :maxdepth: 1
+
+ VFC_part/index \ No newline at end of file
diff --git a/docs/platform/cli-userguide/register_all_clouds/index.rst b/docs/platform/cli-userguide/register_all_clouds/index.rst
new file mode 100644
index 00000000..34f978bf
--- /dev/null
+++ b/docs/platform/cli-userguide/register_all_clouds/index.rst
@@ -0,0 +1,33 @@
+Cli Regist Clouds Command Guide
+===============================
+
+1. Register-all-clouds
+----------------------
+
+::
+
+ usage: oclip cloud-create
+ Create a cloud region in Onap
+ Options:
+ [-e | --esr-id] [-V | --verify] [-f | --format]
+ [-h | --help] [-t | --no-title] [-v | --version]
+ [-c | --cloud-domain] [-s | --long] [-b | --user-name]
+ [-r | --owner-type] [-S | --sriov-automation] [-I | --extra-info]
+ [-x | --cloud-owner] [-Q | --system-type] [-y | --region-name]
+ [-j | --password] [-a | --no-auth] [-w | --cloud-region-version]
+ [-p | --host-password] [-m | --host-url] [-C | --no-catalog]
+ [-i | --identity-url] [-d | --debug] [-g | --cloud-zone]
+ [-l | --default-tenant] [-url | --service-url] [-n | --complex-name]
+ [-q | --cloud-type] [-D | --context] [-z | --ssl-insecure]
+ [-k | --system-status] [-u | --host-username]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ 'oclip cloud-create -e {} -b {} -I {{\\\\\\"openstack-region-id\\\\\\":\\\\\\"{}\\\\\\"}} \
+ -x {} -y {} -j {} -w {} -l {} -url {} -n {} -q {} -r {} -Q {} -i {} -g {} -z {} -k {} -c {} -m {} -u {} -p {}'.format(
+ values.get("esr-system-info-id"), values.get("user-name"), cloud_region, parameters["cloud-owner"], \
+ cloud_region, values.get("password"), values.get("cloud-region-version"), values.get("default-tenant"), \
+ values.get("service-url"), parameters["complex_name"], values.get("cloud-type"), parameters["owner-defined-type"], \
+ values.get("system-type"), values.get("identity-url"), parameters["cloud-zone"], values.get("ssl-insecure"), \
+ values.get("system-status"), values.get("cloud-domain"), parameters["aai_url"], parameters["aai_username"], \
+ parameters["aai_password"]) \ No newline at end of file
diff --git a/docs/platform/cli-userguide/register_vnfm/index.rst b/docs/platform/cli-userguide/register_vnfm/index.rst
new file mode 100644
index 00000000..f91cdaeb
--- /dev/null
+++ b/docs/platform/cli-userguide/register_vnfm/index.rst
@@ -0,0 +1,27 @@
+Cli Regist Vnfm Command Guide
+===============================
+
+1. Register-vnfm
+----------------
+
+::
+
+ usage: oclip vnfm-create
+ Register a VNFM in Onap
+ Options:
+ [-m | --host-url] [-C | --no-catalog] [-f | --format]
+ [-h | --help] [-e | --vendor] [-V | --verify]
+ [-t | --no-title] [-d | --debug] [-v | --version]
+ [-y | --vnfm-id] [-c | --type] [-x | --vim-id]
+ [-s | --long] [-D | --context] [-j | --password]
+ [-b | --name] [-i | --username] [-u | --host-username]
+ [-g | --url] [-a | --no-auth] [-q | --vnfm-version]
+ [-z | --certificate-url] [-p | --host-password]
+ Error:
+ On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
+ For example:
+ 'oclip vnfm-create -b {} -c {} -e {} -v {} -g {} -x {} -i {} -j {} -q {} \
+ -m {} -u {} -p {}'.format(vnfm_key, values.get("type"), values.get("vendor"), \
+ values.get("version"), values.get("url"), values.get("vim-id"), \
+ values.get("user-name"), values.get("user-password"), values.get("vnfm-version"), \
+ parameters["aai_url"], parameters["aai_username"], parameters["aai_password"])