From 42fbfdc598d852e24c17edf2dfa89f73bdbf217e Mon Sep 17 00:00:00 2001 From: Ethan Lynn Date: Fri, 20 Oct 2017 13:52:45 +0800 Subject: [PATCH] Fix docs errors Change-Id: I730a0edf20a0c8641649f6d2a97319c22d41e846 issue-id: MULTICLOUD-117 Signed-off-by: Ethan Lynn --- docs/MultiCloud-API-Specification-V1.rst | 63 ++++++++++++++++---------------- docs/MultiCloud-Deployment-Guide.rst | 3 ++ docs/Multicloud-Fake_Cloud-Guide.rst | 61 +++++++++++++++---------------- 3 files changed, 64 insertions(+), 63 deletions(-) diff --git a/docs/MultiCloud-API-Specification-V1.rst b/docs/MultiCloud-API-Specification-V1.rst index 398d43f..cb3b32c 100644 --- a/docs/MultiCloud-API-Specification-V1.rst +++ b/docs/MultiCloud-API-Specification-V1.rst @@ -438,33 +438,33 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……} +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ | tenantId | M | 1 | String | Tenant UUID | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| 200: ok | | | -| | | | -| 500: failed | | | -| | | | -| { | | | -| | | | -| “vimid”:”” | | | -| | | | -| “vimname”:”” | | | -| | | | -| "imageList": [ | | | +| 200: ok | | | | | +| | | | | | +| 500: failed | | | | | +| | | | | | +| { | | | | | +| | | | | | +| “vimid”:”” | | | | | +| | | | | | +| “vimname”:”” | | | | | +| | | | | | +| "imageList": [ | | | | | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| { | | | +| { | | | | | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| "status": "active", | | +| "status": "active", | | | | | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| "id": "5e2757c1-f846-4727-915c-9a872553ed75", | +| "id": "5e2757c1-f846-4727-915c-9a872553ed75", | | | | | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| "size": 862016, | | +| "size": 862016, | | | | | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| "name": "vim-plus-cgsl40g-z.qcow2" | +| "name": "vim-plus-cgsl40g-z.qcow2" | | | | | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| } | | | +| } | | | | | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| ] | | | -| | | | -| } | | | +| ] | | | | | +| | | | | | +| } | | | | | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ 1. \ **Get Image** @@ -574,26 +574,25 @@ a} +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| { | | +| { | | | | | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “tenant”: “tenant1”, | | +| “tenant”: “tenant1”, | | | | | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “networkName”: “ommnet”, | +| “networkName”: “ommnet”, | | | | | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “shared”: 1, | | +| “shared”: 1, | | | | | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “vlanTransparent”: 1, | | +| “vlanTransparent”: 1, | | | | | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “networkType”:”vlan”, | | +| “networkType”:”vlan”, | | | | | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “segmentationId”:202, | | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “physicalNetwork”:”ctrl”, | | -| | | -| “routerExternal”:0 | | +| “segmentationId”:202, | | | | | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| “physicalNetwork”:”ctrl”, | | | | | +| | | | | | +| “routerExternal”:0 | | | | | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| } | | +| } | | | | | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 1. \ **Response** diff --git a/docs/MultiCloud-Deployment-Guide.rst b/docs/MultiCloud-Deployment-Guide.rst index 0160e1c..11c1e5f 100644 --- a/docs/MultiCloud-Deployment-Guide.rst +++ b/docs/MultiCloud-Deployment-Guide.rst @@ -325,6 +325,7 @@ Upload Image Task create uploading image task by image url: .. code-block:: console + $ curl -X POST -d '{"input": {"image_properties": {"container_format": "bare", "name": ""}, "import_from_format": "", @@ -335,6 +336,7 @@ create uploading image task by image url: get the taskid from response body,then query the task status by taskid. .. code-block:: console + $ curl -X GET -H 'X-Auth-Token:' http://$HOST_IP/api/multicloud-vio/v0//glance/v2/tasks/ You can see the description and properties of task in response body,if 'status' is success, it will show image_id in @@ -343,6 +345,7 @@ result block. query the image status by image_id .. code-block:: console + $ curl -X GET -H 'X-Auth-Token:' http://$HOST_IP/api/multicloud-vio/v0//glance/v2/images/ diff --git a/docs/Multicloud-Fake_Cloud-Guide.rst b/docs/Multicloud-Fake_Cloud-Guide.rst index 58d7a5a..dc8af4c 100644 --- a/docs/Multicloud-Fake_Cloud-Guide.rst +++ b/docs/Multicloud-Fake_Cloud-Guide.rst @@ -21,36 +21,35 @@ Register vio information into AAI service with region name "vmware" and region i .. code-block:: console -$ curl -X PUT -H "X-TransactionId":"get_aai_subr" -H "X-FromAppId":"AAI" -H "Accept":"application/json" \ - -H "Content-Type:"application/json" \ - https://aai_ip:aai_port/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/vmware/fake \ - - -d "{ - "cloud-owner": "vmware", - "cloud-region-id": "vio", - "cloud-type": "vmware", - "cloud-region-version": "4.0", - "identity-url": "http://MSB_IP:MSB_PORT/api/multicloud-vio/v0/vmware_fake/identity/v3", - "sriov-automation": false, - "resource-version": "1505892661724", - "esr-system-info-list": { - "esr-system-info": [ - { - "esr-system-info-id": "62e17285-c207-42b0-9d55-b472b274c254", - "system-name": "vim-fake-cloud", - "type": "vim", - "service-url": "http://127.0.0.1:5000/v3", - "user-name": "admin", - "password": "vmware", - "system-type": "vim", - "ssl-insecure": false, - "cloud-domain": "default", - "default-tenant": "admin", - "resource-version": "1505892661819" - } - ] - } - }" + $ curl -X PUT -H "X-TransactionId":"get_aai_subr" -H "X-FromAppId":"AAI" -H "Accept":"application/json" \ + -H "Content-Type:"application/json" \ + https://aai_ip:aai_port/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/vmware/fake \ + -d "{ + "cloud-owner": "vmware", + "cloud-region-id": "vio", + "cloud-type": "vmware", + "cloud-region-version": "4.0", + "identity-url": "http://MSB_IP:MSB_PORT/api/multicloud-vio/v0/vmware_fake/identity/v3", + "sriov-automation": false, + "resource-version": "1505892661724", + "esr-system-info-list": { + "esr-system-info": [ + { + "esr-system-info-id": "62e17285-c207-42b0-9d55-b472b274c254", + "system-name": "vim-fake-cloud", + "type": "vim", + "service-url": "http://127.0.0.1:5000/v3", + "user-name": "admin", + "password": "vmware", + "system-type": "vim", + "ssl-insecure": false, + "cloud-domain": "default", + "default-tenant": "admin", + "resource-version": "1505892661819" + } + ] + } + }" the identity url reprent the fake cloud identity url. @@ -58,7 +57,7 @@ the identity url reprent the fake cloud identity url. Test Examples -~~~~~~~~~~~~ +~~~~~~~~~~~~~ the ${fake_identiy_url}= "http://MSB_IP:MSB_PORT/api/multicloud-vio/v0/vmware_fake/identity/v3" the ${msb_address} = "MSB_IP:MSB_PORT" -- 2.16.6