~0x44/nova/extdoc

« back to all changes in this revision

Viewing changes to nova/api/openstack/contrib/doc/ext_floating_ips.rst

  • Committer: Anne Gentle
  • Date: 2011-09-15 03:07:06 UTC
  • Revision ID: anne@openstack.org-20110915030706-oukxthnhst8xswnf
Adds extension documents for extensions in /contrib/doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
About This Extension
 
2
====================
 
3
The Floating IPs extension enables assigning and allocation of floating IP addresses to instances running in an OpenStack cloud. It is used with the OpenStack Compute 1.1 API to add or remove floating IP addresses on named instances. 
 
4
 
 
5
.. Are there any pre-requisites prior to using it such as special hardware or configuration?
 
6
 
 
7
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://mycloud.com/v1.1/tenant/extension.
 
8
 
 
9
Extension Overview
 
10
------------------
 
11
 
 
12
Name
 
13
        Floating IPs
 
14
        
 
15
Namespace
 
16
        http://docs.openstack.org/ext/floating_ips/api/v1.1
 
17
 
 
18
Alias
 
19
        OPS-FLO
 
20
        
 
21
Contact
 
22
        Name <sleepsonthefloor@gmail.com>
 
23
        
 
24
Status
 
25
        Alpha
 
26
        
 
27
Extension Version
 
28
        v1.0 (2011-09-14)
 
29
 
 
30
Dependencies
 
31
        Compute API 1.1
 
32
        
 
33
Doc Link (PDF)
 
34
        http://
 
35
        
 
36
Doc Link (WADL)
 
37
        http://
 
38
        
 
39
Short Description
 
40
        This extension enables assigning floating IP addresses to instances.
 
41
 
 
42
Sample Query Responses
 
43
----------------------
 
44
 
 
45
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension. 
 
46
 
 
47
Extension Query Response: XML::
 
48
 
 
49
 
 
50
Extension Query Response: JSON::
 
51
 
 
52
{"extensions": 
 
53
[{"updated": "2011-06-16T00:00:00+00:00", 
 
54
"name": "Floating_ips", 
 
55
"links": [], 
 
56
"namespace": "http://docs.openstack.org/ext/floating_ips/api/v1.1", 
 
57
"alias": "os-floating-ips", 
 
58
"description": "Floating IPs support"}]}
 
59
 
 
60
Document Change History
 
61
-----------------------
 
62
 
 
63
============= =====================================
 
64
Revision Date Summary of Changes
 
65
2011-09-14    Initial draft
 
66
============= =====================================
 
67
 
 
68
 
 
69
Summary of Changes
 
70
==================
 
71
This extension to the Compute API enables support for floating IP addresses.
 
72
 
 
73
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
 
74
 
 
75
New Action
 
76
----------
 
77
This extension uses POST to add or remove floating IP addresses to instances.
 
78
 
 
79
Normal Response Code: 202
 
80
 
 
81
addFloatingIp
 
82
 
 
83
removeFloatingIp
 
84
 
 
85
Include the response codes, transitions if applicable, and XML and JSON examples.
 
86
 
 
87
New Faults
 
88
----------
 
89
 
 
90
New Headers
 
91
-----------
 
92
 
 
93
New Resources
 
94
-------------
 
95
 
 
96
New States
 
97
----------
 
98
 
 
99
Changes to the Cloud Servers Specification
 
100
------------------------------------------
 
101
 
 
102
List the specific changes to the API. For example: 
 
103
 
 
104
In the List Addresses section of the Cloud Servers Specification: Examples 4.21 and 4.22 should be replaced with examples below. 
 
105
 
 
106
Provide examples in XML and JSON
 
 
b'\\ No newline at end of file'