← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nova/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/source/api_ext/ext_rescue.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_rescue.rst
1
 
The Rescue Extension
2
 
=================================================================
3
 
About this Extension
4
 
--------------------
5
 
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.
6
 
 
7
 
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.
8
 
 
9
 
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.
10
 
 
11
 
Extension Overview
12
 
~~~~~~~~~~~~~~~~~~
13
 
 
14
 
Name
15
 
        Rescue
16
 
        
17
 
Namespace
18
 
        http://docs.openstack.org/ext/rescue/api/v1.1
19
 
 
20
 
Alias
21
 
        OPS-RES
22
 
        
23
 
Contact
24
 
        Josh Kearney <josh@jk0.org>
25
 
        
26
 
Status
27
 
        Alpha
28
 
        
29
 
Extension Version
30
 
        v1.0 (2011-08-18)
31
 
 
32
 
Dependencies
33
 
        Compute API 1.1
34
 
        
35
 
Doc Link (PDF)
36
 
        http://
37
 
        
38
 
Doc Link (WADL)
39
 
        http://
40
 
        
41
 
Short Description
42
 
        This extension enables rescue capabilities for OpenStack Compute servers so that virtual instances running in the cloud may be put in a rescue status.
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
 
N/A
51
 
 
52
 
Extension Query Response: JSON::
53
 
 
54
 
{"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"}]}
55
 
 
56
 
 
57
 
Document Change History
58
 
~~~~~~~~~~~~~~~~~~~~~~~
59
 
 
60
 
============= =====================================
61
 
Revision Date Summary of Changes
62
 
2011-09-16    Initial draft
63
 
2012-03-30    Reformat of content
64
 
============= =====================================
65
 
 
66
 
 
67
 
Summary of Changes
68
 
------------------
69
 
This extension to the OpenStack Compute API enables rescue of running instances.
70
 
 
71
 
This support is provided by the addition of new actions and states.
72
 
 
73
 
New Actions
74
 
~~~~~~~~~~~
75
 
rescue
76
 
unrescue
77
 
 
78
 
New Faults
79
 
~~~~~~~~~~
80
 
 
81
 
New Headers
82
 
~~~~~~~~~~~
83
 
 
84
 
New Resources
85
 
~~~~~~~~~~~~~
86
 
 
87
 
New States
88
 
~~~~~~~~~~
89
 
RESCUING
90
 
UNRESCUING
91
 
 
92
 
Changes to the Cloud Servers Specification
93
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94
 
 
95
 
A new action added to the 4.3 Server Actions section. 
96
 
 
97
 
Rescue Server
98
 
+++++++++++++
99
 
 
100
 
============= ==================
101
 
Verb          URI
102
 
POST          /servers/id/rescue
103
 
============= ==================
104
 
 
105
 
Normal Response Code(s): 202
106
 
 
107
 
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) 
108
 
 
109
 
Status Transition:      ACTIVE -> RESCUING -> ACTIVE
110
 
 
111
 
This operation places the server into RESCUING status.