openstack-attic/compute-api
Code Issues Proposed changes

Fix: Adding changes made by Diane back into the files

Browse Source 
Closes-Bug: 1295718
Author: Constanze Kratel <constanze.kratel@rackspace.com>
Change-Id: I6e0461eb5cca3a5eff47a2ccabd0d1bf7a9a442d
This commit is contained in:
Constanze Kratel 2014-06-23 14:17:50 -05:00
parent 657292543f
commit f004b3bc8f
2 changed files with 38 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
v2/bk_compute_api_ref_v2.xml
View File

@ -546,7 +546,7 @@
API operate using SSL over HTTP (HTTPS).</para> API operate using SSL over HTTP (HTTPS).</para>
</note> </note>
</section> </section>
<section xml:id="Request_Response_Types-d1e459"> <section xml:id="Request_Response_Types-d1e459">
<title>Request and response formats</title> <title>Request and response formats</title>
<para>The OpenStack Compute API supports both JSON and XML <para>The OpenStack Compute API supports both JSON and XML
data serialization request and response data serialization request and response
@ -1561,7 +1561,7 @@ Host: servers.api.openstack.org/v2/</literallayout>
suspended, either by request or necessity. suspended, either by request or necessity.
This status appears for only the following This status appears for only the following
hypervisors: XenServer/XCP, KVM, and ESXi. hypervisors: XenServer/XCP, KVM, and ESXi.
Administrative usersmay suspend an Administrative users may suspend an
instance if it is infrequently used or to instance if it is infrequently used or to
perform system maintenance. When you perform system maintenance. When you
suspend an instance, its VM state is suspend an instance, its VM state is

85
v2/section_concepts.xml
View File

@ -48,63 +48,50 @@
particular server configuration frequently.</para> particular server configuration frequently.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold">Reboot <para><emphasis role="bold">Reboot</emphasis></para>
action</emphasis></para> <para>Use this function to perform either a soft or hard
<para>Performs a soft or hard reboot of a server. With a reboot of a server. With a soft reboot, the operating
soft reboot, the operating system is signaled to system is signaled to restart, which allows for a
restart, which allows for a graceful shutdown of all graceful shutdown of all processes. A hard reboot is
processes. A hard reboot is the equivalent of power the equivalent of power cycling the server. The
cycling the server. The virtualization platform should virtualization platform should ensure that the reboot
ensure that the reboot action has completed action has completed successfully even in cases in
successfully even in cases in which the underlying which the underlying domain/VM is paused or
domain/VM is paused or halted/stopped.</para> halted/stopped.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold">Rebuild <para><emphasis role="bold">Rebuild</emphasis></para>
action</emphasis></para> <para>Use this function to remove all data on the server and
<para>Removes all data on the server and replaces it with replaces it with the specified image. Server ID and IP
the specified image. Server ID and IP addresses remain addresses remain the same.</para>
the same.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold">Resize <para><emphasis role="bold">Resize</emphasis></para>
action</emphasis></para> <para>Use this function to convert an existing server to a
<para>Converts an existing server to a different flavor, different flavor, in essence, scaling the server up or
in essence, scaling the server up or down. The down. The original server is saved for a period of
original server is saved for a period of time to allow time to allow rollback if there is a problem. All
rollback if there is a problem. All resizes should be resizes should be tested and explicitly confirmed, at
tested and explicitly confirmed, at which time the which time the original server is removed. All resizes
original server is removed. All resizes are are automatically confirmed after 24 hours if you do
automatically confirmed after 24 hours if you do not not confirm or revert them.</para>
confirm or revert them.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold">Pause action</emphasis></para> <para><emphasis role="bold">Pause</emphasis></para>
<para>Pauses a server and causes it to run in a frozen <para>You can pause a server by making a pause request. This
state. To pause a server, make a <link request stores the state of the VM in RAM. A paused
xlink:href="http://docs.openstack.org/api/openstack-compute/2/content/POST_os-admin-actions-v2_pause__v2__tenant_id__servers__server_id__action_ext-action.html" instance continues to run in a frozen state.</para>
>Pause server</link> request. This request stores
the state of the VM in RAM.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold">Suspend <para><emphasis role="bold">Suspend</emphasis></para>
action</emphasis></para> <para>Administrative users might want to suspend an
<para>Suspends a server, which stores its VM state on instance if it is infrequently used or to perform
disk, writes all memory to disk, and stops the virtual system maintenance. When you suspend an instance, its
machine. Suspending an instance is similar to placing VM state is stored on disk, all memory is written to
a device in hibernation; memory and vCPUs become disk, and the virtual machine is stopped. Suspending
available to create other instances. Administrative an instance is similar to placing a device in
users might want to suspend an infrequently used hibernation; memory and vCPUs become available to
instance or suspend an instance to perform system create other instances.</para>
maintenance.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Unpause
action</emphasis></para>
<para>Unpauses a paused server. To unpause a server, make
an <link
xlink:href="http://docs.openstack.org/api/openstack-compute/2/content/POST_os-admin-actions-v2_unpause__v2__tenant_id__servers__server_id__action_ext-action.html"
>Unpause server</link> request.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>