← Back to branch summary

~gandelman-a/ubuntu/precise/nova/UCA_2012.2.1

« back to all changes in this revision

Viewing changes to doc/source/api_ext/ext_floating_ip_dns.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-05-24 13:12:53 UTC
  • mfrom: (1.1.55)
  • Revision ID: package-import@ubuntu.com-20120524131253-ommql08fg1en06ut
Tags: 2012.2~f1-0ubuntu1
https://launchpad.net/bugs/907197
* New upstream release.
* Prepare for quantal:
  - Dropped debian/patches/upstream/0006-Use-project_id-in-ec2.cloud._format_image.patch
  - Dropped debian/patches/upstream/0005-Populate-image-properties-with-project_id-again.patch
  - Dropped debian/patches/upstream/0004-Fixed-bug-962840-added-a-test-case.patch
  - Dropped debian/patches/upstream/0003-Allow-unprivileged-RADOS-users-to-access-rbd-volumes.patch
  - Dropped debian/patches/upstream/0002-Stop-libvirt-test-from-deleting-instances-dir.patch
  - Dropped debian/patches/upstream/0001-fix-bug-where-nova-ignores-glance-host-in-imageref.patch 
  - Dropped debian/patches/0001-fix-useexisting-deprecation-warnings.patch
* debian/control: Add python-keystone as a dependency. (LP: #907197)
* debian/patches/kombu_tests_timeout.patch: Refreshed.
* debian/nova.conf, debian/nova-common.postinst: Convert to new ini
  file configuration
* debian/patches/nova-manage_flagfile_location.patch: Refreshed

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/api_ext/ext_floating_ip_dns.rst
1
 
The Floating IP DNS Extension
2
 
=================================================================
3
 
About this Extension
4
 
--------------------
5
 
The Floating IP DNS extension provides an interface for managing DNS records associated with IP addresses
6
 
allocated by the Floating Ips extension.  Requests are dispatched to a DNS driver selected at startup.
7
 
 
8
 
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.
9
 
 
10
 
Extension Overview
11
 
~~~~~~~~~~~~~~~~~~
12
 
 
13
 
Name
14
 
        Floating IP DNS
15
 
 
16
 
Namespace
17
 
        http://docs.openstack.org/ext/floating_ip_dns/api/v1.1
18
 
 
19
 
Alias
20
 
        OPS-DNS
21
 
 
22
 
Contact
23
 
        Andrew Bogott <abogott@wikimedia.org>
24
 
 
25
 
Status
26
 
        Alpha
27
 
 
28
 
Extension Version
29
 
        v1.0 (2011-12-22)
30
 
 
31
 
Dependencies
32
 
        Compute API v1.1
33
 
        Floating IPs Extension, v1.0
34
 
 
35
 
Doc Link (PDF)
36
 
        http://
37
 
 
38
 
Doc Link (WADL)
39
 
        http://
40
 
 
41
 
Short Description
42
 
        This extension enables associated DNS entries with floating IPs.
43
 
 
44
 
Sample Query Responses
45
 
~~~~~~~~~~~~~~~~~~~~~~
46
 
 
47
 
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
48
 
 
49
 
Extension Query Response: XML::
50
 
 
51
 
        None
52
 
 
53
 
Extension Query Response: JSON::
54
 
 
55
 
        {'extensions':
56
 
        [{'updated': '2011-12-23T00:00:00+00:00',
57
 
        'name': 'Floating_ip_dns',
58
 
        'links': [],
59
 
        'namespace': 'http://docs.openstack.org/ext/floating_ip_dns/api/v1.1',
60
 
        'alias': 'os-floating-ip_dns',
61
 
        'description': 'Floating IP DNS support'}]}
62
 
 
63
 
Document Change History
64
 
~~~~~~~~~~~~~~~~~~~~~~~
65
 
 
66
 
============= =====================================
67
 
Revision Date Summary of Changes
68
 
2011-12-23    Initial draft
69
 
2012-03-30    Reformat of content
70
 
============= =====================================
71
 
 
72
 
 
73
 
Summary of Changes
74
 
------------------
75
 
This extension to the Compute API enables management of DNS entries for floating IP addresses.
76
 
 
77
 
This support is provided by the addition of new resources.
78
 
 
79
 
New Actions
80
 
~~~~~~~~~~~
81
 
None
82
 
 
83
 
New Faults
84
 
~~~~~~~~~~
85
 
None
86
 
 
87
 
New Headers
88
 
~~~~~~~~~~~
89
 
None
90
 
 
91
 
New Resources
92
 
~~~~~~~~~~~~~
93
 
Get a list of registered DNS Domains published by the DNS drivers::
94
 
 
95
 
    GET /v1.1/<tenant_id>/os-floating-ip-dns/
96
 
 
97
 
    # Sample Response:
98
 
    {'domain_entries' : [
99
 
      {'domain': 'domain1.example.org', 'scope': 'public', 'project': 'proj1'}
100
 
      {'domain': 'domain2.example.net', 'scope': 'public', 'project': 'proj2'}
101
 
      {'domain': 'example.net', 'scope': 'public', 'project': ''}
102
 
      {'domain': 'example.internal', 'scope': 'private', 'availability_zone': 'zone1'}]}
103
 
 
104
 
 
105
 
Create or modify a DNS domain::
106
 
 
107
 
    PUT /v1.1/<tenant_id>/os-floating-ip-dns/<domain>
108
 
 
109
 
    # Sample body, public domain:
110
 
     {'domain_entry' :
111
 
       {'scope': 'public',
112
 
        'project' : 'project1'}}
113
 
 
114
 
    # Sample body, public (projectless) domain:
115
 
     {'domain_entry' :
116
 
       {'scope': 'public'}}
117
 
 
118
 
    # Sample Response, public domain (success):
119
 
     {'domain_entry' :
120
 
       {'domain': 'domain1.example.org',
121
 
        'scope': 'public',
122
 
        'project': 'project1'}}
123
 
 
124
 
    # Sample body, private domain:
125
 
     {'domain_entry' :
126
 
       {'scope': 'private',
127
 
        'availability_domain': 'zone1'}}
128
 
 
129
 
    # Sample Response, private domain (success):
130
 
     {'domain_entry' :
131
 
       {'domain': 'domain1.private',
132
 
        'scope': 'private',
133
 
        'availability_zone': 'zone1'}}
134
 
 
135
 
    Failure Response Code: 403 (Insufficient permissions.)
136
 
 
137
 
 
138
 
Delete a DNS domain and all associated host entries::
139
 
 
140
 
    DELETE /v1.1/<tenant_id>/os-floating-ip-dns/<domain>
141
 
 
142
 
    Normal Response Code: 200
143
 
    Failure Response Code: 404 (Domain to be deleted not found.)
144
 
    Failure Response Code: 403 (Insufficient permissions to delete.)
145
 
 
146
 
 
147
 
Create or modify a DNS entry::
148
 
 
149
 
    PUT /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries/<name>
150
 
 
151
 
    # Sample body:
152
 
    { 'dns_entry' :
153
 
      { 'ip': '192.168.53.11',
154
 
        'dns_type': 'A' }}
155
 
 
156
 
    # Sample Response (success):
157
 
    { 'dns_entry' :
158
 
      { 'type' : 'A',
159
 
        'name' : 'instance1' }}
160
 
 
161
 
 
162
 
Find unique DNS entry for a given domain and name::
163
 
 
164
 
    GET /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries/<name>
165
 
 
166
 
    # Sample Response:
167
 
    { 'dns_entry' :
168
 
      { 'ip' : '192.168.53.11',
169
 
        'type' : 'A',
170
 
        'domain' : <domain>,
171
 
        'name' : <name> }}
172
 
 
173
 
 
174
 
Find DNS entries for a given domain and ip::
175
 
 
176
 
    GET /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries?ip=<ip>
177
 
 
178
 
    # Sample Response:
179
 
    { 'dns_entries' : [
180
 
      { 'ip' : <ip>,
181
 
        'type' : 'A',
182
 
        'domain' : <domain>,
183
 
        'name' : 'example1' }
184
 
      { 'ip' : <ip>,
185
 
        'type' : 'A',
186
 
        'domain' : <domain>,
187
 
        'name' : 'example2' }]}
188
 
 
189
 
 
190
 
Delete a DNS entry::
191
 
 
192
 
    DELETE /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries/<name>
193
 
 
194
 
    Normal Response Code: 200
195
 
    Failure Response Code: 404 (Entry to be deleted not found)
196
 
 
197
 
New States
198
 
~~~~~~~~~~
199
 
None
200
 
 
201
 
Changes to the Cloud Servers Specification
202
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
203
 
None