bug 965335
Resolves unclear formatting of compute extensions documentation at http://nova.openstack.org/api_ext/index.html The rst extensions template has been updated to include extension name as top level hierarchy, and demote all other content. All existing documentation pages have been reformatted as per the updated template. The ext_aggreagates.rst file has also been added to index.rst. Amendments: - Author added to Authors file - Typo in ext_volumes.rst fixed Change-Id: Id67ef91a6e8eaaf4fba46abbd57759c77aaf8991
This commit is contained in:
John Kennedy
parent
75676812e8
commit
a68156c100
1
Authors
1
Authors
@ -90,6 +90,7 @@ Johannes Erdfelt <johannes.erdfelt@rackspace.com>
|
||||
John Dewey <john@dewey.ws>
|
||||
John Garbutt <john.garbutt@citrix.com>
|
||||
John Griffith <john.griffith@solidfire.com>
|
||||
John Kennedy <john.m.kennedy@intel.com>
|
||||
John Tran <jtran@attinteractive.com>
|
||||
Jonathan Bryce <jbryce@jbryce.com>
|
||||
Jordan Rinke <jordan@openstack.org>
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
About This Extension
|
||||
====================
|
||||
|
||||
The Host Aggregates Extension
|
||||
=================================================================
|
||||
About this Extension
|
||||
--------------------
|
||||
This extension introduces the concept of aggregates into Nova. Host aggregates are different from zones and availability zones: while the former allows the partition of Nova deployments into logical groups for load balancing and instance distribution, the latter are for providing some form of physical isolation and redundancy from other availability zones (e.g. by using separate power supply and network gears). Availability zones do not necessarily mean geographic distribution whereas zones usually do. Host aggregates can be regarded as a mechanism to further partitioning an availability zone, i.e. into multiple groups of hosts that share common resources like storage and network. This enables a finer level of granularity in which to structure an entire OpenStack deployment. Aggregates allows higher availability of a single guest instance within an availability zone, it enables advanced VM placement strategies, and more importantly it enables hosts' zero-downtime upgrades (for example, via VM live migration across members of the aggregate, thus causing no disruption to guest instances).
|
||||
|
||||
You can use this extension when you have multiple Compute nodes installed (only XenServer/XCP via xenapi driver is currently supported), and you want to leverage the capabilities of the underlying hypervisor resource pools. For example, you want to enable VM live migration (i.e. VM migration within the pool) or enable host maintenance with zero-downtime for guest instances. Please, note that VM migration across pools (i.e. storage migration) is not yet supported in XenServer/XCP, but will be added when available. Bear in mind that the two migration techniques are not mutually exclusive and can be used in combination for a higher level of flexibility in your cloud management.
|
||||
@ -12,7 +13,7 @@ Pre-requisites depend on the kind of hypervisor support you are going to use. As
|
||||
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://example.com/v1.1/tenant/extensions.
|
||||
|
||||
Extension Overview
|
||||
------------------
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Host Aggregates
|
||||
@ -45,7 +46,7 @@ Short Description
|
||||
This extension enables the use of hypervisor resource pools in Nova.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
@ -57,23 +58,24 @@ Extension Query Response: JSON::
|
||||
|
||||
{"extension": {"updated": "2012-01-12T00:00:00+00:00", "name": "Aggregates", "links": [], "namespace": "http://docs.openstack.org/compute/ext/aggregates/api/v1.1", "alias": "os-aggregates", "description": "Admin-only aggregate administration"}}
|
||||
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2012-02-28 Initial draft
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
------------------
|
||||
This extension to the OpenStack Compute API allows the creation and management of host aggregates (i.e. pools of compute nodes).
|
||||
|
||||
New Action
|
||||
----------
|
||||
This support is provided by the addition of new actions.
|
||||
|
||||
New Actions
|
||||
~~~~~~~~~~~
|
||||
When a new aggregate has been created, actions can be executed using:
|
||||
|
||||
POST /v1.1/<tenant-id>/os-aggregates/<aggregate-id>/action
|
||||
@ -101,22 +103,21 @@ For example, to remove a host from an aggregate, the following xml must be submi
|
||||
Error Response Code(s) conflict (409), badRequest (400), itemNotFound (404)
|
||||
|
||||
New Faults
|
||||
----------
|
||||
~~~~~~~~~~
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
~~~~~~~~~~~
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
~~~~~~~~~~~~~
|
||||
None
|
||||
|
||||
New States
|
||||
----------
|
||||
~~~~~~~~~~
|
||||
None
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
None
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
About This Extension
|
||||
====================
|
||||
The Config Drive Extension
|
||||
=================================================================
|
||||
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.
|
||||
@ -7,7 +9,7 @@ To use this extension, you must have installed Compute, with libvirt or Xen usin
|
||||
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://example.com/v1.1/tenant/extensions.
|
||||
|
||||
Extension Overview
|
||||
------------------
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Config Drive
|
||||
@ -41,7 +43,7 @@ Short Description
|
||||
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.
|
||||
|
||||
@ -57,35 +59,36 @@ Extension Query Response: JSON::
|
||||
|
||||
.. todo:: Provide example of extension query JSON response.
|
||||
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-16 Initial draft
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
------------------
|
||||
This extension to the OpenStack Compute API allows the addition of a configuration drive to an instance.
|
||||
|
||||
New Action
|
||||
----------
|
||||
This support is provided by the addition of new resources.
|
||||
|
||||
New Actions
|
||||
~~~~~~~~~~~
|
||||
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.
|
||||
@ -94,10 +97,11 @@ Upon instance create, a guest built with a True config_drive attribute will crea
|
||||
Upon instance create, a guest built with an imageRef config_drive attribute will create a local volume from the image.
|
||||
|
||||
New States
|
||||
----------
|
||||
~~~~~~~~~~
|
||||
None
|
||||
|
||||
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:
|
||||
|
||||
|
||||
@ -1,13 +1,14 @@
|
||||
About The Floating IP DNS Extension
|
||||
===================================
|
||||
|
||||
The Floating IP DNS Extension
|
||||
=================================================================
|
||||
About this Extension
|
||||
--------------------
|
||||
The Floating IP DNS extension provides an interface for managing DNS records associated with IP addresses
|
||||
allocated by the Floating Ips extension. Requests are dispatched to a DNS driver selected at startup.
|
||||
|
||||
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://example.com/v1.1/tenant/extension.
|
||||
|
||||
Floating IPs Extension Overview
|
||||
-------------------------------
|
||||
Extension Overview
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Floating IP DNS
|
||||
@ -41,7 +42,7 @@ Short Description
|
||||
This extension enables associated DNS entries with floating IPs.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
|
||||
|
||||
@ -60,33 +61,35 @@ Extension Query Response: JSON::
|
||||
'description': 'Floating IP DNS support'}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-12-23 Initial draft
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
------------------
|
||||
This extension to the Compute API enables management of DNS entries for floating IP addresses.
|
||||
|
||||
New Action
|
||||
----------
|
||||
This support is provided by the addition of new resources.
|
||||
|
||||
New Actions
|
||||
~~~~~~~~~~~
|
||||
None
|
||||
|
||||
New Faults
|
||||
----------
|
||||
~~~~~~~~~~
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
~~~~~~~~~~~
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
|
||||
~~~~~~~~~~~~~
|
||||
Get a list of registered DNS Domains published by the DNS drivers::
|
||||
|
||||
GET /v1.1/<tenant_id>/os-floating-ip-dns/
|
||||
@ -191,11 +194,10 @@ Delete a DNS entry::
|
||||
Normal Response Code: 200
|
||||
Failure Response Code: 404 (Entry to be deleted not found)
|
||||
|
||||
|
||||
New States
|
||||
----------
|
||||
~~~~~~~~~~
|
||||
None
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
None
|
||||
|
||||
@ -1,11 +1,13 @@
|
||||
About The Floating IPs Extension
|
||||
================================
|
||||
The Floating IPs Extension
|
||||
=================================================================
|
||||
About this 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://example.com/v1.1/tenant/extension.
|
||||
|
||||
Floating IPs Extension Overview
|
||||
-------------------------------
|
||||
Extension Overview
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Floating IPs
|
||||
@ -38,7 +40,7 @@ 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.
|
||||
|
||||
@ -57,22 +59,23 @@ Extension Query Response: JSON::
|
||||
"description": "Floating IPs support"}]}
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
2011-09-14 Initial draft
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
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.)
|
||||
This support is provided by the addition of new actions and resources.
|
||||
|
||||
New Action
|
||||
----------
|
||||
New Actions
|
||||
~~~~~~~~~~~
|
||||
This extension uses POST to add or remove floating IP addresses to instances.
|
||||
|
||||
Normal Response Code: 202
|
||||
@ -84,15 +87,15 @@ 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::
|
||||
@ -149,11 +152,11 @@ Show a floating ip::
|
||||
Normal Response Code: 200
|
||||
|
||||
New States
|
||||
----------
|
||||
~~~~~~~~~~
|
||||
None
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
List the specific changes to the API. For example:
|
||||
|
||||
|
||||
@ -1,11 +1,13 @@
|
||||
About The Keypairs Extension
|
||||
============================
|
||||
The Keypairs Extension
|
||||
=================================================================
|
||||
About this 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://example.com/v1.1/tenant/extensions.
|
||||
|
||||
Keypairs Extension Overview
|
||||
---------------------------
|
||||
Extension Overview
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Keypairs
|
||||
@ -38,7 +40,7 @@ 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.
|
||||
|
||||
@ -52,21 +54,25 @@ 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
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
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
|
||||
----------
|
||||
This support is provided by the addition of new actions.
|
||||
|
||||
New Actions
|
||||
~~~~~~~~~~~
|
||||
When launching a new server, you can specify an already existing keypair with::
|
||||
|
||||
POST /v1.1/tenant_id/os_keypairs/keypair
|
||||
@ -76,22 +82,22 @@ 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.
|
||||
|
||||
@ -1,13 +1,15 @@
|
||||
About The Fixed IPs Extension
|
||||
=============================
|
||||
The Multinic Extension
|
||||
=================================================================
|
||||
About this 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://example.com/v1.1/tenant/extension.
|
||||
|
||||
Fixed IPs Extension Overview
|
||||
----------------------------
|
||||
Extension Overview
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Multinic
|
||||
@ -40,7 +42,7 @@ 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.
|
||||
|
||||
@ -55,23 +57,25 @@ 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
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
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.)
|
||||
This support is provided by the addition of new <actions, faults, headers, resources, states, something else>.
|
||||
|
||||
New Action
|
||||
----------
|
||||
New Actions
|
||||
~~~~~~~~~~~
|
||||
This extension uses POST to add or remove fixed IP addresses to instances.
|
||||
|
||||
add_fixed_ip
|
||||
@ -79,28 +83,26 @@ 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:
|
||||
|
||||
|
||||
@ -1,15 +1,16 @@
|
||||
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.
|
||||
The Quotas Extension
|
||||
=================================================================
|
||||
About this 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://example.com/v1.1/tenant/extensions.
|
||||
|
||||
Quotas Extension Overview
|
||||
-------------------------
|
||||
|
||||
Extension Overview
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Name
|
||||
Quotas
|
||||
|
||||
@ -38,10 +39,10 @@ Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables quota management for OpenStack Compute servers so that resources for virtual instances are properly managed.
|
||||
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.
|
||||
|
||||
@ -56,43 +57,44 @@ 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
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
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.)
|
||||
This support is provided by the addition of new <actions, faults, headers, resources, states, something else>.
|
||||
|
||||
New Action
|
||||
----------
|
||||
List the actions each in a section. Enter "None" if there are no changes.
|
||||
New Actions
|
||||
~~~~~~~~~~~
|
||||
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:
|
||||
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.
|
||||
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
|
||||
|
||||
@ -1,14 +1,15 @@
|
||||
About The Rescue Extension
|
||||
==========================
|
||||
|
||||
The Rescue Extension
|
||||
=================================================================
|
||||
About this 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://example.com/v1.1/tenant/extensions.
|
||||
|
||||
Rescue Extension Overview
|
||||
-------------------------
|
||||
Extension Overview
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Rescue
|
||||
@ -38,10 +39,10 @@ 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.
|
||||
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.
|
||||
|
||||
@ -52,45 +53,45 @@ 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
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
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.
|
||||
This support is provided by the addition of new actions and 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
|
||||
|
||||
@ -1,13 +1,15 @@
|
||||
About The Security Groups Extension
|
||||
===================================
|
||||
The Security Groups Extension
|
||||
=================================================================
|
||||
About this 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://example.com/v1.1/tenant/extensions.
|
||||
|
||||
Security Groups Extension Overview
|
||||
----------------------------------
|
||||
Extension Overview
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Security Groups
|
||||
@ -40,7 +42,7 @@ 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.
|
||||
|
||||
@ -59,55 +61,52 @@ 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
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
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.)
|
||||
This support is provided by the addition of new actions.
|
||||
|
||||
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:
|
||||
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.
|
||||
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
|
||||
|
||||
@ -1,11 +1,13 @@
|
||||
About The Virtual Interfaces Extension
|
||||
======================================
|
||||
The Virtual Interfaces Extension
|
||||
=================================================================
|
||||
About this 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://example.com/v1.1/tenant/extensions.
|
||||
|
||||
Virtual Interfaces Extension Overview
|
||||
-------------------------------------
|
||||
Extension Overview
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Virtual Interfaces
|
||||
@ -38,7 +40,7 @@ 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.
|
||||
|
||||
@ -56,40 +58,46 @@ 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
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
Summary of Changes
|
||||
==================
|
||||
------------------
|
||||
This extension to the OpenStack Compute API enables listing of Virtual Interfaces of running instances.
|
||||
|
||||
This support is provided by the addition of new actions.
|
||||
|
||||
New Actions
|
||||
-----------
|
||||
~~~~~~~~~~~
|
||||
virtual_interfaces
|
||||
|
||||
New Faults
|
||||
----------
|
||||
~~~~~~~~~~
|
||||
None
|
||||
|
||||
New Headers
|
||||
-----------
|
||||
~~~~~~~~~~~
|
||||
None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
~~~~~~~~~~~~~
|
||||
None
|
||||
|
||||
New States
|
||||
----------
|
||||
None
|
||||
~~~~~~~~~~
|
||||
None
|
||||
|
||||
Changes to the Cloud Servers Specification
|
||||
------------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
A new action added to the 4.3 Server Actions section.
|
||||
|
||||
============= ==================
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
About The Volumes Extension
|
||||
===========================
|
||||
The Volumes Extension
|
||||
=================================================================
|
||||
About this 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.
|
||||
@ -8,8 +10,8 @@ To use this extension, you must have configured Compute to manage volumes.
|
||||
|
||||
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://example.com/v1.1/tenant/extensions.
|
||||
|
||||
Volumes Extension Overview
|
||||
--------------------------
|
||||
Extension Overview
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Volumes
|
||||
@ -41,8 +43,9 @@ Doc Link (WADL)
|
||||
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.
|
||||
|
||||
@ -56,23 +59,25 @@ 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
|
||||
2012-03-30 Reformat of content
|
||||
============= =====================================
|
||||
|
||||
|
||||
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.)
|
||||
This support is provided by the addition of new actions.
|
||||
|
||||
New Action
|
||||
----------
|
||||
New Actions
|
||||
~~~~~~~~~~~
|
||||
This extension uses POST to attach or detach volumes to instances.
|
||||
|
||||
Normal Response Code: 202
|
||||
@ -82,22 +87,26 @@ 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:
|
||||
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.
|
||||
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
|
||||
|
||||
@ -27,6 +27,7 @@ Extensions
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
ext_aggregates.rst
|
||||
ext_config_drive.rst
|
||||
ext_floating_ip_dns.rst
|
||||
ext_floating_ips.rst
|
||||
|
||||
@ -1,63 +1,66 @@
|
||||
About This Extension
|
||||
====================
|
||||
The <Name of Extension> Extension
|
||||
=================================================================
|
||||
|
||||
About this Extension
|
||||
--------------------
|
||||
Describe the extension.
|
||||
|
||||
Who will use it and what project's API it is for?
|
||||
Who will use it and what project's API is it for?
|
||||
|
||||
How can I find out more about it?
|
||||
|
||||
Are there any pre-requisites prior to using it such as special hardware or configuration?
|
||||
Are there pre-requisites prior to using it such as special hardware or configuration?
|
||||
|
||||
To obtain current information on 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/etensions.
|
||||
|
||||
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://example.com/v1.1/tenant/extensions.
|
||||
|
||||
Extension Overview
|
||||
------------------
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Name
|
||||
Name of Extension
|
||||
Name of Extensions
|
||||
|
||||
Namespace
|
||||
http://docs.openstack.org/<project>/api/ext/tla/v1.0
|
||||
http://docs.openstack.org/<project>/api/ext/tla/v1.0
|
||||
|
||||
Alias
|
||||
ORG-EXT
|
||||
ORG-EXT
|
||||
|
||||
Contact
|
||||
Name <email@mailingaddress.net>
|
||||
Name <email@mailingaddress.net>
|
||||
|
||||
Status
|
||||
Alpha, Beta, or Released
|
||||
Alpha, Beta, or Released
|
||||
|
||||
Extension Version
|
||||
v1.0 (year-mm-dd)
|
||||
v1.0 (year-mm-dd)
|
||||
|
||||
Dependencies
|
||||
Name and Version of API
|
||||
Name and version of API
|
||||
|
||||
Doc Link (PDF)
|
||||
http://
|
||||
http://
|
||||
|
||||
Doc Link (WADL)
|
||||
http://
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables ...
|
||||
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::
|
||||
|
||||
N/A
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
============= =====================================
|
||||
Revision Date Summary of Changes
|
||||
@ -66,34 +69,37 @@ 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.)
|
||||
This support is provided by the addition of new <actions, faults, headers, resources, states, something else>.
|
||||
|
||||
New Action
|
||||
----------
|
||||
List the actions each in a section. Enter "None" if there are no changes.
|
||||
New Actions
|
||||
~~~~~~~~~~~
|
||||
List each action 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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user