From 64fcd4de113dea91cd36e0fb8ed74f001089a3a9 Mon Sep 17 00:00:00 2001 From: Vishvananda Ishaya Date: Thu, 7 Feb 2013 09:55:33 -0800 Subject: Add an extension to show the type of an ip. There is currently no way to differentiate a fixed ip from a floating ip in the servers list. This extension adds the OS-EXT-IPS:type param so that users can determine if it is a fixed address or a floating address. Fixes bug 1117784 DocImpact Change-Id: I8709a4f2f6792faa3d8e0cdcd330d751ef6633ae --- doc/api_samples/OS-EXT-IPS/server-get-resp.json | 55 +++++++++++++++++++++ doc/api_samples/OS-EXT-IPS/server-get-resp.xml | 19 ++++++++ doc/api_samples/OS-EXT-IPS/server-post-req.json | 16 ++++++ doc/api_samples/OS-EXT-IPS/server-post-req.xml | 19 ++++++++ doc/api_samples/OS-EXT-IPS/server-post-resp.json | 16 ++++++ doc/api_samples/OS-EXT-IPS/server-post-resp.xml | 6 +++ .../OS-EXT-IPS/servers-detail-resp.json | 57 ++++++++++++++++++++++ doc/api_samples/OS-EXT-IPS/servers-detail-resp.xml | 21 ++++++++ .../all_extensions/extensions-get-resp.json | 32 +++++++----- .../all_extensions/extensions-get-resp.xml | 24 +++++---- .../all_extensions/server-get-resp.json | 15 +++--- doc/api_samples/all_extensions/server-get-resp.xml | 8 +-- .../all_extensions/servers-details-resp.json | 15 +++--- .../all_extensions/servers-details-resp.xml | 10 ++-- 14 files changed, 268 insertions(+), 45 deletions(-) create mode 100644 doc/api_samples/OS-EXT-IPS/server-get-resp.json create mode 100644 doc/api_samples/OS-EXT-IPS/server-get-resp.xml create mode 100644 doc/api_samples/OS-EXT-IPS/server-post-req.json create mode 100644 doc/api_samples/OS-EXT-IPS/server-post-req.xml create mode 100644 doc/api_samples/OS-EXT-IPS/server-post-resp.json create mode 100644 doc/api_samples/OS-EXT-IPS/server-post-resp.xml create mode 100644 doc/api_samples/OS-EXT-IPS/servers-detail-resp.json create mode 100644 doc/api_samples/OS-EXT-IPS/servers-detail-resp.xml (limited to 'doc') diff --git a/doc/api_samples/OS-EXT-IPS/server-get-resp.json b/doc/api_samples/OS-EXT-IPS/server-get-resp.json new file mode 100644 index 000000000..e985ad115 --- /dev/null +++ b/doc/api_samples/OS-EXT-IPS/server-get-resp.json @@ -0,0 +1,55 @@ +{ + "server": { + "accessIPv4": "", + "accessIPv6": "", + "addresses": { + "private": [ + { + "OS-EXT-IPS:type": "fixed", + "addr": "192.168.0.3", + "version": 4 + } + ] + }, + "created": "2013-02-07T18:46:28Z", + "flavor": { + "id": "1", + "links": [ + { + "href": "http://openstack.example.com/openstack/flavors/1", + "rel": "bookmark" + } + ] + }, + "hostId": "4e2003eddbfdb1280c2618d04090bcdd6773203b8da8347af0b2723d", + "id": "dc7281f9-ee47-40b9-9950-9f73e7961caa", + "image": { + "id": "70a599e0-31e7-49b7-b260-868f441e862b", + "links": [ + { + "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b", + "rel": "bookmark" + } + ] + }, + "links": [ + { + "href": "http://openstack.example.com/v2/openstack/servers/dc7281f9-ee47-40b9-9950-9f73e7961caa", + "rel": "self" + }, + { + "href": "http://openstack.example.com/openstack/servers/dc7281f9-ee47-40b9-9950-9f73e7961caa", + "rel": "bookmark" + } + ], + "metadata": { + "My Server Name": "Apache1" + }, + "name": "new-server-test", + "progress": 0, + "status": "ACTIVE", + "tenant_id": "openstack", + "updated": "2013-02-07T18:46:29Z", + "user_id": "fake" + } +} \ No newline at end of file diff --git a/doc/api_samples/OS-EXT-IPS/server-get-resp.xml b/doc/api_samples/OS-EXT-IPS/server-get-resp.xml new file mode 100644 index 000000000..84619ffec --- /dev/null +++ b/doc/api_samples/OS-EXT-IPS/server-get-resp.xml @@ -0,0 +1,19 @@ + + + + + + + + + + Apache1 + + + + + + + + + \ No newline at end of file diff --git a/doc/api_samples/OS-EXT-IPS/server-post-req.json b/doc/api_samples/OS-EXT-IPS/server-post-req.json new file mode 100644 index 000000000..d88eb4122 --- /dev/null +++ b/doc/api_samples/OS-EXT-IPS/server-post-req.json @@ -0,0 +1,16 @@ +{ + "server" : { + "name" : "new-server-test", + "imageRef" : "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b", + "flavorRef" : "http://openstack.example.com/openstack/flavors/1", + "metadata" : { + "My Server Name" : "Apache1" + }, + "personality" : [ + { + "path" : "/etc/banner.txt", + "contents" : "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA==" + } + ] + } +} \ No newline at end of file diff --git a/doc/api_samples/OS-EXT-IPS/server-post-req.xml b/doc/api_samples/OS-EXT-IPS/server-post-req.xml new file mode 100644 index 000000000..0a3c8bb53 --- /dev/null +++ b/doc/api_samples/OS-EXT-IPS/server-post-req.xml @@ -0,0 +1,19 @@ + + + + Apache1 + + + + ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp + dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k + IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs + c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g + QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo + ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv + dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy + c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6 + b25zLiINCg0KLVJpY2hhcmQgQmFjaA== + + + \ No newline at end of file diff --git a/doc/api_samples/OS-EXT-IPS/server-post-resp.json b/doc/api_samples/OS-EXT-IPS/server-post-resp.json new file mode 100644 index 000000000..d641e74aa --- /dev/null +++ b/doc/api_samples/OS-EXT-IPS/server-post-resp.json @@ -0,0 +1,16 @@ +{ + "server": { + "adminPass": "zD7wDKTXiHsp", + "id": "b44e5008-42f7-4048-b4c8-f40a29da88ba", + "links": [ + { + "href": "http://openstack.example.com/v2/openstack/servers/b44e5008-42f7-4048-b4c8-f40a29da88ba", + "rel": "self" + }, + { + "href": "http://openstack.example.com/openstack/servers/b44e5008-42f7-4048-b4c8-f40a29da88ba", + "rel": "bookmark" + } + ] + } +} \ No newline at end of file diff --git a/doc/api_samples/OS-EXT-IPS/server-post-resp.xml b/doc/api_samples/OS-EXT-IPS/server-post-resp.xml new file mode 100644 index 000000000..b268ba0d3 --- /dev/null +++ b/doc/api_samples/OS-EXT-IPS/server-post-resp.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/doc/api_samples/OS-EXT-IPS/servers-detail-resp.json b/doc/api_samples/OS-EXT-IPS/servers-detail-resp.json new file mode 100644 index 000000000..cb91d6937 --- /dev/null +++ b/doc/api_samples/OS-EXT-IPS/servers-detail-resp.json @@ -0,0 +1,57 @@ +{ + "servers": [ + { + "accessIPv4": "", + "accessIPv6": "", + "addresses": { + "private": [ + { + "OS-EXT-IPS:type": "fixed", + "addr": "192.168.0.3", + "version": 4 + } + ] + }, + "created": "2013-02-07T18:40:59Z", + "flavor": { + "id": "1", + "links": [ + { + "href": "http://openstack.example.com/openstack/flavors/1", + "rel": "bookmark" + } + ] + }, + "hostId": "fe866a4962fe3bdb6c2db9c8f7dcdb9555aca73387e72b5cb9c45bd3", + "id": "76908712-653a-4d16-807e-d89d41435d24", + "image": { + "id": "70a599e0-31e7-49b7-b260-868f441e862b", + "links": [ + { + "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b", + "rel": "bookmark" + } + ] + }, + "links": [ + { + "href": "http://openstack.example.com/v2/openstack/servers/76908712-653a-4d16-807e-d89d41435d24", + "rel": "self" + }, + { + "href": "http://openstack.example.com/openstack/servers/76908712-653a-4d16-807e-d89d41435d24", + "rel": "bookmark" + } + ], + "metadata": { + "My Server Name": "Apache1" + }, + "name": "new-server-test", + "progress": 0, + "status": "ACTIVE", + "tenant_id": "openstack", + "updated": "2013-02-07T18:40:59Z", + "user_id": "fake" + } + ] +} \ No newline at end of file diff --git a/doc/api_samples/OS-EXT-IPS/servers-detail-resp.xml b/doc/api_samples/OS-EXT-IPS/servers-detail-resp.xml new file mode 100644 index 000000000..93a3ff2e9 --- /dev/null +++ b/doc/api_samples/OS-EXT-IPS/servers-detail-resp.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + Apache1 + + + + + + + + + + \ No newline at end of file diff --git a/doc/api_samples/all_extensions/extensions-get-resp.json b/doc/api_samples/all_extensions/extensions-get-resp.json index 439d1af18..e83fc566f 100644 --- a/doc/api_samples/all_extensions/extensions-get-resp.json +++ b/doc/api_samples/all_extensions/extensions-get-resp.json @@ -24,6 +24,14 @@ "namespace": "http://docs.openstack.org/compute/ext/extended_availability_zone/api/v2", "updated": "2013-01-30T00:00:00+00:00" }, + { + "alias": "OS-EXT-IPS", + "description": "Adds type parameter to the ip list.", + "links": [], + "name": "ExtendedIps", + "namespace": "http://docs.openstack.org/compute/ext/extended_ips/api/v1.1", + "updated": "2013-01-06T00:00:00+00:00" + }, { "alias": "OS-EXT-SRV-ATTR", "description": "Extended Server Attributes support.", @@ -90,11 +98,11 @@ }, { "alias": "os-availability-zone", - "description": "Add availability_zone to the Create Server v1.1 API.", + "description": "1. Add availability_zone to the Create Server v1.1 API.\n 2. Add availability zones describing.\n ", "links": [], "name": "AvailabilityZone", "namespace": "http://docs.openstack.org/compute/ext/availabilityzone/api/v1.1", - "updated": "2012-08-09T00:00:00+00:00" + "updated": "2012-12-21T00:00:00+00:00" }, { "alias": "os-baremetal-nodes", @@ -202,7 +210,7 @@ }, { "alias": "os-flavor-access", - "description": "Flavor access supprt.", + "description": "Flavor access support.", "links": [], "name": "FlavorAccess", "namespace": "http://docs.openstack.org/compute/ext/flavor_access/api/v2", @@ -336,14 +344,6 @@ "namespace": "http://docs.openstack.org/compute/ext/os-networks/api/v1.1", "updated": "2011-12-23T00:00:00+00:00" }, - { - "alias": "os-tenant-networks", - "description": "Tenant-based Network Management Extension.", - "links": [], - "name": "OSTenantNetworks", - "namespace": "http://docs.openstack.org/compute/ext/os-tenant-networks/api/v2", - "updated": "2011-12-23T00:00:00+00:00" - }, { "alias": "os-networks-associate", "description": "Network association support.", @@ -394,7 +394,7 @@ }, { "alias": "os-server-password", - "description": "Server password support", + "description": "Server password support.", "links": [], "name": "ServerPassword", "namespace": "http://docs.openstack.org/compute/ext/server-password/api/v2", @@ -424,6 +424,14 @@ "namespace": "http://docs.openstack.org/compute/ext/os-simple-tenant-usage/api/v1.1", "updated": "2011-08-19T00:00:00+00:00" }, + { + "alias": "os-tenant-networks", + "description": "Tenant-based Network Management Extension.", + "links": [], + "name": "OSTenantNetworks", + "namespace": "http://docs.openstack.org/compute/ext/os-tenant-networks/api/v2", + "updated": "2012-03-07T09:46:43-05:00" + }, { "alias": "os-used-limits", "description": "Provide data on limited resources that are being used.", diff --git a/doc/api_samples/all_extensions/extensions-get-resp.xml b/doc/api_samples/all_extensions/extensions-get-resp.xml index 71f79dc3a..0bd86e609 100644 --- a/doc/api_samples/all_extensions/extensions-get-resp.xml +++ b/doc/api_samples/all_extensions/extensions-get-resp.xml @@ -9,6 +9,9 @@ Extended Server Attributes support. + + Adds type parameter to the ip list. + Extended Server Attributes support. @@ -37,16 +40,17 @@ Admin-only aggregate administration. - - Add availability_zone to the Create Server v1.1 API. + + 1. Add availability_zone to the Create Server v1.1 API. + 2. Add availability zones describing. + Admin-only bare-metal node administration. - Enables cells-related functionality such as adding child cells, - listing child cells, getting the capabilities of the local cell, - and returning build plans to parent cells' schedulers + Enables cells-related functionality such as adding neighbor cells, + listing neighbor cells, and getting the capabilities of the local cell. @@ -91,7 +95,7 @@ Fixed IPs support. - Flavor access supprt. + Flavor access support. Instance type (flavor) extra specs. @@ -146,9 +150,6 @@ Network association support. - - Tenant-based Network Management Extension. - Quota classes management support. @@ -165,7 +166,7 @@ Allow Admins to view server diagnostics through server action. - Server password support + Server password support. Start/Stop instance compute API support. @@ -176,6 +177,9 @@ Simple tenant usage extension. + + Tenant-based Network Management Extension. + Provide data on limited resources that are being used. diff --git a/doc/api_samples/all_extensions/server-get-resp.json b/doc/api_samples/all_extensions/server-get-resp.json index 56feee209..f3dedd7d0 100644 --- a/doc/api_samples/all_extensions/server-get-resp.json +++ b/doc/api_samples/all_extensions/server-get-resp.json @@ -3,7 +3,7 @@ "OS-DCF:diskConfig": "AUTO", "OS-EXT-AZ:availability_zone": null, "OS-EXT-AZ:host_availability_zone": "nova", - "OS-EXT-SRV-ATTR:host": "9373c31dbfe6422d9a9997c5f42a8789", + "OS-EXT-SRV-ATTR:host": "b00875071c774b5487d217b82f03dfa2", "OS-EXT-SRV-ATTR:hypervisor_hostname": "fake-mini", "OS-EXT-SRV-ATTR:instance_name": "instance-00000001", "OS-EXT-STS:power_state": 1, @@ -14,13 +14,14 @@ "addresses": { "private": [ { + "OS-EXT-IPS:type": "fixed", "addr": "192.168.0.3", "version": 4 } ] }, "config_drive": "", - "created": "2013-01-30T14:03:57Z", + "created": "2013-02-07T18:58:56Z", "flavor": { "id": "1", "links": [ @@ -30,8 +31,8 @@ } ] }, - "hostId": "fc3a98f0b240ff341eb60ce8c0ae7412970d218381c5a827cfd398ee", - "id": "61608b15-33ea-412f-b9eb-78c6a347ec7b", + "hostId": "ecbf72ad08d0d4f26768f526d17c2813812b4bc1598f081e16eb9b8b", + "id": "12c05fea-29ec-4f77-9025-b3d72584ef1d", "image": { "id": "70a599e0-31e7-49b7-b260-868f441e862b", "links": [ @@ -44,11 +45,11 @@ "key_name": null, "links": [ { - "href": "http://openstack.example.com/v2/openstack/servers/61608b15-33ea-412f-b9eb-78c6a347ec7b", + "href": "http://openstack.example.com/v2/openstack/servers/12c05fea-29ec-4f77-9025-b3d72584ef1d", "rel": "self" }, { - "href": "http://openstack.example.com/openstack/servers/61608b15-33ea-412f-b9eb-78c6a347ec7b", + "href": "http://openstack.example.com/openstack/servers/12c05fea-29ec-4f77-9025-b3d72584ef1d", "rel": "bookmark" } ], @@ -64,7 +65,7 @@ ], "status": "ACTIVE", "tenant_id": "openstack", - "updated": "2013-01-30T14:04:01Z", + "updated": "2013-02-07T18:58:57Z", "user_id": "fake" } } \ No newline at end of file diff --git a/doc/api_samples/all_extensions/server-get-resp.xml b/doc/api_samples/all_extensions/server-get-resp.xml index 45e873147..8a2ddf4e3 100644 --- a/doc/api_samples/all_extensions/server-get-resp.xml +++ b/doc/api_samples/all_extensions/server-get-resp.xml @@ -1,5 +1,5 @@ - + @@ -11,11 +11,11 @@ - + - - + + diff --git a/doc/api_samples/all_extensions/servers-details-resp.json b/doc/api_samples/all_extensions/servers-details-resp.json index ed5f4d204..475bce39b 100644 --- a/doc/api_samples/all_extensions/servers-details-resp.json +++ b/doc/api_samples/all_extensions/servers-details-resp.json @@ -4,7 +4,7 @@ "OS-DCF:diskConfig": "AUTO", "OS-EXT-AZ:availability_zone": null, "OS-EXT-AZ:host_availability_zone": "nova", - "OS-EXT-SRV-ATTR:host": "94d2ccc30d73475ab987661158405463", + "OS-EXT-SRV-ATTR:host": "33924d68ef4e4214bb9bc200178d23b8", "OS-EXT-SRV-ATTR:hypervisor_hostname": "fake-mini", "OS-EXT-SRV-ATTR:instance_name": "instance-00000001", "OS-EXT-STS:power_state": 1, @@ -15,13 +15,14 @@ "addresses": { "private": [ { + "OS-EXT-IPS:type": "fixed", "addr": "192.168.0.3", "version": 4 } ] }, "config_drive": "", - "created": "2013-01-30T14:03:44Z", + "created": "2013-02-07T18:58:56Z", "flavor": { "id": "1", "links": [ @@ -31,8 +32,8 @@ } ] }, - "hostId": "f74e355ecde489405dfc0a1a48f2a85a5e2564e2ac6633d2b3e1b525", - "id": "033cc72d-708b-473b-ae8e-41064ea3fa21", + "hostId": "e0028a678cb7760fe5987947ab495dbb0f79c1071850f87a9aa8227f", + "id": "3ec52036-bfee-4869-9c4c-81a579d72196", "image": { "id": "70a599e0-31e7-49b7-b260-868f441e862b", "links": [ @@ -45,11 +46,11 @@ "key_name": null, "links": [ { - "href": "http://openstack.example.com/v2/openstack/servers/033cc72d-708b-473b-ae8e-41064ea3fa21", + "href": "http://openstack.example.com/v2/openstack/servers/3ec52036-bfee-4869-9c4c-81a579d72196", "rel": "self" }, { - "href": "http://openstack.example.com/openstack/servers/033cc72d-708b-473b-ae8e-41064ea3fa21", + "href": "http://openstack.example.com/openstack/servers/3ec52036-bfee-4869-9c4c-81a579d72196", "rel": "bookmark" } ], @@ -65,7 +66,7 @@ ], "status": "ACTIVE", "tenant_id": "openstack", - "updated": "2013-01-30T14:03:50Z", + "updated": "2013-02-07T18:58:57Z", "user_id": "fake" } ] diff --git a/doc/api_samples/all_extensions/servers-details-resp.xml b/doc/api_samples/all_extensions/servers-details-resp.xml index 47e452ba1..541f7aa5b 100644 --- a/doc/api_samples/all_extensions/servers-details-resp.xml +++ b/doc/api_samples/all_extensions/servers-details-resp.xml @@ -1,6 +1,6 @@ - - + + @@ -12,11 +12,11 @@ - + - - + + -- cgit