~0x44/nova/extdoc

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.

 

To use this extension, you do not have to be an administrator. You must have configured a rescue image for use on your cloud.

.. 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

        Rescue

        

Namespace

        http://docs.openstack.org/ext/rescue/api/v1.1

 

Alias

        OPS-RES

        

Contact

        Name <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::

 

 

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-14    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 (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