Merge "Adds extension documentation for some but not all extensions"
This commit is contained in:
Jenkins
207
doc/source/api_ext/ext_config_drive.rst
Normal file
207
doc/source/api_ext/ext_config_drive.rst
Normal file
@@ -0,0 +1,207 @@
|
||||
About This Extension
|
||||
====================
|
||||
The config-drive extension enables attaching a separate drive to the Compute guest on instance create. It is used with the OpenStack Compute 1.1 API to write configuration data into guest for those guests whose root filesystems cannot be mounted by the Compute host.
|
||||
|
||||
To use this extension, you must have installed Compute, with libvirt or Xen using local disk.
|
||||
|
||||
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/extensions.
|
||||
|
||||
Extension Overview
|
||||
------------------
|
||||
|
||||
Name
|
||||
Config Drive
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/ext/config-drive/api/v1.1
|
||||
|
||||
Alias
|
||||
ORG-EXT
|
||||
|
||||
Contact
|
||||
Christopher MacGown <chris@pistoncloud.com>
|
||||
|
||||
Status
|
||||
Alpha
|
||||
|
||||
Extension Version
|
||||
v1.0 (2011-09-16)
|
||||
|
||||
Dependencies
|
||||
Compute API 1.1
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables the assignment of config-drives to a compute guest on instance create running in an OpenStack cloud.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-16 Initial draft
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the OpenStack Compute API allows the addition of a configuration drive to an instance.
|
||||
|
||||
New Action
|
||||
----------
|
||||
None
|
||||
|
||||
New Faults
|
||||
----------
|
||||
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
This extension to the OpenStack Compute API adds the following resources:
|
||||
|
||||
A config_drive attribute to the servers API that is None by default, but can optionally be True or the imageRef of a config-drive image.
|
||||
|
||||
Upon instance create, a guest built with a True config_drive attribute will create a local volume and partition it as a fat32 drive, all passed in metadata, networks, and keys will be written to the config_drive which is associated as the last available disk on the instance.
|
||||
Upon instance create, a guest built with an imageRef config_drive attribute will create a local volume from the image.
|
||||
|
||||
New States
|
||||
----------
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
|
||||
In section 4.1.2 (Create Servers) of the API Specification: Examples 4.3 and 4.4 should optionally add the config-drive attribute as in the below examples:
|
||||
|
||||
|
||||
Example XML with config_drive attribute = True::
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<server xmlns="http://docs.openstack.org/compute/api/v1.1"
|
||||
imageRef="http://servers.api.openstack.org/1234/images/52415800-8b69-11e0-9b19-734f6f006e54"
|
||||
flavorRef="52415800-8b69-11e0-9b19-734f1195ff37"
|
||||
name="new-server-test"
|
||||
config=drive="True"
|
||||
>
|
||||
<metadata>
|
||||
<meta key="My Server Name">Apache1</meta>
|
||||
</metadata>
|
||||
<personality>
|
||||
<file path="/etc/banner.txt">
|
||||
ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
|
||||
dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
|
||||
IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
|
||||
c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
|
||||
QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
|
||||
ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
|
||||
dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
|
||||
c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
|
||||
b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
|
||||
</file>
|
||||
</personality>
|
||||
</server>
|
||||
|
||||
Example XML with config_drive attribute is an imageRef::
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<server xmlns="http://docs.openstack.org/compute/api/v1.1"
|
||||
imageRef="http://servers.api.openstack.org/1234/images/
|
||||
52415800-8b69-11e0-9b19-734f6f006e54"
|
||||
flavorRef="52415800-8b69-11e0-9b19-734f1195ff37"
|
||||
name="new-server-test"
|
||||
config_drive="http://servers.api.openstack.org/1234/images/52415800-8b69-1341-9b19-734f6f006e54"
|
||||
>
|
||||
<metadata>
|
||||
<meta key="My Server Name">Apache1</meta>
|
||||
</metadata>
|
||||
<personality>
|
||||
<file path="/etc/banner.txt">
|
||||
ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
|
||||
dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
|
||||
IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
|
||||
c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
|
||||
QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
|
||||
ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
|
||||
dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
|
||||
c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
|
||||
b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
|
||||
</file>
|
||||
</personality>
|
||||
</server>
|
||||
|
||||
|
||||
Example JSON with config_drive attribute is true::
|
||||
|
||||
{
|
||||
"server" : {
|
||||
"name" : "new-server-test",
|
||||
"imageRef" : "http://servers.api.openstack.org/1234/images/52415800-8b69-11e0-9b19-734f6f006e54",
|
||||
"flavorRef" : "52415800-8b69-11e0-9b19-734f1195ff37",
|
||||
"config_drive" : "true",
|
||||
"metadata" : {
|
||||
"My Server Name" : "Apache1"
|
||||
},
|
||||
"personality" : [
|
||||
{
|
||||
"path" : "/etc/banner.txt",
|
||||
"contents" : "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
|
||||
dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
|
||||
IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
|
||||
c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
|
||||
QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
|
||||
ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
|
||||
dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
|
||||
c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
|
||||
b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
Example JSON with config_drive attribute is an imageRef::
|
||||
|
||||
{
|
||||
"server" : {
|
||||
"name" : "new-server-test",
|
||||
"imageRef" : "http://servers.api.openstack.org/1234/images/52415800-8b69-11e0-9b19-734f6f006e54",
|
||||
"flavorRef" : "52415800-8b69-11e0-9b19-734f1195ff37",
|
||||
"config_drive" : "http://servers.api.openstack.org/1234/images/52415800-8b69-11e0-9b19-734f6f006e54",
|
||||
"metadata" : {
|
||||
"My Server Name" : "Apache1"
|
||||
},
|
||||
"personality" : [
|
||||
{
|
||||
"path" : "/etc/banner.txt",
|
||||
"contents" : "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
|
||||
dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
|
||||
IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
|
||||
c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
|
||||
QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
|
||||
ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
|
||||
dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
|
||||
c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
|
||||
b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
162
doc/source/api_ext/ext_floating_ips.rst
Normal file
162
doc/source/api_ext/ext_floating_ips.rst
Normal file
@@ -0,0 +1,162 @@
|
||||
About The Floating IPs Extension
|
||||
================================
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
Floating IPs Extension Overview
|
||||
-------------------------------
|
||||
|
||||
Name
|
||||
Floating IPs
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/ext/floating_ips/api/v1.1
|
||||
|
||||
Alias
|
||||
OPS-FLO
|
||||
|
||||
Contact
|
||||
Anthony Young <sleepsonthefloor@gmail.com>
|
||||
|
||||
Status
|
||||
Alpha
|
||||
|
||||
Extension Version
|
||||
v1.0 (2011-09-14)
|
||||
|
||||
Dependencies
|
||||
Compute API 1.1
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables assigning floating IP addresses to instances.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
None
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
{"extensions":
|
||||
[{"updated": "2011-06-16T00:00:00+00:00",
|
||||
"name": "Floating_ips",
|
||||
"links": [],
|
||||
"namespace": "http://docs.openstack.org/ext/floating_ips/api/v1.1",
|
||||
"alias": "os-floating-ips",
|
||||
"description": "Floating IPs support"}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-14 Initial draft
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the Compute API enables support for floating IP addresses.
|
||||
|
||||
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
|
||||
|
||||
New Action
|
||||
----------
|
||||
This extension uses POST to add or remove floating IP addresses to instances.
|
||||
|
||||
Normal Response Code: 202
|
||||
|
||||
addFloatingIp
|
||||
|
||||
removeFloatingIp
|
||||
|
||||
Include the response codes, transitions if applicable, and XML and JSON examples.
|
||||
|
||||
New Faults
|
||||
----------
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
This extension provides an os-floating-ips resource extension to do the following:
|
||||
|
||||
List a tenant's floating ips::
|
||||
|
||||
GET /v1.1/tenant_id/os-floating-ips/
|
||||
|
||||
# Sample Response:
|
||||
{ "floating_ips" : [ { "fixed_ip" : "10.0.0.3",
|
||||
"id" : 1,
|
||||
"instance_id" : 1,
|
||||
"ip" : "10.6.0.0"
|
||||
},
|
||||
{ "fixed_ip" : null,
|
||||
"id" : 2,
|
||||
"instance_id" : null,
|
||||
"ip" : "10.6.0.1"
|
||||
}
|
||||
] }
|
||||
|
||||
Normal Response Code: 200
|
||||
|
||||
Allocate a floating ip to a tenant::
|
||||
|
||||
POST /v1.1/tenant_id/os-floating-ips/
|
||||
|
||||
# Sample Response:
|
||||
{ "floating_ip" : { "fixed_ip" : "10.0.0.3",
|
||||
"id" : 1,
|
||||
"instance_id" : 1,
|
||||
"ip" : "10.6.0.0"
|
||||
}}
|
||||
|
||||
If there are no floating ips available, 400 will be returned, with a
|
||||
message indicating that no more floating ips are available
|
||||
|
||||
|
||||
De-allocate a floating ip from a tenant::
|
||||
|
||||
DELETE /v1.1/tenant_id/os-floating-ips/id
|
||||
|
||||
Normal Response Code: 202
|
||||
|
||||
Show a floating ip::
|
||||
|
||||
GET /v1.1/tenant_id/os-floating-ips/id
|
||||
|
||||
# Sample Response:
|
||||
{ "floating_ip" : { "fixed_ip" : "10.0.0.3",
|
||||
"id" : 1,
|
||||
"instance_id" : 1,
|
||||
"ip" : "10.6.0.0"
|
||||
}}
|
||||
|
||||
Normal Response Code: 200
|
||||
|
||||
New States
|
||||
----------
|
||||
None
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
|
||||
List the specific changes to the API. For example:
|
||||
|
||||
In the List Addresses section of the Cloud Servers Specification: Examples 4.21 and 4.22 should be replaced with examples below.
|
||||
|
||||
Provide examples in XML and JSON
|
||||
94
doc/source/api_ext/ext_keypairs.rst
Normal file
94
doc/source/api_ext/ext_keypairs.rst
Normal file
@@ -0,0 +1,94 @@
|
||||
About The Keypairs Extension
|
||||
============================
|
||||
This extension enables you to create or import a keypair on a virtual instance. If you send the name of the instance to the API, you get a key and a private_key and fingerprint returned. You can also send a public_key to add an existing ssh key and also list the keypairs in use on instances.
|
||||
|
||||
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/extensions.
|
||||
|
||||
Keypairs Extension Overview
|
||||
---------------------------
|
||||
|
||||
Name
|
||||
Keypairs
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/ext/keypairs/api/v1.1
|
||||
|
||||
Alias
|
||||
OPS-KYP
|
||||
|
||||
Contact
|
||||
Jesse Andrews <anotherjesse@gmail.com>
|
||||
|
||||
Status
|
||||
Released
|
||||
|
||||
Extension Version
|
||||
v1.0 (2011-08-09)
|
||||
|
||||
Dependencies
|
||||
Compute API 1.1
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables keypair listing, creation, or import into an instance through a REST API.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
{"extensions": [{"updated": "2011-08-08T00:00:00+00:00", "name": "Keypairs", "links": [], "namespace": "http://docs.openstack.org/ext/keypairs/api/v1.1", "alias": "os-keypairs", "description": "Keypair Support"}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-16 Initial draft
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the Compute API allows keypair support so that you can create or import keypairs to secure your running instances. You can also list keypairs per user.
|
||||
|
||||
New Action
|
||||
----------
|
||||
When launching a new server, you can specify an already existing keypair with::
|
||||
|
||||
POST /v1.1/tenant_id/os_keypairs/keypair
|
||||
|
||||
To lists the keypairs on all running instances, use::
|
||||
|
||||
GET /v1.1/tenant_id/os_keypairs
|
||||
|
||||
New Faults
|
||||
----------
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
None
|
||||
|
||||
New States
|
||||
----------
|
||||
None
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
|
||||
This section lists the specific changes to the Compute API, namely adding a new section to the 4.3 Server Actions section.
|
||||
109
doc/source/api_ext/ext_multinic.rst
Normal file
109
doc/source/api_ext/ext_multinic.rst
Normal file
@@ -0,0 +1,109 @@
|
||||
About The Fixed IPs Extension
|
||||
=============================
|
||||
This extension enables addFixedIp and removeFixedIp actions on servers. It is used with the OpenStack Compute 1.1 API to add or remove fixed IP addresses on named instances.
|
||||
|
||||
To use this extension, you must have configured Compute with more than one Network Interface Card.
|
||||
|
||||
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.
|
||||
|
||||
Fixed IPs Extension Overview
|
||||
----------------------------
|
||||
|
||||
Name
|
||||
Multinic
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/ext/multinic/api/v1.1
|
||||
|
||||
Alias
|
||||
OPS-MLT
|
||||
|
||||
Contact
|
||||
Kevin Mitchell <kevin.mitchell@rackspace.com>
|
||||
|
||||
Status
|
||||
Alpha
|
||||
|
||||
Extension Version
|
||||
v1.0 (2011-09-14)
|
||||
|
||||
Dependencies
|
||||
Compute API 1.1
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables the assignment and removal of fixed IP addresses on virtual servers running in an OpenStack Compute cloud.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
<extensions xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
|
||||
<extension name="Multinic" namespace="http://docs.openstack.org/ext/multinic/api/v1.1" alias="NMN" updated="2011-06-09T00:00:00+00:00"><description>Multiple network support</description></extension>
|
||||
</extensions>
|
||||
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
{"extensions": [{"updated": "2011-06-09T00:00:00+00:00", "name": "Multinic", "links": [], "namespace": "http://docs.openstack.org/ext/multinic/api/v1.1", "alias": "NMN", "description": "Multiple network support"}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-14 Initial draft
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the Compute API allows addition and removal of fixed IP addresses to instances.
|
||||
|
||||
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
|
||||
|
||||
New Action
|
||||
----------
|
||||
This extension uses POST to add or remove fixed IP addresses to instances.
|
||||
|
||||
add_fixed_ip
|
||||
remove_fixed_ip
|
||||
|
||||
Normal Response Code: 202
|
||||
|
||||
Enter "None" if there are no changes to the sections below.
|
||||
|
||||
Include the response codes, transitions if applicable, and XML and JSON examples.
|
||||
|
||||
New Faults
|
||||
----------
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
None
|
||||
|
||||
New States
|
||||
----------
|
||||
None
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
|
||||
List the specific changes to the API. For example:
|
||||
|
||||
In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below.
|
||||
|
||||
Provide examples in XML and JSON
|
||||
95
doc/source/api_ext/ext_quotas.rst
Normal file
95
doc/source/api_ext/ext_quotas.rst
Normal file
@@ -0,0 +1,95 @@
|
||||
About The Quotas Extension
|
||||
==========================
|
||||
The quotas extension enables limiters placed on the resources used per tenant (project) for virtual instances. it is used with the OpenStack Compute API 1.1 for administrators who need to control the amount of volumes, memory, floating IP addresses, instances, or cores allowed within a defined tenant or project.
|
||||
|
||||
To use this extension, you need to have administrative rights to the tenants upon which you are placing quotas.
|
||||
.. Are there any pre-requisites prior to using it such as special hardware or configuration?
|
||||
|
||||
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/extensions.
|
||||
|
||||
Quotas Extension Overview
|
||||
-------------------------
|
||||
|
||||
Name
|
||||
Quotas
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/ext/quotas-sets/api/v1.1
|
||||
|
||||
Alias
|
||||
OPS-QUO
|
||||
|
||||
Contact
|
||||
Name <jake@markupisart.com>
|
||||
|
||||
Status
|
||||
Alpha
|
||||
|
||||
Extension Version
|
||||
v1.0 (2011-08-16)
|
||||
|
||||
Dependencies
|
||||
Compute API 1.1
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables quota management for OpenStack Compute servers so that resources for virtual instances are properly managed.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
{"extensions": [{"updated": "2011-08-08T00:00:00+00:00", "name": "Quotas", "links": [], "namespace": "http://docs.openstack.org/ext/quotas-sets/api/v1.1", "alias": "os-quota-sets", "description": "Quotas management support"}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-14 Initial draft
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the OpenStack Compute API allows administrators to control quotas for tenants (formerly known as projects).
|
||||
|
||||
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
|
||||
|
||||
New Action
|
||||
----------
|
||||
List the actions each in a section. Enter "None" if there are no changes.
|
||||
|
||||
Include the response codes, transitions if applicable, and XML and JSON examples.
|
||||
|
||||
New Faults
|
||||
----------
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
|
||||
New States
|
||||
----------
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
|
||||
List the specific changes to the API. For example:
|
||||
|
||||
In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below.
|
||||
|
||||
Provide examples in XML and JSON
|
||||
109
doc/source/api_ext/ext_rescue.rst
Normal file
109
doc/source/api_ext/ext_rescue.rst
Normal file
@@ -0,0 +1,109 @@
|
||||
About The Rescue Extension
|
||||
==========================
|
||||
The rescue extension lets you put a server into a "rescue" status when the virtual instance will be replaced with a "rescue" image and have its existing drive attached as a second disk so that a root user can log in and troubleshoot problems with the virtual server.
|
||||
|
||||
To put a server into "rescue" state, you do not have to be an administrator. The only requirement is that the base image used to build your instance must still be available.
|
||||
|
||||
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/extensions.
|
||||
|
||||
Rescue Extension Overview
|
||||
-------------------------
|
||||
|
||||
Name
|
||||
Rescue
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/ext/rescue/api/v1.1
|
||||
|
||||
Alias
|
||||
OPS-RES
|
||||
|
||||
Contact
|
||||
Josh Kearney <josh@jk0.org>
|
||||
|
||||
Status
|
||||
Alpha
|
||||
|
||||
Extension Version
|
||||
v1.0 (2011-08-18)
|
||||
|
||||
Dependencies
|
||||
Compute API 1.1
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables rescue capabilities for OpenStack Compute servers so that virtual instances running in the cloud may be put in a rescue status.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
N/A
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
{"extensions": [{"updated": "2011-08-18T00:00:00+00:00", "name": "Rescue", "links": [], "namespace": "http://docs.openstack.org/ext/rescue/api/v1.1", "alias": "os-rescue", "description": "Instance rescue mode"}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-16 Initial draft
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the OpenStack Compute API enables rescue of running instances.
|
||||
|
||||
To support these new actions, the extension also issues new states.
|
||||
|
||||
New Actions
|
||||
----------
|
||||
rescue
|
||||
unrescue
|
||||
|
||||
New Faults
|
||||
----------
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
None
|
||||
|
||||
New States
|
||||
----------
|
||||
RESCUING
|
||||
UNRESCUING
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
A new action added to the 4.3 Server Actions section.
|
||||
|
||||
Rescue Server
|
||||
+++++++++++++
|
||||
|
||||
============= ==================
|
||||
Verb URI
|
||||
POST /servers/id/rescue
|
||||
============= ==================
|
||||
|
||||
Normal Response Code(s): 202
|
||||
|
||||
Error Response Code(s): computeFault (400, 500, …), serviceUnavailable (503), unauthorized (401), forbidden (403), badRequest (400), badMethod (405), overLimit (413), itemNotFound (404), badMediaType (415), buildInProgress (409)
|
||||
|
||||
Status Transition: ACTIVE -> RESCUING -> ACTIVE
|
||||
|
||||
This operation places the server into RESCUING status.
|
||||
113
doc/source/api_ext/ext_security_group.rst
Normal file
113
doc/source/api_ext/ext_security_group.rst
Normal file
@@ -0,0 +1,113 @@
|
||||
About The Security Groups Extension
|
||||
===================================
|
||||
The Security Groups extension lets you view, create, and remove security groups for instances plus set rules for security groups using the OpenStack Compute API 1.1.
|
||||
|
||||
.. Are there any pre-requisites prior to using it such as special hardware or configuration?
|
||||
|
||||
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/extensions.
|
||||
|
||||
Security Groups Extension Overview
|
||||
----------------------------------
|
||||
|
||||
Name
|
||||
Security Groups
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/ext/securitygroups/api/v1.1
|
||||
|
||||
Alias
|
||||
OPS-SCG
|
||||
|
||||
Contact
|
||||
Tushar Patil <tushar.vitthal.patil@gmail.com>
|
||||
|
||||
Status
|
||||
Released
|
||||
|
||||
Extension Version
|
||||
v1.0 (2011-08-11)
|
||||
|
||||
Dependencies
|
||||
Compute API 1.1
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables creation and listing of security groups.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/xml
|
||||
Content-Length: 3295
|
||||
Date: Fri, 16 Sep 2011 21:06:55 GMT
|
||||
|
||||
<extensions xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
|
||||
<extension name="SecurityGroups" namespace="http://docs.openstack.org/ext/securitygroups/api/v1.1" alias="security_groups" updated="2011-07-21T00:00:00+00:00"><description>Security group support</description></extension>
|
||||
</extensions>
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
{"extensions": [{"updated": "2011-07-21T00:00:00+00:00", "name": "SecurityGroups", "links": [], "namespace": "http://docs.openstack.org/ext/securitygroups/api/v1.1", "alias": "security_groups", "description": "Security group support"}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-16 Initial draft
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the Compute API allows you to create, update, and delete security groups.
|
||||
|
||||
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
|
||||
|
||||
New Actions
|
||||
-----------
|
||||
os-security-group
|
||||
|
||||
os-security-group-rules
|
||||
|
||||
|
||||
Include the response codes, transitions if applicable, and XML and JSON examples.
|
||||
|
||||
New Faults
|
||||
----------
|
||||
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
|
||||
None
|
||||
|
||||
New States
|
||||
----------
|
||||
|
||||
None
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
|
||||
List the specific changes to the API. For example:
|
||||
|
||||
In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below.
|
||||
|
||||
Provide examples in XML and JSON
|
||||
102
doc/source/api_ext/ext_virtual_interfaces.rst
Normal file
102
doc/source/api_ext/ext_virtual_interfaces.rst
Normal file
@@ -0,0 +1,102 @@
|
||||
About The Virtual Interfaces Extension
|
||||
======================================
|
||||
The Virtual Interfaces extension lets you view the virtual interfaces used in an instance.
|
||||
|
||||
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/extensions.
|
||||
|
||||
Virtual Interfaces Extension Overview
|
||||
-------------------------------------
|
||||
|
||||
Name
|
||||
Virtual Interfaces
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/ext/virtual_interfaces/api/v1.1
|
||||
|
||||
Alias
|
||||
MID-VRT
|
||||
|
||||
Contact
|
||||
Name <ryu@midokura.jp>
|
||||
|
||||
Status
|
||||
Alpha
|
||||
|
||||
Extension Version
|
||||
v1.0 (2011-08-18)
|
||||
|
||||
Dependencies
|
||||
Compute API 1.1
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables Virtual Interfaces capabilities for OpenStack Compute servers so that you know the interfaces for the virtual instances running in the cloud.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
<extensions>
|
||||
<extension name="VirtualInterfaces"
|
||||
namespace="http://docs.openstack.org/ext/virtual_interfaces/api/v1.1"
|
||||
alias="virtual_interfaces" updated="2011-08-17T00:00:00+00:00">
|
||||
<description>Virtual interface support</description>
|
||||
</extension>
|
||||
</extensions>
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
{"extensions": [{"updated": "2011-08-17T00:00:00+00:00", "name": "VirtualInterfaces", "links": [], "namespace": "http://docs.openstack.org/ext/virtual_interfaces/api/v1.1", "alias": "virtual_interfaces", "description": "Virtual interface support"}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-16 Initial draft
|
||||
============= =====================================
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the OpenStack Compute API enables listing of Virtual Interfaces of running instances.
|
||||
|
||||
New Actions
|
||||
----------
|
||||
virtual_interfaces
|
||||
|
||||
New Faults
|
||||
----------
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
None
|
||||
|
||||
New States
|
||||
----------
|
||||
None
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
A new action added to the 4.3 Server Actions section.
|
||||
|
||||
============= ==================
|
||||
Verb URI
|
||||
POST /servers/id/virtual_interfaces
|
||||
============= ==================
|
||||
|
||||
Normal Response Code(s): 202
|
||||
|
||||
Error Response Code(s): computeFault (400, 500, …), serviceUnavailable (503), unauthorized (401), forbidden (403), badRequest (400), badMethod (405), overLimit (413), itemNotFound (404), badMediaType (415), buildInProgress (409)
|
||||
100
doc/source/api_ext/ext_volumes.rst
Normal file
100
doc/source/api_ext/ext_volumes.rst
Normal file
@@ -0,0 +1,100 @@
|
||||
About The Volumes Extension
|
||||
===========================
|
||||
This extension enables volume management on virtual servers. It is used with the OpenStack Compute 1.1 API to add or remove fixed IP addresses on named instances.
|
||||
|
||||
To use this extension, you must have configured Compute to manage volumes.
|
||||
|
||||
.. Are there any pre-requisites prior to using it such as special hardware or configuration?
|
||||
|
||||
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/extensions.
|
||||
|
||||
Volumes Extension Overview
|
||||
--------------------------
|
||||
|
||||
Name
|
||||
Volumes
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/ext/volumes/api/v1.1
|
||||
|
||||
Alias
|
||||
OPS-VOL
|
||||
|
||||
Contact
|
||||
Name <justin@fathomdb.com>
|
||||
|
||||
Status
|
||||
Alpha
|
||||
|
||||
Extension Version
|
||||
v1.0 (2011-09-14)
|
||||
|
||||
Dependencies
|
||||
Compute API 1.1
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables listing of volumes available to virtual servers running in an OpenStack cloud. You can create, attach, and detach a volume with this extension.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
{"extensions": [{"updated": "2011-03-25T00:00:00+00:00", "name": "Volumes", "links": [], "namespace": "http://docs.openstack.org/ext/volumes/api/v1.1", "alias": "os-volumes", "description": "Volumes support"}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-14 Initial draft
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the Compute API allows volume management through the OpenStack Compute API.
|
||||
|
||||
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
|
||||
|
||||
New Action
|
||||
----------
|
||||
This extension uses POST to attach or detach volumes to instances.
|
||||
|
||||
Normal Response Code: 202
|
||||
|
||||
Enter "None" if there are no changes to the sections below.
|
||||
|
||||
Include the response codes, transitions if applicable, and XML and JSON examples.
|
||||
|
||||
New Faults
|
||||
----------
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
|
||||
New States
|
||||
----------
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
|
||||
List the specific changes to the API. For example:
|
||||
|
||||
In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below.
|
||||
|
||||
Provide examples in XML and JSON
|
||||
54
doc/source/api_ext/index.rst
Normal file
54
doc/source/api_ext/index.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
..
|
||||
Copyright 2011 United States Government as represented by the
|
||||
Administrator of the National Aeronautics and Space Administration.
|
||||
All Rights Reserved.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
not use this file except in compliance with the License. You may obtain
|
||||
a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
Compute API Extensions
|
||||
======================
|
||||
|
||||
In this section you will find extension reference information. If you need to write an extension's reference page, you can find an RST template in doc/source/api_ext/rst_extension_template.rst.
|
||||
|
||||
The Compute API specification is published to http://docs.openstack.org/api and the source is found in https://github.com/openstack/compute-api. These extensions extend the core API.
|
||||
|
||||
Extensions
|
||||
----------
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
ext_config_drive.rst
|
||||
ext_floating_ips.rst
|
||||
ext_keypairs.rst
|
||||
ext_multinic.rst
|
||||
ext_quotas.rst
|
||||
ext_rescue.rst
|
||||
ext_security_group.rst
|
||||
ext_virtual_interfaces.rst
|
||||
ext_volumes.rst
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
../api/autoindex
|
||||
|
||||
|
||||
Indices and tables
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
98
doc/source/api_ext/rst_extension_template.rst
Normal file
98
doc/source/api_ext/rst_extension_template.rst
Normal file
@@ -0,0 +1,98 @@
|
||||
About This Extension
|
||||
====================
|
||||
Describe the extension.
|
||||
|
||||
Who will use it and what project's API it is for?
|
||||
|
||||
How can I find out more about it?
|
||||
|
||||
Are there any pre-requisites prior to using it such as special hardware or configuration?
|
||||
|
||||
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/extensions.
|
||||
|
||||
Extension Overview
|
||||
------------------
|
||||
|
||||
Name
|
||||
Name of Extension
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/<project>/api/ext/tla/v1.0
|
||||
|
||||
Alias
|
||||
ORG-EXT
|
||||
|
||||
Contact
|
||||
Name <email@mailingaddress.net>
|
||||
|
||||
Status
|
||||
Alpha, Beta, or Released
|
||||
|
||||
Extension Version
|
||||
v1.0 (year-mm-dd)
|
||||
|
||||
Dependencies
|
||||
Name and Version of API
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables ...
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
N/A
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
yyyy-mm-dd Describe the change, one line per rev
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
This extension to the <project> API allows ...
|
||||
|
||||
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
|
||||
|
||||
New Action
|
||||
----------
|
||||
List the actions each in a section. Enter "None" if there are no changes.
|
||||
|
||||
Include the response codes, transitions if applicable, and XML and JSON examples.
|
||||
|
||||
New Faults
|
||||
----------
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
|
||||
New States
|
||||
----------
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
|
||||
List the specific changes to the API. For example:
|
||||
|
||||
In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below.
|
||||
|
||||
Provide examples in XML and JSON
|
||||
@@ -64,6 +64,14 @@ Developer Docs
|
||||
devref/index
|
||||
community
|
||||
|
||||
API Extensions
|
||||
==============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
api_ext/index
|
||||
|
||||
Outstanding Documentation Tasks
|
||||
===============================
|
||||
|
||||
|
||||
Reference in New Issue
Block a user