openstack/openstack-manuals
Code Issues Proposed changes

Adds reboot into rescue mode

Browse Source 
There were no usage instructions on how to reboot an instance into
the rescue mode. So, it was decided to add the description of
$ nova rescue SERVER and $ nova unrescue SERVER
commands to the user guide (Reboot an instance section).

As it is much related to the bug
https://bugs.launchpad.net/openstack-manuals/+bug/1346793
it also adds a note, informing the user about the restricted
number of available actions for the instance in running
in the rescue mode.

Besides, it adds --rescue_image_ref

Change-Id: I8818d4d7430c26619cd7bfc364c0f3d19f174152
Partial-Bug: 1346793
Closes-Bug: 1306174
This commit is contained in:
OlgaGusarenko 2015-01-27 13:44:01 +02:00
parent d372bb8744
commit 2c288fbe52
1 changed files with 39 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/user-guide/section_cli_nova_reboot.xml
View File

@ -5,10 +5,46 @@
version="5.0" version="5.0"
xml:id="reboot"> xml:id="reboot">
<title>Reboot an instance</title> <title>Reboot an instance</title>
<para>You can soft or hard reboot a running instance. A soft reboot <para>You can soft or hard reboot a running instance. A soft reboot
attempts a graceful shut down and restart of the instance. A attempts a graceful shut down and restart of the instance. A
hard reboot power cycles the instance.</para> hard reboot power cycles the instance.</para>
<procedure> <step><para>By default, when you reboot a server, it is a soft reboot.</para>
<procedure> <step><para>By default, when you reboot an instance, it is a soft reboot.</para>
<screen><prompt>$</prompt> <userinput>nova reboot <replaceable>SERVER</replaceable></userinput></screen></step></procedure> <screen><prompt>$</prompt> <userinput>nova reboot <replaceable>SERVER</replaceable></userinput></screen></step></procedure>
<para>To perform a hard reboot, pass the <parameter>--hard</parameter>
parameter, as follows:</para><screen><prompt>$</prompt> <userinput>nova reboot --hard <replaceable>SERVER</replaceable></userinput></screen></section> <procedure> <step><para>To perform a hard reboot, pass the <parameter>--hard</parameter> parameter, as follows:</para>
<screen><prompt>$</prompt> <userinput>nova reboot --hard <replaceable>SERVER</replaceable></userinput></screen></step></procedure>
<para>It is also possible to reboot a running instance into
rescue mode. This operation may be required, if a filesystem
of an instance becomes corrupted with a prolonged usage,
for example.</para>
<note>
<para>Pause, suspend, and stop operations are not allowed
when an instance is running in rescue mode, as triggering
these actions causes the loss of the original instance
state and makes it impossible to unrescue the instance.</para>
</note>
<para>Rescue mode provides a mechanism for access, even
if an image renders the instance inaccessible. By default,
it starts an instance from the initial image attaching
the current boot disk as a secondary one.</para>
<procedure> <step><para>To perform an instance reboot into rescue
mode, run the following command:</para>
<screen><prompt>$</prompt> <userinput>nova rescue <replaceable>SERVER</replaceable></userinput></screen></step></procedure>
<procedure> <step><para>To restart the instance from the normal
boot disk, run the following command:</para>
<screen><prompt>$</prompt> <userinput>nova unrescue <replaceable>SERVER</replaceable></userinput></screen></step></procedure>
<procedure> <step><para>If you want to rescue an instance with a specific
image, rather than the default one, use the
<parameter>--rescue_image_ref</parameter> parameter, as follows:</para>
<screen><prompt>$</prompt> <userinput>nova rescue --rescue_image_ref <replaceable>IMAGE_ID</replaceable><replaceable> SERVER</replaceable></userinput></screen></step></procedure>
</section>