← Back to branch summary

~0x44/nova/extdoc

« back to all changes in this revision

Viewing changes to nova/api/openstack/contrib/doc/ext_rescue.rst

  • Committer: Anne Gentle
  • Date: 2011-09-16 21:09:21 UTC
  • mfrom: (1576.1.1 extdoc)
  • Revision ID: anne@openstack.org-20110916210921-onp1008ipre301yu
Adds security groups extensions doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
nova/api/openstack/contrib/doc/ext_rescue.rst
2
2
====================
3
3
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.
4
4
 
5
 
To put a server into "rescue" state, you do not have to be an administrator. You must have configured a rescue image for use on your cloud.
6
 
.. Are there any pre-requisites prior to using it such as special hardware or configuration?
 
5
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.
7
6
 
8
7
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.
9
8
 
20
19
        OPS-RES
21
20
        
22
21
Contact
23
 
        Name <josh@jk0.org>
 
22
        Josh Kearney <josh@jk0.org>
24
23
        
25
24
Status
26
25
        Alpha
46
45
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension. 
47
46
 
48
47
Extension Query Response: XML::
49
 
 
 
48
N/A
50
49
 
51
50
Extension Query Response: JSON::
52
51
 
57
56
 
58
57
============= =====================================
59
58
Revision Date Summary of Changes
60
 
2011-09-14    Initial draft
 
59
2011-09-16    Initial draft
61
60
============= =====================================
62
61
 
63
62
 
65
64
==================
66
65
This extension to the OpenStack Compute API enables rescue of running instances.
67
66
 
68
 
To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)
 
67
To support these new actions, the extension also issues new states.
69
68
 
70
 
New Action
 
69
New Actions
71
70
----------
72
 
List the actions each in a section. Enter "None" if there are no changes. 
73
 
 
74
 
Include the response codes, transitions if applicable, and XML and JSON examples.
 
71
rescue
 
72
unrescue
75
73
 
76
74
New Faults
77
75
----------
 
76
None
78
77
 
79
78
New Headers
80
79
-----------
 
80
None
81
81
 
82
82
New Resources
83
83
-------------
 
84
None
84
85
 
85
86
New States
86
87
----------
 
88
RESCUING
 
89
UNRESCUING
87
90
 
88
91
Changes to the Cloud Servers Specification
89
92
------------------------------------------
90
 
 
91
 
List the specific changes to the API. For example: 
92
 
 
93
 
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. 
94
 
 
95
 
Provide examples in XML and JSON
 
 
b'\\ No newline at end of file'
 
93
A new action added to the 4.3 Server Actions section. 
 
94
 
 
95
Rescue Server
 
96
+++++++++++++
 
97
 
 
98
============= ==================
 
99
Verb          URI
 
100
POST          /servers/id/rescue
 
101
============= ==================
 
102
 
 
103
Normal Response Code(s): 202
 
104
 
 
105
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) 
 
106
 
 
107
Status Transition:      ACTIVE -> RESCUING -> ACTIVE
 
108
 
 
109
This operation places the server into RESCUING status. 
 
 
b'\\ No newline at end of file'