X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2FMulticloud-Fake_Cloud-Guide.rst;h=52011a5f08e863b6138f448213b586ff0afd2837;hb=dca83b12781926d1bd958e01b3e3d29b3cc9e24e;hp=58d7a5ab64c93d32cb16834af735b5a38761c470;hpb=01ef914a27a68926f8db82f97c6872a0b3e3310d;p=multicloud%2Fframework.git diff --git a/docs/Multicloud-Fake_Cloud-Guide.rst b/docs/Multicloud-Fake_Cloud-Guide.rst index 58d7a5a..52011a5 100644 --- a/docs/Multicloud-Fake_Cloud-Guide.rst +++ b/docs/Multicloud-Fake_Cloud-Guide.rst @@ -1,15 +1,22 @@ +.. + This work is licensed under a Creative Commons Attribution 4.0 + International License. + ================================ MultiCloud Fake_Cloud User Case ================================ -multilcoud-vmware server not only provide vio plugin to access real openstack platform,but +multilcoud-vmware server not only provide vio plugin to access real openstack +platform,but also provide fake_cloud plugin which simulate thereal VIO function.The fake -cloud is suitable for testing openstack function if there is not real VIO platform. +cloud is suitable for testing openstack function if there is not real VIO +platform. -Make sure you environment have msb,aai service and multicloud-vmware config file has the right msb_ip and +Make sure you environment have msb,aai service and multicloud-vmware config +file has the right msb_ip and msb_port value,The config file path is vio/vio/pub/config/congfig.py @@ -17,95 +24,99 @@ msb_port value,The config file path is vio/vio/pub/config/congfig.py Register Fake Cloud to AAI ~~~~~~~~~~~~~~~~~~~~~~~~~~ -Register vio information into AAI service with region name "vmware" and region id "fake" - -.. 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" - } - ] - } - }" +Register vio information into AAI service with region name "vmware" and region +id "fake" + +.. 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" -H "Authorization:Basic QUFJOkFBSQ==" \ + https://aai_ip:aai_port/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/vmware/fake \ + -d "{ + "cloud-owner": "vmware", + "cloud-region-id": "fake", + "cloud-type": "vmware", + "cloud-region-version": "4.0", + "identity-url": "http://MSB_IP:MSB_PORT/api/multicloud/v0/vmware_fake/identity/v3", + "cloud-zone": "cloud zone", + "complex-name": "complex name", + "esr-system-info-list": { + "esr-system-info": [ + { + "system-name": "vmware-fake-cloud", + "type": "vim", + "service-url": "http://127.0.0.1:5000/v3", + "user-name": "admin", + "password": "vmware", + "system-type": "VIM", + "ssl-insecure": true, + "cloud-domain": "default", + "default-tenant": "admin", + } + ] + } + }" 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 ${fake_identiy_url}= "http://MSB_IP:MSB_PORT/api/multicloud/v0/vmware_fake/identity/v3" the ${msb_address} = "MSB_IP:MSB_PORT" Get auth token -------------- -# send request to multicloud-framework(broker) service to get token +# send request to multicloud-framework(broker) service to get token of keystone +V3 .. code-block:: console - $ curl -X POST -d @test.json -H 'Content-Type:application/json' ${fake_identiy_url} + $ curl -X POST -d @test.json -H 'Content-Type:application/json' http://MSB_IP:MSB_PORT/api/multicloud/v0/vmware_fake/identity/v3/auth/tokens test.json content example: :: - { - "auth": sudo pip install virtualenv{ - "scope": {"project": {"id": “”}}, - "identity": - { - "password": {"user": {"domain": {"name": “”}, "password": “”, "name": “”}}, "methods": ["password"] - } + { + "auth": { + "scope": {"project": {"id": “”}}, + "identity": + { + "password": {"user": {"domain": {"name": “”}, "password": “”, "name": “”}}, "methods": ["password"] + } + } } - } Response: -There are a large amounts of data including service endpoint, user information, etc. -For our testing We take nova and identity service endpoint address and auth token which is in response header named “X-Subject-Token”. +There are a large amounts of data including service endpoint, user information, +etc. +For our testing We take nova and identity service endpoint address and auth +token which is in response header named “X-Subject-Token”. + +# you can find the endpoint url namespace is +"api/multicloiud-vio/v0/vmware_fake", it represent the multicloud-vio service, +So requests sending to mulitcloud-vio will be forwarded to fake cloud.the ip +and port reprenst ${msb_address} -# you can find the endpoint url namespace is "api/multicloiud-vio/v0/vmware_fake", it represent the multicloud-vio service, So -requests sending to mulitcloud-vio will be forwarded to fake cloud.the ip and port reprenst ${msb_address} +Identity endpoint:: -Identity endpoint: - http://$msb_address/api/multicloud-vio/v0/vmware_fake/identity + http://$msb_address/api/multicloud-vio/v0/vmware_fake/identity -Nova endpoint: - http://$msb_address/api/multicloud-vio/v0/vmware_fake/compute/ +Nova endpoint:: + + http://$msb_address/api/multicloud-vio/v0/vmware_fake/compute/ List projects ------------- -Use identity’s endpoint: http://$msb_address/api/multicloud-vio/v0/vmware_fake/identity/ +Use identity’s endpoint: http://$msb_address/api/multicloud-vio/v0/vmware_fake/identity/ .. code-block:: console @@ -210,3 +221,99 @@ you need to input in url path $ curl -X POST -d '{"reboot":{"type":"HARD"}}' -H 'X-Auth-Token: -H 'Content-Type:application/json' http://$msb_address/api/multicloud-vio/v0/vmware_fake/nova//servers//action + +list heat stacks +---------------- + +.. code-block:: console + + $ curl -X GET -H 'X-Auth-Token:' http://$msb_address/api/multicloud-vio/v0/vmware_fake/heat//stacks + + +create preview stack +-------------------- + +.. code-block:: console + + $ curl -X POST -H 'X-Auth-Token:' http://$msb_address/api/multicloud-vio/v0/vmware_fake/heat//stacks/preview \ + -d "{ + "files": {}, + "disable_rollback": true, + "parameters": { + "flavor": "m1.heat" + }, + "stack_name": "teststack", + "template": { + "heat_template_version": "2013-05-23", + "description": "Simple template to test heat commands", + "parameters": { + "flavor": { + "default": "m1.tiny", + "type": "string" + } + }, + "resources": { + "hello_world": { + "type": "OS::Nova::Server", + "properties": { + "key_name": "heat_key", + "flavor": { + "get_param": "flavor" + }, + "image": "40be8d1a-3eb9-40de-8abd-43237517384f", + "user_data": "#!/bin/bash -xv\necho \"hello world\" > /root/hello-world.txt\n" + } + } + } + }, + "timeout_mins": 60 + }" + + +create stack +------------- + +.. code-block:: console + + $ curl -X POST -H 'X-Auth-Token:' http://$msb_address/api/multicloud-vio/v0/vmware_fake/heat//stacks \ + -d "{ + "files": {}, + "disable_rollback": true, + "parameters": { + "flavor": "m1.heat" + }, + "stack_name": "teststack", + "template": { + "heat_template_version": "2013-05-23", + "description": "Simple template to test heat commands", + "parameters": { + "flavor": { + "default": "m1.tiny", + "type": "string" + } + }, + "resources": { + "hello_world": { + "type": "OS::Nova::Server", + "properties": { + "key_name": "heat_key", + "flavor": { + "get_param": "flavor" + }, + "image": "40be8d1a-3eb9-40de-8abd-43237517384f", + "user_data": "#!/bin/bash -xv\necho \"hello world\" > /root/hello-world.txt\n" + } + } + } + }, + "timeout_mins": 60 + }" + + +delete stack +------------ + +.. code-block:: console + + $ curl -X DELETE -H 'X-Auth-Token:' http://$msb_address/api/multicloud-vio/v0/vmware_fake/heat//stacks// +