summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPhil Day <philip.day@hp.com>2013-04-04 18:00:49 +0100
committerPhil Day <philip.day@hp.com>2013-05-10 01:29:27 +0100
commit1b2c121f133b15d0fe3f6ebdb131ac9998bc4b83 (patch)
treedb349fc2ed3deabc5d5c380c49a6c82ce0fbafae /doc
parentb17715174e8cdd98fe336ee79660860890cf6dce (diff)
downloadnova-1b2c121f133b15d0fe3f6ebdb131ac9998bc4b83.tar.gz
nova-1b2c121f133b15d0fe3f6ebdb131ac9998bc4b83.tar.xz
nova-1b2c121f133b15d0fe3f6ebdb131ac9998bc4b83.zip
Allow a floating IP to be associated to a specific fixed IP
The current floating IP API extension only accepts the instance ID and the floating address to be assigned. Where the instance is connected to more than one network the behaviour is to associated the floating IP with the first fixed IP of the instances (and to log a warning) This change introduces a new extension which wehn loaded adds a fixed IP address as an optional parameter, allowing the floating IP to be associated with a specific fixed IP. Without this extension, or without the optional parameters, the API behaviour is unchanged. If specified the fixed IP must be associated with the instance. DocImpact Implements blueprint multi-nic-floating-ip-assignment Change-Id: I9241137ad794cdf7f452ed84e9445f0e11fdd44e
Diffstat (limited to 'doc')
-rw-r--r--doc/api_samples/all_extensions/extensions-get-resp.json8
-rw-r--r--doc/api_samples/all_extensions/extensions-get-resp.xml3
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.json0
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.xml0
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-create-req.json3
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-create-req.xml2
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-create-resp.json9
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-create-resp.xml2
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-list-empty-resp.json3
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-list-empty-resp.xml2
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-list-resp.json18
-rw-r--r--doc/api_samples/os-extended-floating-ips/floating-ips-list-resp.xml5
12 files changed, 55 insertions, 0 deletions
diff --git a/doc/api_samples/all_extensions/extensions-get-resp.json b/doc/api_samples/all_extensions/extensions-get-resp.json
index df8ed83e5..d7c2a646c 100644
--- a/doc/api_samples/all_extensions/extensions-get-resp.json
+++ b/doc/api_samples/all_extensions/extensions-get-resp.json
@@ -233,6 +233,14 @@
"updated": "2013-01-06T00:00:00+00:00"
},
{
+ "alias": "os-extended-floating-ips",
+ "description": "Adds optional fixed_address to the add floating IP command.",
+ "links": [],
+ "name": "ExtendedFloatingIps",
+ "namespace": "http://docs.openstack.org/compute/ext/extended_floating_ips/api/v2",
+ "updated": "2013-04-19T00:00:00+00:00"
+ },
+ {
"alias": "os-fixed-ips",
"description": "Fixed IPs support.",
"links": [],
diff --git a/doc/api_samples/all_extensions/extensions-get-resp.xml b/doc/api_samples/all_extensions/extensions-get-resp.xml
index 1ec2010dc..f6213a3a9 100644
--- a/doc/api_samples/all_extensions/extensions-get-resp.xml
+++ b/doc/api_samples/all_extensions/extensions-get-resp.xml
@@ -103,6 +103,9 @@
<extension alias="os-evacuate" updated="2013-01-06T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/evacuate/api/v2" name="Evacuate">
<description>Enables server evacuation.</description>
</extension>
+ <extension alias="os-extended-floating-ips" updated="2013-04-19T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/extended_floating_ips/api/v2" name="ExtendedFloatingIps">
+ <description>Adds optional fixed_address to the add floating IP command.</description>
+ </extension>
<extension alias="os-fixed-ips" updated="2012-10-18T13:25:27-06:00" namespace="http://docs.openstack.org/compute/ext/fixed_ips/api/v2" name="FixedIPs">
<description>Fixed IPs support.</description>
</extension>
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.json b/doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.json
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.json
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.xml b/doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.xml
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.xml
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-create-req.json b/doc/api_samples/os-extended-floating-ips/floating-ips-create-req.json
new file mode 100644
index 000000000..511b009be
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-create-req.json
@@ -0,0 +1,3 @@
+{
+ "pool": "nova"
+} \ No newline at end of file
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-create-req.xml b/doc/api_samples/os-extended-floating-ips/floating-ips-create-req.xml
new file mode 100644
index 000000000..f77525e74
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-create-req.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<pool>nova</pool> \ No newline at end of file
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-create-resp.json b/doc/api_samples/os-extended-floating-ips/floating-ips-create-resp.json
new file mode 100644
index 000000000..fe161a7dd
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-create-resp.json
@@ -0,0 +1,9 @@
+{
+ "floating_ip": {
+ "fixed_ip": null,
+ "id": 1,
+ "instance_id": null,
+ "ip": "10.10.10.1",
+ "pool": "nova"
+ }
+} \ No newline at end of file
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-create-resp.xml b/doc/api_samples/os-extended-floating-ips/floating-ips-create-resp.xml
new file mode 100644
index 000000000..e0f68ef50
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-create-resp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<floating_ip instance_id="None" ip="10.10.10.1" fixed_ip="None" id="1" pool="nova"/> \ No newline at end of file
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-list-empty-resp.json b/doc/api_samples/os-extended-floating-ips/floating-ips-list-empty-resp.json
new file mode 100644
index 000000000..121dbd084
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-list-empty-resp.json
@@ -0,0 +1,3 @@
+{
+ "floating_ips": []
+} \ No newline at end of file
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-list-empty-resp.xml b/doc/api_samples/os-extended-floating-ips/floating-ips-list-empty-resp.xml
new file mode 100644
index 000000000..da6f0d4ce
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-list-empty-resp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<floating_ips/> \ No newline at end of file
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-list-resp.json b/doc/api_samples/os-extended-floating-ips/floating-ips-list-resp.json
new file mode 100644
index 000000000..4d58e0676
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-list-resp.json
@@ -0,0 +1,18 @@
+{
+ "floating_ips": [
+ {
+ "fixed_ip": null,
+ "id": 1,
+ "instance_id": null,
+ "ip": "10.10.10.1",
+ "pool": "nova"
+ },
+ {
+ "fixed_ip": null,
+ "id": 2,
+ "instance_id": null,
+ "ip": "10.10.10.2",
+ "pool": "nova"
+ }
+ ]
+} \ No newline at end of file
diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-list-resp.xml b/doc/api_samples/os-extended-floating-ips/floating-ips-list-resp.xml
new file mode 100644
index 000000000..78348be55
--- /dev/null
+++ b/doc/api_samples/os-extended-floating-ips/floating-ips-list-resp.xml
@@ -0,0 +1,5 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<floating_ips>
+ <floating_ip instance_id="None" ip="10.10.10.1" fixed_ip="None" id="1" pool="nova"/>
+ <floating_ip instance_id="None" ip="10.10.10.2" fixed_ip="None" id="2" pool="nova"/>
+</floating_ips> \ No newline at end of file